View a markdown version of this page

Sektion Globales der AWS SAM Vorlage - AWS Serverless Application Model

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Sektion Globales der AWS SAM Vorlage

Manchmal Ressourcen, die Sie in einer deklarieren AWS SAM Vorlagen haben gemeinsame Konfigurationen. Beispielsweise haben Sie möglicherweise eine Anwendung mit mehreren AWS::Serverless::Function Ressourcen, die identisch sind Runtime, Memory, VPCConfig, Environment, und Cors Konfigurationen. Anstatt diese Informationen in jeder Ressource zu duplizieren, können Sie sie einmal in der Globals Abschnitt und lass deine Ressourcen sie erben.

Das Globals Abschnitt unterstützt Folgendes AWS SAM Ressourcentypen:

  • AWS::Serverless::Api

  • AWS::Serverless::CapacityProvider

  • AWS::Serverless::Function

  • AWS::Serverless::HttpApi

  • AWS::Serverless::SimpleTable

  • AWS::Serverless::StateMachine

  • AWS::Serverless::MicrovmImage

  • AWS::Serverless::NetworkConnector

  • AWS::Serverless::WebFunction

Beispiel:

Globals: Function: Runtime: nodejs12.x Timeout: 180 Handler: index.handler Environment: Variables: TABLE_NAME: data-table Resources: HelloWorldFunction: Type: AWS::Serverless::Function Properties: Environment: Variables: MESSAGE: "Hello From SAM" ThumbnailFunction: Type: AWS::Serverless::Function Properties: Events: Thumbnail: Type: Api Properties: Path: /thumbnail Method: POST

In diesem Beispiel sind beide HelloWorldFunction und ThumbnailFunction benutze „nodejs12.x“ für Runtime, „180" Sekunden für Timeout, und „index.handler“ für Handler. HelloWorldFunction fügt die MESSAGE-Umgebungsvariable zusätzlich zum geerbten TABLE_NAME hinzu. ThumbnailFunction erbt alle Globals Eigenschaften und fügt eine API-Ereignisquelle hinzu.

Unterstützte Ressourcen und Eigenschaften

AWS SAM unterstützt die folgenden Ressourcen und Eigenschaften.

Globals: Api: AccessLogSetting: Auth: BinaryMediaTypes: CacheClusterEnabled: CacheClusterSize: CanarySetting: Cors: DefinitionUri: Domain: EndpointConfiguration: EndpointAccessMode: GatewayResponses: MethodSettings: MinimumCompressionSize: Name: OpenApiVersion: PropagateTags: SecurityPolicy: TracingEnabled: Variables: CapacityProvider: InstanceRequirements: KmsKeyArn: LoggingConfig: ManagedResourceTags: OperatorRole: PropagateTags: ScalingConfig: Tags: VpcConfig: Function: Architectures: AssumeRolePolicyDocument: AutoPublishAlias: AutoPublishAliasAllProperties: CapacityProviderConfig: CodeSigningConfigArn: CodeUri: DeadLetterQueue: DeploymentPreference: Description: DurableConfig: Environment: EphemeralStorage: EventInvokeConfig: FileSystemConfigs: FunctionScalingConfig: FunctionUrlConfig: Handler: KmsKeyArn: Layers: LoggingConfig: MemorySize: PermissionsBoundary: PropagateTags: ProvisionedConcurrencyConfig: PublishToLatestPublished: RecursiveLoop: ReservedConcurrentExecutions: RolePath: Runtime: RuntimeManagementConfig: SnapStart: SourceKMSKeyArn: Tags: TenancyConfig: Timeout: Tracing: VersionDeletionPolicy: VpcConfig: HttpApi: AccessLogSettings: Auth: PropagateTags: StageVariables: Tags: SimpleTable: SSESpecification: StateMachine: PropagateTags: MicrovmImage: BaseImageArn: BaseImageVersion: BuildRoleArn: Hooks: EnvironmentVariables: EgressNetworkConnectors: CpuConfigurations: Resources: AdditionalOsCapabilities: Logging: Tags: PropagateTags: NetworkConnector: OperatorRole: Tags: PropagateTags: WebFunction: Runtime: Timeout: EnvironmentVariables: ExecutionRoleArn: AuthType: KmsKeyArn: LoggingConfig: ScalingConfig: ThrottleConfig: MaxConcurrencyPerEnvironment: EgressNetworkConnectorArn: EndpointType: AutoDeploymentMode: ReplicaRegions: Tags:
Anmerkung

Alle Ressourcen und Eigenschaften, die nicht in der vorherigen Liste enthalten sind, werden nicht unterstützt. Sie werden u. a. aus folgenden Gründen nicht unterstützt: 1) Sie führen zu potenziellen Sicherheitsproblemen oder 2) Sie erschweren die Verständlichkeit der Vorlage.

Implizite APIs

AWS SAM schafft implizite APIs wenn Sie eine API in der deklarieren Events Abschnitt. Du kannst verwenden Globals um alle Eigenschaften impliziter APIs zu überschreiben.

Überschreibbare Eigenschaften

Ressourcen können die Eigenschaften überschreiben, die Sie in der Globals Abschnitt. Sie können beispielsweise einer Umgebungsvariablenzuordnung neue Variablen hinzufügen oder global deklarierte Variablen überschreiben. Die Ressource kann jedoch keine Eigenschaft entfernen, die in der Globals Abschnitt.

Allgemeiner gesagt, der Globals Der Abschnitt deklariert Eigenschaften, die alle Ihre Ressourcen gemeinsam haben. Einige Ressourcen können neue Werte für global deklarierte Eigenschaften bereitstellen, sie können sie jedoch nicht entfernen. Wenn einige Ressourcen eine Eigenschaft verwenden, andere jedoch nicht, dann dürfen Sie sie nicht in der Globals Abschnitt.

In den folgenden Abschnitten wird beschrieben, wie das Überschreiben für verschiedene Datentypen funktioniert.

Primitive Datentypen werden ersetzt

Zu den primitiven Datentypen gehören Zeichenketten, Zahlen, Boolesche Werte usw.

Der Wert, der in der Resources Abschnitt ersetzt den Wert in Globals Abschnitt.

Beispiel:

Globals: Function: Runtime: nodejs12.x Resources: MyFunction: Type: AWS::Serverless::Function Properties: Runtime: python3.9

Der Runtime zum MyFunction ist gesetzt auf python3.9.

Karten werden zusammengeführt

Karten werden auch als Wörterbücher oder Sammlungen von Schlüssel-Wert-Paaren bezeichnet.

Karteneinträge in der Resources Abschnitte werden mit globalen Karteneinträgen zusammengeführt. Wenn es Duplikate gibt, Resource Der Abschnittseintrag überschreibt den Globals Abschnittseintrag.

Beispiel:

Globals: Function: Environment: Variables: STAGE: Production TABLE_NAME: global-table Resources: MyFunction: Type: AWS::Serverless::Function Properties: Environment: Variables: TABLE_NAME: resource-table NEW_VAR: hello

Die Umgebungsvariablen von MyFunction sind auf Folgendes festgelegt:

{ "STAGE": "Production", "TABLE_NAME": "resource-table", "NEW_VAR": "hello" }

Listen sind additiv

Listen werden auch als Arrays bezeichnet.

Listet Einträge in der Globals Abschnitte werden der Liste in der Liste vorangestellt Resources Abschnitt.

Beispiel:

Globals: Function: VpcConfig: SecurityGroupIds: - sg-123 - sg-456 Resources: MyFunction: Type: AWS::Serverless::Function Properties: VpcConfig: SecurityGroupIds: - sg-first

Der SecurityGroupIds zum MyFunctions VpcConfig sind auf Folgendes eingestellt:

[ "sg-123", "sg-456", "sg-first" ]