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.

# AWS SAM Schablone
<a name="sam-specification"></a>

Nachdem Sie den **sam init** Befehl ausgeführt und den nachfolgenden Workflow abgeschlossen haben, AWS SAM erstellt das Projektverzeichnis Ihrer Anwendung, bei dem es sich um Ihr AWS SAM Projekt handelt. Sie definieren Ihre serverlose Anwendung, indem Sie Ihrem AWS SAM Projekt Code hinzufügen. Ihr AWS SAM Projekt besteht zwar aus einer Reihe von Dateien und Ordnern, aber die Datei, mit der Sie hauptsächlich arbeiten, ist Ihre AWS SAM Vorlage (benannt`template.yaml`). In dieser Vorlage schreiben Sie den Code, um Ressourcen, Ereignisquellenzuordnungen und andere Eigenschaften auszudrücken, die Ihre serverlose Anwendung definieren.

**Anmerkung**  
Ein Schlüsselelement der AWS SAM Vorlage ist die Vorlagenspezifikation. AWS SAM Diese Spezifikation bietet die Kurzsyntax, mit der Sie im Vergleich zu CloudFormation weniger Codezeilen die Ressourcen, Zuordnungen von Ereignisquellen APIs, Berechtigungen und anderen Eigenschaften Ihrer serverlosen Anwendung definieren können.

Dieser Abschnitt enthält Einzelheiten darüber, wie Sie Abschnitte in der AWS SAM Vorlage verwenden, um Ressourcentypen, Ressourceneigenschaften, Datentypen, Ressourcenattribute, systeminterne Funktionen und API-Gateway-Erweiterungen zu definieren.

AWS SAM Vorlagen sind eine Erweiterung von CloudFormation Vorlagen mit eindeutigen Syntaxtypen, die Kurzsyntax mit weniger Codezeilen als verwenden. CloudFormation Dies beschleunigt Ihre Entwicklung beim Erstellen einer serverlosen Anwendung. Weitere Informationen finden Sie unter [AWS SAM Ressourcen und Immobilien](sam-specification-resources-and-properties.md). Die vollständige Referenz zu CloudFormation Vorlagen finden Sie unter [CloudFormation Vorlagenreferenz](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-reference.html) im *AWS CloudFormation Benutzerhandbuch*.

Bei der Entwicklung wird es für Sie oft von Vorteil sein, Ihren Anwendungscode in separate Dateien aufzuteilen, um Ihre Anwendung besser organisieren und verwalten zu können. Ein einfaches Beispiel hierfür ist die Verwendung einer separaten Datei für Ihren AWS Lambda Funktionscode, anstatt diesen Code in Ihrer AWS SAM Vorlage zu haben. Organisieren Sie dazu Ihren Lambda-Funktionscode in einem Unterverzeichnis Ihres Projekts und verweisen Sie auf seinen lokalen Pfad in Ihrer AWS Serverless Application Model ()AWS SAM-Vorlage.

**Topics**
+ [AWS SAM Anatomie der Vorlage](sam-specification-template-anatomy.md)
+ [AWS SAM Ressourcen und Immobilien](sam-specification-resources-and-properties.md)
+ [Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md)
+ [Ressourcenattribute, unterstützt von AWS SAM](sam-specification-resource-attributes.md)
+ [API-Gateway-Erweiterungen für AWS SAM](sam-specification-api-gateway-extensions.md)
+ [Intrinsische Funktionen für AWS SAM](sam-specification-intrinsic-functions.md)

# AWS SAM Anatomie der Vorlage
<a name="sam-specification-template-anatomy"></a>

Eine AWS SAM Vorlagendatei folgt weitgehend dem Format einer CloudFormation Vorlagendatei, das im *AWS CloudFormation Benutzerhandbuch* unter [Anatomie der Vorlage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) beschrieben wird. Die Hauptunterschiede zwischen AWS SAM Vorlagendateien und CloudFormation Vorlagendateien sind die folgenden:
+ **Deklaration transformieren.** Die Deklaration `Transform: AWS::Serverless-2016-10-31` ist für AWS SAM Vorlagendateien erforderlich. Diese Deklaration identifiziert eine CloudFormation Vorlagendatei als AWS SAM Vorlagendatei. Weitere Informationen zu Transformationen finden Sie unter [Transform](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html) im *AWS CloudFormation Benutzerhandbuch*.
+ **Abschnitt „Globals“.** Der `Globals` Abschnitt ist einzigartig für AWS SAM. Er definiert Eigenschaften, die allen Ihren serverlosen Funktionen gemeinsam sind, und APIs. Alle `AWS::Serverless::StateMachine` Ressourcen`AWS::Serverless::Function`,`AWS::Serverless::Api`,`AWS::Serverless::CapacityProvider`, `AWS::Serverless::HttpApi``AWS::Serverless::SimpleTable`, und erben die Eigenschaften, die `Globals` im Abschnitt definiert sind. Weitere Informationen zu diesem Abschnitt finden Sie unter[Abschnitt „Globals“ der Vorlage AWS SAM](sam-specification-template-anatomy-globals.md).
+ **Abschnitt „Ressourcen“.** In AWS SAM Vorlagen kann der `Resources` Abschnitt eine Kombination aus CloudFormation Ressourcen und AWS SAM Ressourcen enthalten. Weitere Informationen zu CloudFormation Ressourcen finden Sie in der [Referenz zu AWS Ressourcen- und Eigenschaftstypen](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) im *AWS CloudFormation Benutzerhandbuch*. Weitere Informationen zu AWS SAM Ressourcen finden Sie unter[AWS SAM Ressourcen und Immobilien](sam-specification-resources-and-properties.md).

Alle anderen Abschnitte einer AWS SAM Vorlagendatei entsprechen dem gleichnamigen Abschnitt der CloudFormation Vorlagendatei.

## YAML
<a name="template-anatomy-outline.yaml"></a>

Das folgende Beispiel zeigt ein in YAML formatiertes Vorlagenfragment.

```
Transform: AWS::Serverless-2016-10-31

Globals:
  set of globals

Description:
  String

Metadata:
  template metadata

Parameters:
  set of parameters

Mappings:
  set of mappings

Conditions:
  set of conditions

Resources:
  set of resources

Outputs:
  set of outputs
```

## Abschnitte einer Vorlage
<a name="template-anatomy-sections"></a>

AWS SAM Vorlagen können mehrere Hauptabschnitte enthalten. Nur die `Resources` Abschnitte `Transform` und sind erforderlich.

Sie können die Vorlagenabschnitte in beliebiger Reihenfolge einfügen. Wenn Sie jedoch Spracherweiterungen verwenden, sollten Sie `AWS::LanguageExtensions` *sie vor* der serverlosen Transformation (also vor`AWS::Serverless-2016-10-31`) hinzufügen, wie im folgenden Beispiel gezeigt:

```
Transform:
  - AWS::LanguageExtensions
  - AWS::Serverless-2016-10-31
```

Beim Erstellen Ihrer Vorlage kann es hilfreich sein, die logische Reihenfolge zu verwenden, die in der folgenden Liste aufgeführt ist. Das liegt daran, dass sich die Werte in einem Abschnitt möglicherweise auf Werte aus einem vorherigen Abschnitt beziehen.

**[Transformieren (erforderlich)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html)**  
Bei AWS SAM Vorlagen müssen Sie diesen Abschnitt mit einem Wert von einschließen`AWS::Serverless-2016-10-31`.  
Zusätzliche Transformationen sind optional. Weitere Informationen zu Transformationen finden Sie unter [Transform](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html) im *AWS CloudFormation Benutzerhandbuch*.

**[Globale Werte (optional)](sam-specification-template-anatomy-globals.md)**  
Eigenschaften, die all Ihren serverlosen Funktionen und einfachen Tabellen APIs gemeinsam sind. Alle `AWS::Serverless::StateMachine` Ressourcen`AWS::Serverless::Function`,`AWS::Serverless::Api`, `AWS::Serverless::CapacityProvider` `AWS::Serverless::HttpApi``AWS::Serverless::SimpleTable`, und erben die Eigenschaften, die `Globals` im Abschnitt definiert sind.  
Dieser Abschnitt ist einzigartig für AWS SAM. In CloudFormation Vorlagen gibt es keinen entsprechenden Abschnitt.

**[Description (optional)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-description-structure.html)**  
Gibt eine Textzeichenfolge als Beschreibung der Vorlage an.  
Dieser Abschnitt entspricht direkt dem `Description` Abschnitt CloudFormation Vorlagen.

**[Metadata (optional)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html)**  
Gibt Objekte an, die zusätzliche Informationen über die Vorlage liefern.  
Dieser Abschnitt entspricht direkt dem `Metadata` Abschnitt der CloudFormation Vorlagen.

**[Parameters (optional)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html)**  
Werte, die zur Laufzeit an die Vorlage übergeben werden sollen (also bei der Erstellung oder Aktualisierung eines Stacks). Hier können Sie Parameter aus den Vorlagenabschnitten `Resources` und `Outputs` referenzieren. Objekte, die in diesem `Parameters` Abschnitt deklariert sind, veranlassen den **sam deploy --guided** Befehl, dem Benutzer zusätzliche Eingabeaufforderungen anzuzeigen.  
Werte, die mithilfe des `--parameter-overrides` `sam deploy` Befehlsparameters übergeben werden, und Einträge in der Konfigurationsdatei haben Vorrang vor Einträgen in der Vorlagendatei. AWS SAM Weitere Informationen zu dem `sam deploy` Befehl finden Sie [sam deploy](sam-cli-command-reference-sam-deploy.md) in der Befehlsreferenz. AWS SAMCLI Weitere Informationen zur Konfigurationsdatei finden Sie unter [AWS SAMCLIKonfigurationsdatei](serverless-sam-cli-config.md).

**[Mappings (optional)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html)**  
Eine Sammlung von Zuweisungen ähnlich einer Lookup-Tabelle, die Schlüssel und die ihnen zugeordneten Werte enthält. Mit ihrer Hilfe lassen sich Werte für bedingte Parameter festlegen. Sie können einen Schlüssel einem entsprechenden Wert zuordnen, indem Sie die [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-findinmap.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-findinmap.html)systeminterne Funktion in den Abschnitten `Resources` und `Outputs` verwenden.  
Dieser Abschnitt entspricht direkt dem `Mappings` Abschnitt mit den Vorlagen. CloudFormation 

**[Conditions (optional)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html)**  
Bedingungen, die steuern, ob während der Erstellung oder Aktualisierung eines Stacks bestimmte Ressourcen erstellt werden oder ein Wert für bestimmte Ressourceneigenschaften festgelegt wird. Beispielsweise könnten Sie über Bedingungen festlegen, wie eine Ressource erstellt wird, wenn der Stack für eine Produktionsumgebung gedacht ist, und wie sie erstellt wird, wenn der Stack für eine Testumgebung gedacht ist.  
Dieser Abschnitt entspricht direkt dem `Conditions` Abschnitt der CloudFormation Vorlagen.

**[Resources (erforderlich)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html)**  
Die Stack-Ressourcen und ihre Eigenschaften, z. B. eine Amazon Elastic Compute Cloud (Amazon EC2) -Instance oder ein Amazon Simple Storage Service (Amazon S3) -Bucket. Hier können Sie Ressourcen aus den Vorlagenabschnitten `Resources` und `Outputs` referenzieren.  
Dieser Abschnitt ähnelt dem `Resources` Abschnitt mit CloudFormation Vorlagen. In AWS SAM Vorlagen kann dieser Abschnitt zusätzlich zu AWS SAM Ressourcen CloudFormation Ressourcen enthalten.

**[Outputs (optional)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html)**  
Die Werte, die zurückgegeben werden, wenn Sie sich die Eigenschaften Ihres Stacks ansehen. Sie können beispielsweise eine Ausgabe für einen S3-Bucket-Namen deklarieren und dann den Befehl `aws cloudformation describe-stacks` AWS Command Line Interface (AWS CLI) aufrufen, um den Namen anzuzeigen.  
Dieser Abschnitt entspricht direkt dem `Outputs` Abschnitt der CloudFormation Vorlagen.

## Nächste Schritte
<a name="template-anatomy-next-steps"></a>

Informationen zum Herunterladen und Bereitstellen einer serverlosen Beispielanwendung, die eine AWS SAM Vorlagendatei enthält, finden [Erste Schritte mit AWS SAM](serverless-getting-started.md) Sie in [Tutorial: Stellen Sie eine Hello World-Anwendung bereit mit AWS SAM](serverless-getting-started-hello-world.md) den Anweisungen unter.

# Abschnitt „Globals“ der Vorlage AWS SAM
<a name="sam-specification-template-anatomy-globals"></a>

Manchmal haben Ressourcen, die Sie in einer AWS SAM Vorlage deklarieren, gemeinsame Konfigurationen. Beispielsweise haben Sie möglicherweise eine Anwendung mit mehreren `AWS::Serverless::Function` Ressourcen, die identische`Runtime`,`Memory`, `VPCConfig``Environment`, und `Cors` Konfigurationen haben. Anstatt diese Informationen in jeder Ressource zu duplizieren, können Sie sie einmal in dem `Globals` Abschnitt deklarieren und Ihre Ressourcen sie erben lassen.

Der `Globals` Abschnitt unterstützt die folgenden AWS SAM Ressourcentypen:
+ `AWS::Serverless::Api`
+ `AWS::Serverless::CapacityProvider`
+ `AWS::Serverless::Function`
+ `AWS::Serverless::HttpApi`
+ `AWS::Serverless::SimpleTable`
+ `AWS::Serverless::StateMachine`

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 `ThumbnailFunction` verwenden Sie beide `HelloWorldFunction` und „nodejs12.x“ für`Runtime`, „180" Sekunden für und „index.handler“ für`Timeout`. `Handler` `HelloWorldFunction`fügt die Umgebungsvariable MESSAGE zusätzlich zur geerbten Datei TABLE\$1NAME hinzu. `ThumbnailFunction`erbt alle `Globals` Eigenschaften und fügt eine API-Ereignisquelle hinzu.

## Unterstützte Ressourcen und Eigenschaften
<a name="sam-specification-template-anatomy-globals-supported-resources-and-properties"></a>

AWS SAM unterstützt die folgenden Ressourcen und Eigenschaften.

```
Globals:
  Api:
    AccessLogSetting:
    Auth:
    BinaryMediaTypes:
    CacheClusterEnabled:
    CacheClusterSize:
    CanarySetting:
    Cors:
    DefinitionUri:
    Domain:
    EndpointConfiguration:
    GatewayResponses:
    MethodSettings:
    MinimumCompressionSize:
    Name:
    OpenApiVersion:
    PropagateTags:
    TracingEnabled:
    Variables:
  
  CapacityProvider:
    InstanceRequirements:
    KmsKeyArn:
    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:
```

**Anmerkung**  
Ressourcen und Eigenschaften, die nicht in der vorherigen Liste enthalten sind, werden nicht unterstützt. Zu den Gründen, warum sie nicht unterstützt werden, gehören: 1) Sie führen zu potenziellen Sicherheitsproblemen oder 2) Sie machen die Vorlage schwer verständlich.

## Implizit APIs
<a name="sam-specification-template-anatomy-globals-implicit-apis"></a>

AWS SAM erzeugt *implizit, APIs* wenn Sie eine API in dem `Events` Abschnitt deklarieren. Sie können verwenden`Globals`, um alle Eigenschaften von implicit APIs zu überschreiben.

## Überschreibbare Eigenschaften
<a name="sam-specification-template-anatomy-globals-overrideable"></a>

Ressourcen können die Eigenschaften, die Sie im Abschnitt deklarieren, außer Kraft setzen. `Globals` Sie können beispielsweise einer Umgebungsvariablenübersicht neue Variablen hinzufügen oder global deklarierte Variablen überschreiben. Die Ressource kann jedoch keine Eigenschaft entfernen, die im `Globals` Abschnitt angegeben ist.

Allgemeiner ausgedrückt werden in `Globals` diesem Abschnitt Eigenschaften deklariert, die alle Ihre Ressourcen gemeinsam nutzen. 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, dürfen Sie sie nicht in dem `Globals` Abschnitt deklarieren.

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

### Primitive Datentypen werden ersetzt
<a name="sam-specification-template-anatomy-globals-overrideable-primitives"></a>

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

Der im `Resources` Abschnitt angegebene Wert ersetzt den Wert im `Globals` Abschnitt.

Beispiel:

```
Globals:
  Function:
    Runtime: nodejs12.x

Resources:
  MyFunction:
    Type: AWS::Serverless::Function
    Properties:
      Runtime: python3.9
```

Der `Runtime` Wert für `MyFunction` ist auf gesetzt`python3.9`.

### Karten werden zusammengeführt
<a name="sam-specification-template-anatomy-globals-overrideable-maps"></a>

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

Karteneinträge in `Resources` diesem Abschnitt werden mit globalen Karteneinträgen zusammengeführt. Wenn Duplikate vorhanden sind, überschreibt der `Resource` Abschnittseintrag 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 wie folgt gesetzt:

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

### Listen sind additiv
<a name="sam-specification-template-anatomy-globals-overrideable-lists"></a>

Listen werden auch als Arrays bezeichnet.

Listeneinträge im `Globals` Abschnitt werden der Liste im Abschnitt vorangestellt. `Resources`

Beispiel:

```
Globals:
  Function:
    VpcConfig:
      SecurityGroupIds:
        - sg-123
        - sg-456

Resources:
  MyFunction:
    Type: AWS::Serverless::Function
    Properties:
      VpcConfig:
        SecurityGroupIds:
          - sg-first
```

Die `SecurityGroupIds` `MyFunction` For-Werte `VpcConfig` sind wie folgt festgelegt:

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

# AWS SAM Ressourcen und Immobilien
<a name="sam-specification-resources-and-properties"></a>

In diesem Abschnitt werden die Ressourcen- und Eigenschaftstypen beschrieben, die spezifisch für sind. AWS SAM Sie definieren diese Ressourcen und Eigenschaften mithilfe der AWS SAM Kurzsyntax. AWS SAM unterstützt auch CloudFormation Ressourcen- und Eigenschaftstypen. Referenzinformationen zu allen AWS Ressourcen- und Eigenschaftstypen CloudFormation sowie deren AWS SAM Unterstützung finden Sie in der [Referenz zu AWS Ressourcen- und Eigenschaftstypen](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) im *AWS CloudFormation Benutzerhandbuch*.

**Topics**
+ [AWS::Serverless::Api](sam-resource-api.md)
+ [AWS::Serverless::Application](sam-resource-application.md)
+ [AWS::Serverless::CapacityProvider](sam-resource-capacityprovider.md)
+ [AWS::Serverless::Connector](sam-resource-connector.md)
+ [AWS::Serverless::Function](sam-resource-function.md)
+ [AWS::Serverless::GraphQLApi](sam-resource-graphqlapi.md)
+ [AWS::Serverless::HttpApi](sam-resource-httpapi.md)
+ [AWS::Serverless::LayerVersion](sam-resource-layerversion.md)
+ [AWS::Serverless::SimpleTable](sam-resource-simpletable.md)
+ [AWS::Serverless::StateMachine](sam-resource-statemachine.md)

# AWS::Serverless::Api
<a name="sam-resource-api"></a>

Erstellt eine Sammlung von Amazon API Gateway Gateway-Ressourcen und -Methoden, die über HTTPS-Endpunkte aufgerufen werden können.

Eine [AWS::Serverless::Api](#sam-resource-api) Ressource muss nicht explizit zu einer Vorlage für AWS serverlose Anwendungsdefinitionen hinzugefügt werden. Eine Ressource dieses Typs wird implizit aus der Vereinigung von API-Ereignissen erstellt, die für [AWS::Serverless::Function](sam-resource-function.md) Ressourcen definiert sind, die in der Vorlage definiert sind und sich nicht auf eine [AWS::Serverless::Api](#sam-resource-api) Ressource beziehen.

Eine [AWS::Serverless::Api](#sam-resource-api) Ressource sollte verwendet werden, um die verwendete API zu definieren und zu dokumentieren OpenApi, was mehr Möglichkeiten bietet, die zugrunde liegenden Amazon API Gateway Gateway-Ressourcen zu konfigurieren.

Wir empfehlen, CloudFormation Hooks oder IAM-Richtlinien zu verwenden, um zu überprüfen, ob an API-Gateway-Ressourcen Autorisatoren angehängt sind, um den Zugriff darauf zu kontrollieren.

Weitere Informationen zur Verwendung von CloudFormation Hooks finden Sie unter [Hooks registrieren](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/registering-hook-python.html) im *CloudFormation CLI-Benutzerhandbuch* und im [apigw-enforce-authorizer](https://github.com/aws-cloudformation/aws-cloudformation-samples/tree/main/hooks/python-hooks/apigw-enforce-authorizer/) GitHub Repository.

Weitere Informationen zur Verwendung von IAM-Richtlinien finden Sie unter [Erfordern, dass API-Routen autorisiert sind](https://docs.aws.amazon.com/apigateway/latest/developerguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-require-authorization) im *API Gateway Developer Guide*.

**Anmerkung**  
Bei der Bereitstellung auf werden AWS CloudFormation Ihre AWS SAM Ressourcen in Ressourcen umgewandelt CloudFormation . AWS SAM Weitere Informationen finden Sie unter [Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md).

## Syntax
<a name="sam-resource-api-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS Serverless Application Model (AWS SAM) -Vorlage zu deklarieren.

### YAML
<a name="sam-resource-api-syntax.yaml"></a>

```
Type: AWS::Serverless::Api
Properties:
  [AccessLogSetting](#sam-api-accesslogsetting): [AccessLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting)
  AlwaysDeploy: Boolean
  [ApiKeySourceType](#sam-api-apikeysourcetype): String
  [Auth](#sam-api-auth): ApiAuth
  [BinaryMediaTypes](#sam-api-binarymediatypes): List
  [CacheClusterEnabled](#sam-api-cacheclusterenabled): Boolean
  [CacheClusterSize](#sam-api-cacheclustersize): String
  [CanarySetting](#sam-api-canarysetting): [CanarySetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-canarysetting)
  [Cors](#sam-api-cors): String | CorsConfiguration
  [DefinitionBody](#sam-api-definitionbody): JSON
  [DefinitionUri](#sam-api-definitionuri): String | ApiDefinition
  [Description](#sam-api-description): String
  [DisableExecuteApiEndpoint](#sam-api-disableexecuteapiendpoint): Boolean
  [Domain](#sam-api-domain): DomainConfiguration
  [EndpointConfiguration](#sam-api-endpointconfiguration): EndpointConfiguration
  [FailOnWarnings](#sam-api-failonwarnings): Boolean
  [GatewayResponses](#sam-api-gatewayresponses): Map
  MergeDefinitions: Boolean
  [MethodSettings](#sam-api-methodsettings): MethodSettings
  [MinimumCompressionSize](#sam-api-minimumcompressionsize): Integer
  [Mode](#sam-api-mode): String
  [Models](#sam-api-models): Map
  [Name](#sam-api-name): String
  [OpenApiVersion](#sam-api-openapiversion): String
  PropagateTags: Boolean
  [Policy](#sam-api-policy): JSON
  [StageName](#sam-api-stagename): String
  [Tags](#sam-api-tags): Map
  [TracingEnabled](#sam-api-tracingenabled): Boolean
  [Variables](#sam-api-variables): Map
```

## Eigenschaften
<a name="sam-resource-api-properties"></a>

 `AccessLogSetting`   <a name="sam-api-accesslogsetting"></a>
Konfiguriert die Einstellung für das Zugriffsprotokoll für eine Phase.  
*Typ:* [AccessLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[AccessLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting)` Eigenschaft einer `AWS::ApiGateway::Stage` Ressource übergeben.

 `AlwaysDeploy`   <a name="sam-api-alwaysdeploy"></a>
Stellt die API immer bereit, auch wenn keine Änderungen an der API festgestellt wurden.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig AWS SAM und hat kein CloudFormation Äquivalent.

 `ApiKeySourceType`   <a name="sam-api-apikeysourcetype"></a>
Die Quelle des API-Schlüssels für Messungsanforderungen nach einem Nutzungsplan. Gültige Werte sind `HEADER` und `AUTHORIZER`.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ApiKeySourceType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-apikeysourcetype)` Eigenschaft einer `AWS::ApiGateway::RestApi` Ressource übergeben.

 `Auth`   <a name="sam-api-auth"></a>
Konfigurieren Sie die Autorisierung, um den Zugriff auf Ihre API-Gateway-API zu kontrollieren.  
Weitere Informationen zur Konfiguration des Zugriffs mithilfe von AWS SAM finden Sie unter[Kontrollieren Sie den API-Zugriff mit Ihrer AWS SAM Vorlage](serverless-controlling-access-to-apis.md). Ein Beispiel, das zeigt, wie Sie einen globalen Autorisierer überschreiben können, finden Sie unter[Überschreiben Sie einen globalen Autorisierer für Ihre Amazon API Gateway Gateway-REST-API](sam-property-function-apifunctionauth.md#sam-property-function-apifunctionauth--examples--override).  
*Typ:* [ApiAuth](sam-property-api-apiauth.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `BinaryMediaTypes`   <a name="sam-api-binarymediatypes"></a>
Liste der MIME-Typen, die Ihre API zurückgeben könnte. Verwenden Sie dies, um die Binärunterstützung für zu aktivierenAPIs.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[BinaryMediaTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-binarymediatypes)` Eigenschaft einer `AWS::ApiGateway::RestApi` Ressource. Die Liste von BinaryMediaTypes wird sowohl der CloudFormation Ressource als auch dem OpenAPI-Dokument hinzugefügt.

 `CacheClusterEnabled`   <a name="sam-api-cacheclusterenabled"></a>
Gibt an, ob das Caching für die Phase aktiviert ist. Um Antworten zwischenzuspeichern, müssen Sie auch `CachingEnabled` auf `true` unter `MethodSettings` setzen.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[CacheClusterEnabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclusterenabled)` Eigenschaft einer `AWS::ApiGateway::Stage` Ressource übergeben.

 `CacheClusterSize`   <a name="sam-api-cacheclustersize"></a>
Die Cache-Cluster-Größe der Stufe.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[CacheClusterSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclustersize)` Eigenschaft einer `AWS::ApiGateway::Stage` Ressource übergeben.

 `CanarySetting`   <a name="sam-api-canarysetting"></a>
Konfigurieren Sie eine Canary-Einstellung für eine Phase einer regulären Bereitstellung.  
*Typ:* [CanarySetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-canarysetting)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[CanarySetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-canarysetting)` Eigenschaft einer `AWS::ApiGateway::Stage` Ressource übergeben.

 `Cors`   <a name="sam-api-cors"></a>
Verwalten Sie Cross-Origin Resource Sharing (CORS) für Ihr gesamtes API Gateway. APIs Geben Sie die Domäne, die zugelassen werden soll, als Zeichenfolge an oder geben Sie ein Wörterbuch mit zusätzlicher Cors-Konfiguration an.   
CORS erfordert eine AWS SAM Änderung Ihrer OpenAPI-Definition. Erstellen Sie eine Inline-OpenAPI-Definition in`DefinitionBody`, um CORS zu aktivieren.
Weitere Informationen zu CORS finden Sie unter [Aktivieren von CORS für eine API-Gateway-REST-API-Ressource](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-cors.html) im *API Gateway Developer Guide*.  
*Typ: Zeichenfolge* \$1 [CorsConfiguration](sam-property-api-corsconfiguration.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `DefinitionBody`   <a name="sam-api-definitionbody"></a>
OpenAPI-Spezifikation, die Ihre API beschreibt. Wenn `DefinitionUri` weder noch angegeben `DefinitionBody` sind, generiert SAM auf der Grundlage Ihrer Vorlagenkonfiguration eine `DefinitionBody` für Sie.  
Verwenden Sie die `AWS::Include` Transformation, um auf eine lokale OpenAPI Datei zu verweisen, die Ihre API definiert. Weitere Informationen hierzu finden Sie unter [Wie werden AWS SAM lokale Dateien hochgeladen](deploy-upload-local-files.md).  
*Type*: JSON  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-body)` Eigenschaft einer `AWS::ApiGateway::RestApi` Ressource. Wenn bestimmte Eigenschaften bereitgestellt werden, können Inhalte in die eingefügt oder geändert werden, DefinitionBody bevor sie an sie übergeben werden CloudFormation. Zu den Eigenschaften gehören `Auth` `BinaryMediaTypes``Cors`,`GatewayResponses`,`Models`, und eine `EventSource` vom Typ Api für eine entsprechende`AWS::Serverless::Function`.

 `DefinitionUri`   <a name="sam-api-definitionuri"></a>
Amazon S3 S3-URI, lokaler Dateipfad oder Speicherortobjekt des OpenAPI-Dokuments, das die API definiert. Das Amazon S3 S3-Objekt, auf das diese Eigenschaft verweist, muss eine gültige OpenAPI-Datei sein. Wenn `DefinitionUri` weder noch angegeben `DefinitionBody` sind, generiert SAM auf der Grundlage Ihrer Vorlagenkonfiguration eine `DefinitionBody` für Sie.  
Wenn ein lokaler Dateipfad angegeben wird, muss die Vorlage den Workflow durchlaufen, der den `sam package` Befehl `sam deploy` oder enthält, damit die Definition ordnungsgemäß transformiert wird.  
Systeminterne Funktionen werden in externen OpenApi Dateien, auf die von verwiesen wird, nicht unterstützt. `DefinitionUri` Verwenden Sie stattdessen die `DefinitionBody` Eigenschaft mit der [Include-Transformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html), um eine OpenApi Definition in die Vorlage zu importieren.  
*Typ*: Zeichenfolge \$1 [ApiDefinition](sam-property-api-apidefinition.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[BodyS3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-bodys3location)` Eigenschaft einer `AWS::ApiGateway::RestApi` Ressource. Die verschachtelten Amazon S3 S3-Eigenschaften sind unterschiedlich benannt.

 `Description`   <a name="sam-api-description"></a>
Eine Beschreibung der Api-Ressource.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-description)` Eigenschaft einer `AWS::ApiGateway::RestApi` Ressource übergeben.

 `DisableExecuteApiEndpoint`   <a name="sam-api-disableexecuteapiendpoint"></a>
Gibt an, ob Clients Ihre API mithilfe des `execute-api`-Standardendpunkts aufrufen können. Standardmäßig können Clients Ihre API mit der Standardeinstellung `https://{api_id}.execute-api.{region}.amazonaws.com` aufrufen. Wenn Sie erzwingen möchten, dass Kunden einen benutzerdefinierten Domänennamen verwenden, um Ihre API aufzurufen, geben Sie a `True`.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[ DisableExecuteApiEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-disableexecuteapiendpoint)` Eigenschaft einer `AWS::ApiGateway::RestApi` Ressource. Sie wird direkt an die `disableExecuteApiEndpoint` Eigenschaft einer `[ x-amazon-apigateway-endpoint-configuration](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-endpoint-configuration.html)` Erweiterung übergeben, die der ` [ Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-body)` Eigenschaft einer `AWS::ApiGateway::RestApi` Ressource hinzugefügt wird.

 `Domain`   <a name="sam-api-domain"></a>
Konfiguriert eine benutzerdefinierte Domain für diese API-Gateway-API.  
*Typ:* [DomainConfiguration](sam-property-api-domainconfiguration.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `EndpointConfiguration`   <a name="sam-api-endpointconfiguration"></a>
Der Endpunkttyp einer REST-API.  
*Typ:* [EndpointConfiguration](sam-property-api-endpointconfiguration.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[EndpointConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-endpointconfiguration)` Eigenschaft einer `AWS::ApiGateway::RestApi` Ressource. Die verschachtelten Konfigurationseigenschaften sind unterschiedlich benannt.

 `FailOnWarnings`   <a name="sam-api-failonwarnings"></a>
Gibt an, ob die API-Erstellung rückgängig gemacht werden soll (`true`) oder nicht (`false`), wenn eine Warnung auftritt. Der Standardwert ist `false`.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FailOnWarnings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-failonwarnings)` Eigenschaft einer `AWS::ApiGateway::RestApi` Ressource übergeben.

 `GatewayResponses`   <a name="sam-api-gatewayresponses"></a>
Konfiguriert Gateway-Antworten für eine API. Gateway-Antworten sind Antworten, die von API Gateway entweder direkt oder mithilfe von Lambda-Autorisierern zurückgegeben werden. Weitere Informationen finden Sie in der Dokumentation zur [Api OpenApi Gateway-Erweiterung für Gateway Responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-gateway-responses.html).  
*Typ*: Karte  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `MergeDefinitions`   <a name="sam-api-mergedefinitions"></a>
AWS SAM generiert eine OpenAPI Spezifikation aus Ihrer API-Ereignisquelle. Geben Sie `true` an, dass dies mit der in Ihrer `AWS::Serverless::Api` Ressource definierten OpenAPI Inline-Spezifikation AWS SAM zusammengeführt werden soll. Geben Sie `false` an, dass nicht zusammengeführt werden soll.  
`MergeDefinitions`erfordert, dass die `DefinitionBody` Eigenschaft `AWS::Serverless::Api` für definiert wird. `MergeDefinitions`ist nicht kompatibel mit der `DefinitionUri` Eigenschaft für`AWS::Serverless::Api`.  
*Standardwert*: `false`  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `MethodSettings`   <a name="sam-api-methodsettings"></a>
Konfiguriert alle Einstellungen für die API-Phase, einschließlich Logging, Metrics, CacheTTL und Throttling.  
*Typ*: Liste von [ MethodSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MethodSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-methodsettings)` Eigenschaft einer Ressource übergeben. `AWS::ApiGateway::Stage`

 `MinimumCompressionSize`   <a name="sam-api-minimumcompressionsize"></a>
Erlaubt die Komprimierung von Antworttexten auf der Grundlage des Accept-Encoding-Headers des Clients. Die Komprimierung wird ausgelöst, wenn die Größe des Antworttextes größer oder gleich dem konfigurierten Schwellenwert ist. Der maximale Schwellenwert für die Körpergröße beträgt 10 MB (10.485.760 Byte). - Die folgenden Komprimierungstypen werden unterstützt: gzip, deflate und identity.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MinimumCompressionSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-minimumcompressionsize)` Eigenschaft einer Ressource übergeben. `AWS::ApiGateway::RestApi`

 `Mode`   <a name="sam-api-mode"></a>
Diese Eigenschaft gilt nur, wenn Sie OpenAPI zur Definition Ihrer REST-API verwenden. Der `Mode` bestimmt, wie API Gateway mit Ressourcen-Updates umgeht. Weitere Informationen finden Sie unter [Mode-Eigenschaft](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-mode) des [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html)Ressourcentyps.  
*Zulässige Werte*: `overwrite` oder `merge`.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Mode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-mode)` Eigenschaft einer `AWS::ApiGateway::RestApi` Ressource übergeben.

 `Models`   <a name="sam-api-models"></a>
Die Schemas, die von Ihren API-Methoden verwendet werden sollen. Diese Schemas können mit JSON oder YAML beschrieben werden. Im Abschnitt Beispiele unten auf dieser Seite finden Sie Beispielmodelle.  
*Typ*: Karte  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Name`   <a name="sam-api-name"></a>
Ein Name für die RestApi API-Gateway-Ressource  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-name)` Eigenschaft einer `AWS::ApiGateway::RestApi` Ressource übergeben.

 `OpenApiVersion`   <a name="sam-api-openapiversion"></a>
Version von OpenApi , die verwendet werden soll. Dies kann entweder `2.0` für die Swagger-Spezifikation oder für eine der OpenApi 3.0-Versionen sein. `3.0.1` Weitere Informationen zu OpenAPI finden Sie in der [OpenAPI-Spezifikation](https://swagger.io/specification/).  
 AWS SAM erstellt eine Stage, die `Stage` standardmäßig aufgerufen wird. Wenn Sie diese Eigenschaft auf einen beliebigen gültigen Wert setzen, wird die Erstellung der Phase verhindert`Stage`. 
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

`PropagateTags`  <a name="sam-api-propagatetags"></a>
Geben Sie an, ob Tags von der `Tags` Eigenschaft an Ihre [AWS::Serverless::Api](sam-specification-generated-resources-api.md) generierten Ressourcen weitergegeben werden sollen oder nicht. Geben Sie `True` an, dass Tags in Ihren generierten Ressourcen verbreitet werden sollen.  
*Typ*: Boolesch  
*Required*: No  
*Standardwert*: `False`  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

`Policy`  <a name="sam-api-policy"></a>
Ein Richtliniendokument, das die Berechtigungen für die API enthält. Um den ARN für die Richtlinie festzulegen, verwenden Sie die intrinsische `!Join`-Funktion mit `""` als Trennzeichen und die Werte von `"execute-api:/"` und `"*"`.  
*Type*: JSON  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die [Policy-Eigenschaft](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-policy) einer `AWS::ApiGateway::RestApi` Ressource übergeben.

 `StageName`   <a name="sam-api-stagename"></a>
Der Name der Stufe, die API Gateway als erstes Pfadsegment im Aufruf-URI (Uniform Resource Identifier) verwendet.  
Um auf die Staging-Ressource zu verweisen, verwenden Sie`<api-logical-id>.Stage`. Weitere Hinweise zum Verweisen auf Ressourcen, die bei der Angabe einer [AWS::Serverless::Api](#sam-resource-api) Ressource generiert werden, finden Sie unter[CloudFormation Ressourcen, die generiert werdenAWS::Serverless::Api, wenn angegeben](sam-specification-generated-resources-api.md). Allgemeine Informationen zu generierten CloudFormation Ressourcen finden Sie unter[Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md).  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[StageName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-stagename)` Eigenschaft einer `AWS::ApiGateway::Stage` Ressource. Es ist in SAM erforderlich, aber nicht in API Gateway  
*Zusätzliche Hinweise*: Die implizite API hat den Stagennamen „Prod“.

 `Tags`   <a name="sam-api-tags"></a>
Eine Zuordnung (Zeichenfolge zu Zeichenfolge), die die Tags angibt, die zu diesem API-Gateway-Schritt hinzugefügt werden sollen. Einzelheiten zu gültigen Schlüsseln und Werten für Tags finden Sie unter [Resource-Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) im *AWS CloudFormation Benutzerhandbuch*.  
*Typ*: Karte  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tags)` Eigenschaft einer `AWS::ApiGateway::Stage` Ressource. Die Tags-Eigenschaft in SAM besteht aus Key:Value-Paaren; darin besteht CloudFormation sie aus einer Liste von Tag-Objekten.

 `TracingEnabled`   <a name="sam-api-tracingenabled"></a>
Zeigt an, ob aktives Tracing mit X-Ray für die Phase aktiviert ist. Weitere Informationen zu X-Ray finden Sie unter [Tracing user requests to REST APIs using X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) im *API Gateway Developer Guide*.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[TracingEnabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tracingenabled)` Eigenschaft einer `AWS::ApiGateway::Stage` Ressource übergeben.

 `Variables`   <a name="sam-api-variables"></a>
Eine Zuordnung (Zeichenfolge zu Zeichenfolge), die die Stufenvariablen definiert, wobei der Variablenname der Schlüssel und der Variablenwert der Wert ist. Variablennamen sind auf alphanumerische Zeichen beschränkt. Werte müssen dem folgenden regulären Ausdruck entsprechen: `[A-Za-z0-9._~:/?#&=,-]+`.  
*Typ*: Karte  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Variables](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables)` Eigenschaft einer `AWS::ApiGateway::Stage` Ressource übergeben.

## Rückgabewerte
<a name="sam-resource-api-return-values"></a>

### Punkt
<a name="sam-resource-api-return-values-ref"></a>

Wenn die logische ID dieser Ressource für die `Ref` intrinsische Funktion bereitgestellt wird, gibt sie die ID der zugrunde liegenden API-Gateway-API zurück.

Weitere Informationen zur Verwendung der `Ref` Funktion finden Sie [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)im *AWS CloudFormation Benutzerhandbuch*. 

### Fn:: GetAtt
<a name="sam-resource-api-return-values-fn--getatt"></a>

`Fn::GetAtt` gibt einen Wert für ein angegebenes Attribut dieses Typs zurück. Im Folgenden sehen Sie die verfügbaren Attribute und Beispielrückgabewerte. 

Weitere Informationen zur Verwendung `Fn::GetAtt` finden Sie [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html)im *AWS CloudFormation Benutzerhandbuch*. 

`RootResourceId`  <a name="RootResourceId-fn::getatt"></a>
Die Stamm-Ressourcen-ID für eine `RestApi`-Ressource, z. B. `a0bc123d4e`.

## Beispiele
<a name="sam-resource-api--examples"></a>

### SimpleApiExample
<a name="sam-resource-api--examples--simpleapiexample"></a>

Eine Hello AWS SAM World-Vorlagendatei, die eine Lambda-Funktion mit einem API-Endpunkt enthält. Dies ist eine vollständige AWS SAM Vorlagendatei für eine funktionierende serverlose Anwendung.

#### YAML
<a name="sam-resource-api--examples--simpleapiexample--yaml"></a>

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Description: AWS SAM template with a simple API definition
Resources:
  ApiGatewayApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: prod
  ApiFunction: # Adds a GET method at the root resource via an Api event
    Type: AWS::Serverless::Function
    Properties:
      Events:
        ApiEvent:
          Type: Api
          Properties:
            Path: /
            Method: get
            RestApiId:
              Ref: ApiGatewayApi
      Runtime: python3.10
      Handler: index.handler
      InlineCode: |
        def handler(event, context):
            return {'body': 'Hello World!', 'statusCode': 200}
```

### ApiCorsExample
<a name="sam-resource-api--examples--apicorsexample"></a>

Ein AWS SAM Vorlagenausschnitt mit einer API, die in einer externen Swagger-Datei definiert ist, zusammen mit Lambda-Integrationen und CORS-Konfigurationen. Dies ist nur ein Teil einer Vorlagendatei, der eine Definition zeigt. AWS SAM [AWS::Serverless::Api](#sam-resource-api)

#### YAML
<a name="sam-resource-api--examples--apicorsexample--yaml"></a>

```
Resources:
  ApiGatewayApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      # Allows www.example.com to call these APIs
      # SAM will automatically add AllowMethods with a list of methods for this API
      Cors: "'www.example.com'"
      DefinitionBody: # Pull in an OpenApi definition from S3
        'Fn::Transform':
          Name: 'AWS::Include'
          # Replace "bucket" with your bucket name
          Parameters:
            Location: s3://bucket/swagger.yaml
```

### ApiCognitoAuthExample
<a name="sam-resource-api--examples--apicognitoauthexample"></a>

Ein AWS SAM Vorlagenausschnitt mit einer API, die Amazon Cognito verwendet, um Anfragen an die API zu autorisieren. Dies ist nur ein Teil einer AWS SAM Vorlagendatei, die eine Definition enthält. [AWS::Serverless::Api](#sam-resource-api)

#### YAML
<a name="sam-resource-api--examples--apicognitoauthexample--yaml"></a>

```
Resources:
  ApiGatewayApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      Cors: "'*'"
      Auth:
        DefaultAuthorizer: MyCognitoAuthorizer
        Authorizers:
          MyCognitoAuthorizer:
            UserPoolArn:
              Fn::GetAtt: [MyCognitoUserPool, Arn]
```

### ApiModelsExample
<a name="sam-resource-api--examples--apimodelsexample"></a>

Ein AWS SAM Vorlagenausschnitt mit einer API, die ein Models-Schema enthält. Dies ist nur ein Teil einer AWS SAM Vorlagendatei, die eine [AWS::Serverless::Api](#sam-resource-api) Definition mit zwei Modellschemas zeigt.

#### YAML
<a name="sam-resource-api--examples--apimodelsexample--yaml"></a>

```
Resources:
  ApiGatewayApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      Models:
        User:
          type: object
          required:
            - username
            - employee_id
          properties:
            username:
              type: string
            employee_id:
              type: integer
            department:
              type: string
        Item:
          type: object
          properties:
            count:
              type: integer
            category:
              type: string
            price:
              type: integer
```

### Beispiel für Caching
<a name="sam-resource-api--examples--caching-example"></a>

Eine Hello AWS SAM World-Vorlagendatei, die eine Lambda-Funktion mit einem API-Endpunkt enthält. In der API ist das Caching für eine Ressource und Methode aktiviert. Weitere Informationen zum Caching finden Sie unter [Aktivieren von API-Caching zur Verbesserung der Reaktionsfähigkeit](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) im *API Gateway* Developer Guide.

#### YAML
<a name="sam-resource-api--examples--caching-example--yaml"></a>

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Description: AWS SAM template with a simple API definition with caching turned on
Resources:
  ApiGatewayApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: prod
      CacheClusterEnabled: true
      CacheClusterSize: '0.5'
      MethodSettings:
        - ResourcePath: /
          HttpMethod: GET
          CachingEnabled: true
          CacheTtlInSeconds: 300
      Tags:
        CacheMethods: All 

  ApiFunction: # Adds a GET method at the root resource via an Api event
    Type: AWS::Serverless::Function
    Properties:
      Events:
        ApiEvent:
          Type: Api
          Properties:
            Path: /
            Method: get
            RestApiId:
              Ref: ApiGatewayApi
      Runtime: python3.10
      Handler: index.handler
      InlineCode: |
        def handler(event, context):
            return {'body': 'Hello World!', 'statusCode': 200}
```

### Beispiel für eine benutzerdefinierte Domain mit einer privaten API
<a name="sam-resource-api--examples--custom-domain-example"></a>

Eine Hello AWS SAM World-Vorlagendatei, die eine Lambda-Funktion mit einem API-Endpunkt enthält, der einer privaten Domain zugeordnet ist. Die Vorlage erstellt eine Domänenzugriffszuordnung zwischen einem VPC-Endpunkt und der privaten Domain. Weitere Informationen finden Sie unter [Benutzerdefinierte Domainnamen für private APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html).

#### YAML
<a name="sam-resource-api--examples--custom-domain-example--yaml"></a>

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Description: AWS SAM template configured with a custom domain using a private API

Parameters:
    DomainName:
      Type: String
      Default: mydomain.example.com
    CertificateArn:
      Type: String
    HostedZoneId:
      Type: String
    VpcEndpointId:
      Type: String
    VpcEndpointDomainName:
      Type: String
    VpcEndpointHostedZoneId:
      Type: String

Resources:
  MyFunction:
    Type: AWS::Serverless::Function
    Properties:
      InlineCode: |
        def handler(event, context):
            return {'body': 'Hello World!', 'statusCode': 200}
      Handler: index.handler
      Runtime: python3.13
      Events:
        Fetch:
          Type: Api
          Properties:
            RestApiId:
              Ref: MyApi
            Method: Get
            Path: /get
  MyApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      EndpointConfiguration:
        Type: PRIVATE
        VPCEndpointIds:
        - !Ref VpcEndpointId
      Policy:
        Version: '2012-10-17		 	 	 '
        Statement:
        - Effect: Allow
          Principal: '*'
          Action: execute-api:Invoke
          Resource: execute-api:/*
        - Effect: Deny
          Principal: '*'
          Action: execute-api:Invoke
          Resource: execute-api:/*
          Condition:
            StringNotEquals:
              aws:SourceVpce: !Ref VpcEndpointId
      Domain:
        DomainName: !Ref DomainName
        CertificateArn: !Ref CertificateArn
        EndpointConfiguration: PRIVATE
        BasePath:
        - /
        Route53:
          HostedZoneId: !Ref HostedZoneId
          VpcEndpointDomainName: !Ref VpcEndpointDomainName
          VpcEndpointHostedZoneId: !Ref VpcEndpointHostedZoneId
        AccessAssociation:
          VpcEndpointId: !Ref VpcEndpointId
        Policy:
          Version: '2012-10-17		 	 	 '
          Statement:
          - Effect: Allow
            Principal: '*'
            Action: execute-api:Invoke
            Resource: execute-api:/*
          - Effect: Deny
            Principal: '*'
            Action: execute-api:Invoke
            Resource: execute-api:/*
            Condition:
              StringNotEquals:
                aws:SourceVpce: !Ref VpcEndpointId
```

# ApiAuth
<a name="sam-property-api-apiauth"></a>

Konfigurieren Sie die Autorisierung, um den Zugriff auf Ihre API-Gateway-API zu kontrollieren.

Weitere Informationen und Beispiele für die Konfiguration des Zugriffs mithilfe von AWS SAM finden Sie unter[Kontrollieren Sie den API-Zugriff mit Ihrer AWS SAM Vorlage](serverless-controlling-access-to-apis.md).

## Syntax
<a name="sam-property-api-apiauth-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-api-apiauth-syntax.yaml"></a>

```
  AddApiKeyRequiredToCorsPreflight: Boolean
  [AddDefaultAuthorizerToCorsPreflight](#sam-api-apiauth-adddefaultauthorizertocorspreflight): Boolean
  [ApiKeyRequired](#sam-api-apiauth-apikeyrequired): Boolean
  [Authorizers](#sam-api-apiauth-authorizers): CognitoAuthorizer | LambdaTokenAuthorizer | LambdaRequestAuthorizer | AWS_IAM
  [DefaultAuthorizer](#sam-api-apiauth-defaultauthorizer): String
  [InvokeRole](#sam-api-apiauth-invokerole): String
  [ResourcePolicy](#sam-api-apiauth-resourcepolicy): ResourcePolicyStatement
  [UsagePlan](#sam-api-apiauth-usageplan): ApiUsagePlan
```

**Anmerkung**  
Die `Authorizers` Eigenschaft beinhaltet`AWS_IAM`, aber dafür ist keine zusätzliche Konfiguration erforderlich`AWS_IAM`. Ein Beispiel finden Sie unter [AWS ICH BIN](#sam-property-api-apiauth--examples--aws_iam).

## Eigenschaften
<a name="sam-property-api-apiauth-properties"></a>

 `AddApiKeyRequiredToCorsPreflight`   <a name="sam-api-apiauth-addapikeyrequiredtocorspreflight"></a>
Wenn die `Cors` Eigenschaften `ApiKeyRequired` und festgelegt sind, führt `AddApiKeyRequiredToCorsPreflight` diese Einstellung dazu, dass der API-Schlüssel der `Options` Eigenschaft hinzugefügt wird.  
*Typ*: Boolesch  
*Required*: No  
*Standardwert*: `True`  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `AddDefaultAuthorizerToCorsPreflight`   <a name="sam-api-apiauth-adddefaultauthorizertocorspreflight"></a>
Wenn die `Cors` Eigenschaften `DefaultAuthorizer` und gesetzt sind, `AddDefaultAuthorizerToCorsPreflight` führt die Einstellung dazu, dass der Standard-Authorizer zur `Options` Eigenschaft im OpenAPI-Abschnitt hinzugefügt wird.  
*Typ*: Boolesch  
*Required*: No  
*Standard*: Wahr  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `ApiKeyRequired`   <a name="sam-api-apiauth-apikeyrequired"></a>
Wenn auf true gesetzt, ist ein API-Schlüssel für alle API-Ereignisse erforderlich. Weitere Informationen zu API-Schlüsseln finden Sie unter [Nutzungspläne mit API-Schlüsseln erstellen und verwenden](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) im *API Gateway Developer Guide*.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Authorizers`   <a name="sam-api-apiauth-authorizers"></a>
Der Autorisierer, der zur Steuerung des Zugriffs auf Ihre API-Gateway-API verwendet wird.  
Weitere Informationen finden Sie unter [Kontrollieren Sie den API-Zugriff mit Ihrer AWS SAM Vorlage](serverless-controlling-access-to-apis.md).  
*Typ*: [CognitoAuthorizer](sam-property-api-cognitoauthorizer.md)\$1 \$1 [LambdaTokenAuthorizer](sam-property-api-lambdatokenauthorizer.md)\$1 [LambdaRequestAuthorizer](sam-property-api-lambdarequestauthorizer.md) AWS\$1IAM  
*Required*: No  
*Standard*: Keiner  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.  
*Zusätzliche Hinweise*: SAM fügt die Authorizer zur OpenApi Definition einer API hinzu.

 `DefaultAuthorizer`   <a name="sam-api-apiauth-defaultauthorizer"></a>
Geben Sie einen Standardautorisierer für eine API-Gateway-API an, der standardmäßig für die Autorisierung von API-Aufrufen verwendet wird.  
Wenn die API EventSource für die mit dieser API verknüpfte Funktion für die Verwendung von IAM-Berechtigungen konfiguriert ist, muss diese Eigenschaft auf gesetzt werden`AWS_IAM`, da andernfalls ein Fehler auftritt.
*Typ:* Zeichenfolge  
*Required*: No  
*Standard*: Keiner  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `InvokeRole`   <a name="sam-api-apiauth-invokerole"></a>
Legt die Integrationsanmeldedaten für alle Ressourcen und Methoden auf diesen Wert fest.  
`CALLER_CREDENTIALS`ordnet zu`arn:aws:iam:::<user>/`, wodurch die Anmeldeinformationen des Anrufers verwendet werden, um den Endpunkt aufzurufen.  
*Gültige Werte*:`CALLER_CREDENTIALS`,, `NONE` `IAMRoleArn`  
*Typ:* Zeichenfolge  
*Required*: No  
*Standardwert*: `CALLER_CREDENTIALS`  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `ResourcePolicy`   <a name="sam-api-apiauth-resourcepolicy"></a>
Konfigurieren Sie die Ressourcenrichtlinie für alle Methoden und Pfade auf einer API.  
*Typ:* [ResourcePolicyStatement](sam-property-api-resourcepolicystatement.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.  
*Zusätzliche Hinweise*: Diese Einstellung kann auch individuell `AWS::Serverless::Function` mit dem definiert werden[ApiFunctionAuth](sam-property-function-apifunctionauth.md). Dies ist für APIs with erforderlich`EndpointConfiguration: PRIVATE`.

 `UsagePlan`   <a name="sam-api-apiauth-usageplan"></a>
Konfiguriert einen mit dieser API verknüpften Nutzungsplan. Weitere Informationen zu Nutzungsplänen finden Sie unter [Nutzungspläne mit API-Schlüsseln erstellen und verwenden](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) im *API Gateway Developer Guide*.  
Diese AWS SAM Eigenschaft generiert drei zusätzliche CloudFormation Ressourcen, wenn diese Eigenschaft festgelegt ist: an [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html), an und an [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html). Informationen zu diesem Szenario finden Sie unter[UsagePlan Eigenschaft ist spezifiziert](sam-specification-generated-resources-api.md#sam-specification-generated-resources-api-usage-plan). Allgemeine Informationen zu generierten CloudFormation Ressourcen finden Sie unter[Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md).  
*Typ:* [ApiUsagePlan](sam-property-api-apiusageplan.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-api-apiauth--examples"></a>

### CognitoAuth
<a name="sam-property-api-apiauth--examples--cognitoauth"></a>

Beispiel für Cognito Auth

#### YAML
<a name="sam-property-api-apiauth--examples--cognitoauth--yaml"></a>

```
Auth:
  Authorizers:
    MyCognitoAuth:
     UserPoolArn:
       Fn::GetAtt:
         - MyUserPool
         - Arn
     AuthType: "COGNITO_USER_POOLS"
  DefaultAuthorizer: MyCognitoAuth
  InvokeRole: CALLER_CREDENTIALS
  AddDefaultAuthorizerToCorsPreflight: false
  ApiKeyRequired: false
  ResourcePolicy:
    CustomStatements: [{
      "Effect": "Allow",
      "Principal": "*",
      "Action": "execute-api:Invoke",
      "Resource": "execute-api:/Prod/GET/pets",
      "Condition": {
          "IpAddress": {
              "aws:SourceIp": "1.2.3.4"
          }
        }
    }]
    IpRangeDenylist:
      - "10.20.30.40"
```

### AWS ICH BIN
<a name="sam-property-api-apiauth--examples--aws_iam"></a>

AWS IAM-Beispiel

#### YAML
<a name="sam-property-api-apiauth--examples--cognitoauth--yaml"></a>

```
Auth:
  Authorizers: AWS_IAM
```

# ApiUsagePlan
<a name="sam-property-api-apiusageplan"></a>

Konfiguriert einen Nutzungsplan für eine API-Gateway-API. Weitere Informationen zu Nutzungsplänen finden Sie unter [Nutzungspläne mit API-Schlüsseln erstellen und verwenden](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) im *API Gateway Developer Guide*.

## Syntax
<a name="sam-property-api-apiusageplan-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-api-apiusageplan-syntax.yaml"></a>

```
  [CreateUsagePlan](#sam-api-apiusageplan-createusageplan): String
  [Description](#sam-api-apiusageplan-description): String
  [Quota](#sam-api-apiusageplan-quota): [QuotaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota)
  [Tags](#sam-api-apiusageplan-tags): List
  [Throttle](#sam-api-apiusageplan-throttle): [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle)
  [UsagePlanName](#sam-api-apiusageplan-usageplanname): String
```

## Eigenschaften
<a name="sam-property-api-apiusageplan-properties"></a>

 `CreateUsagePlan`   <a name="sam-api-apiusageplan-createusageplan"></a>
Legt fest, wie dieser Nutzungsplan konfiguriert ist. Gültige Werte sind `PER_API`, `SHARED` und `NONE`.  
`PER_API`erstellt [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html), und [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html)Ressourcen, die für diese API spezifisch sind. Diese Ressourcen haben IDs den logischen Wert von `<api-logical-id>UsagePlan` `<api-logical-id>ApiKey``<api-logical-id>UsagePlanKey`, und.  
`SHARED`erstellt [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html), und [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html)Ressourcen, die von allen APIs gemeinsam genutzt werden, die auch `CreateUsagePlan: SHARED` in derselben AWS SAM Vorlage enthalten sind. Diese Ressourcen haben IDs den logischen Wert von `ServerlessUsagePlan` `ServerlessApiKey``ServerlessUsagePlanKey`, und. Wenn Sie diese Option verwenden, empfehlen wir, zusätzliche Konfigurationen für diesen Nutzungsplan nur für eine API-Ressource hinzuzufügen, um widersprüchliche Definitionen und einen unsicheren Status zu vermeiden.  
`NONE`deaktiviert die Erstellung oder Verknüpfung eines Nutzungsplans mit dieser API. Dies ist nur erforderlich, wenn `SHARED` oder in der [Abschnitt „Globals“ der Vorlage AWS SAM](sam-specification-template-anatomy-globals.md) angegeben `PER_API` ist.  
*Zulässige Werte*: `PER_API`, `SHARED` und `NONE`  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Description`   <a name="sam-api-apiusageplan-description"></a>
Eine Beschreibung des Nutzungsplans.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-description)` Eigenschaft einer `AWS::ApiGateway::UsagePlan` Ressource übergeben.

 `Quota`   <a name="sam-api-apiusageplan-quota"></a>
Konfiguriert die Anzahl von Anforderungen, die Benutzer innerhalb eines bestimmten Intervalls vornehmen können.  
*Typ:* [QuotaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Quota](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota)` Eigenschaft einer `AWS::ApiGateway::UsagePlan` Ressource übergeben.

 `Tags`   <a name="sam-api-apiusageplan-tags"></a>
Ein Array an beliebigen Tags (Schlüssel-Wert-Paaren), die dem Nutzungsplan zugewiesen werden sollen.  
Diese Eigenschaft verwendet den [CloudFormation Tag-Typ](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-tags)` Eigenschaft einer `AWS::ApiGateway::UsagePlan` Ressource übergeben.

 `Throttle`   <a name="sam-api-apiusageplan-throttle"></a>
Konfiguriert die gesamte Anforderungsrate (durchschnittliche Anforderungen pro Sekunde) und die Steigerungskapazität.  
*Typ:* [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Throttle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle)` Eigenschaft einer `AWS::ApiGateway::UsagePlan` Ressource übergeben.

 `UsagePlanName`   <a name="sam-api-apiusageplan-usageplanname"></a>
Ein Name für den Nutzungsplan.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[UsagePlanName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-usageplanname)` Eigenschaft einer `AWS::ApiGateway::UsagePlan` Ressource übergeben.

## Beispiele
<a name="sam-property-api-apiusageplan--examples"></a>

### UsagePlan
<a name="sam-property-api-apiusageplan--examples--usageplan"></a>

Im Folgenden finden Sie ein Beispiel für einen Nutzungsplan.

#### YAML
<a name="sam-property-api-apiusageplan--examples--usageplan--yaml"></a>

```
Auth:
  UsagePlan:
    CreateUsagePlan: PER_API
    Description: Usage plan for this API
    Quota:
      Limit: 500
      Period: MONTH
    Throttle:
      BurstLimit: 100
      RateLimit: 50
    Tags:
      - Key: TagName
        Value: TagValue
```

# CognitoAuthorizer
<a name="sam-property-api-cognitoauthorizer"></a>

Definieren Sie einen Amazon Cognito Cognito-Benutzerpool-Autorisierer.

Weitere Informationen und Beispiele finden Sie unter [Kontrollieren Sie den API-Zugriff mit Ihrer AWS SAM Vorlage](serverless-controlling-access-to-apis.md).

## Syntax
<a name="sam-property-api-cognitoauthorizer-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-api-cognitoauthorizer-syntax.yaml"></a>

```
  [AuthorizationScopes](#sam-api-cognitoauthorizer-authorizationscopes): List
  [Identity](#sam-api-cognitoauthorizer-identity): CognitoAuthorizationIdentity
  [UserPoolArn](#sam-api-cognitoauthorizer-userpoolarn): String
```

## Eigenschaften
<a name="sam-property-api-cognitoauthorizer-properties"></a>

 `AuthorizationScopes`   <a name="sam-api-cognitoauthorizer-authorizationscopes"></a>
Liste der Autorisierungsbereiche für diesen Autorisierer.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Identity`   <a name="sam-api-cognitoauthorizer-identity"></a>
Diese Eigenschaft kann verwendet werden, um `IdentitySource` in einer eingehenden Anfrage einen Autorisierer anzugeben.  
*Typ:* [CognitoAuthorizationIdentity](sam-property-api-cognitoauthorizationidentity.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig AWS SAM und hat kein CloudFormation Äquivalent.

 `UserPoolArn`   <a name="sam-api-cognitoauthorizer-userpoolarn"></a>
Kann einem Benutzer pool/specify einen Benutzerpool (ARN) zuweisen, zu dem Sie diesen Cognito-Autorisierer hinzufügen möchten.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. CloudFormation 

## Beispiele
<a name="sam-property-api-cognitoauthorizer--examples"></a>

### CognitoAuth
<a name="sam-property-api-cognitoauthorizer--examples--cognitoauth"></a>

Beispiel für Cognito Auth

#### YAML
<a name="sam-property-api-cognitoauthorizer--examples--cognitoauth--yaml"></a>

```
Auth:
  Authorizers:
    MyCognitoAuth:
      AuthorizationScopes:
        - scope1
        - scope2
      UserPoolArn:
        Fn::GetAtt:
          - MyCognitoUserPool
          - Arn
      Identity:
        Header: MyAuthorizationHeader
        ValidationExpression: myauthvalidationexpression
```

# CognitoAuthorizationIdentity
<a name="sam-property-api-cognitoauthorizationidentity"></a>

Diese Eigenschaft kann verwendet werden, um IdentitySource in einer eingehenden Anfrage nach einem Autorisierer ein anzugeben. Weitere Informationen dazu finden IdentitySource Sie unter der [ApiGateway Authorizer-Erweiterung OpenApi ](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-authorizer.html).

## Syntax
<a name="sam-property-api-cognitoauthorizationidentity-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-api-cognitoauthorizationidentity-syntax.yaml"></a>

```
  [Header](#sam-api-cognitoauthorizationidentity-header): String
  [ReauthorizeEvery](#sam-api-cognitoauthorizationidentity-reauthorizeevery): Integer
  [ValidationExpression](#sam-api-cognitoauthorizationidentity-validationexpression): String
```

## Eigenschaften
<a name="sam-property-api-cognitoauthorizationidentity-properties"></a>

 `Header`   <a name="sam-api-cognitoauthorizationidentity-header"></a>
Geben Sie den Header-Namen für Authorization in der OpenApi Definition an.  
*Typ:* Zeichenfolge  
*Required*: No  
*Standard*: Autorisierung  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `ReauthorizeEvery`   <a name="sam-api-cognitoauthorizationidentity-reauthorizeevery"></a>
Der Zeitraum time-to-live (TTL) in Sekunden, der angibt, wie lange API Gateway Autorisierungsergebnisse zwischenspeichert. Wenn Sie einen Wert größer als 0 festlegen, speichert API Gateway die Genehmigerantworten im Cache. Standardmäßig legt API Gateway diese Eigenschaft auf 300 fest. Der maximale Wert ist 3600, oder 1 Stunde.  
*Typ*: Ganzzahl  
*Required*: No  
*Standard: 300*  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `ValidationExpression`   <a name="sam-api-cognitoauthorizationidentity-validationexpression"></a>
Geben Sie einen Validierungsausdruck für die Validierung der eingehenden Identität an  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-api-cognitoauthorizationidentity--examples"></a>

### CognitoAuthIdentity
<a name="sam-property-api-cognitoauthorizationidentity--examples--cognitoauthidentity"></a>

#### YAML
<a name="sam-property-api-cognitoauthorizationidentity--examples--cognitoauthidentity--yaml"></a>

```
Identity:
  Header: MyCustomAuthHeader
  ValidationExpression: Bearer.*
  ReauthorizeEvery: 30
```

# LambdaRequestAuthorizer
<a name="sam-property-api-lambdarequestauthorizer"></a>

Konfigurieren Sie einen Lambda Authorizer, um den Zugriff auf Ihre API mit einer Lambda-Funktion zu kontrollieren.

Weitere Informationen und Beispiele finden Sie unter [Kontrollieren Sie den API-Zugriff mit Ihrer AWS SAM Vorlage](serverless-controlling-access-to-apis.md).

## Syntax
<a name="sam-property-api-lambdarequestauthorizer-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-api-lambdarequestauthorizer-syntax.yaml"></a>

```
DisableFunctionDefaultPermissions: Boolean
[FunctionArn](#sam-api-lambdarequestauthorizer-functionarn): String
[FunctionInvokeRole](#sam-api-lambdarequestauthorizer-functioninvokerole): String
[FunctionPayloadType](#sam-api-lambdarequestauthorizer-functionpayloadtype): String
[Identity](#sam-api-lambdarequestauthorizer-identity): LambdaRequestAuthorizationIdentity
```

## Eigenschaften
<a name="sam-property-api-lambdarequestauthorizer-properties"></a>

 `DisableFunctionDefaultPermissions`   <a name="sam-api-lambdarequestauthorizer-disablefunctiondefaultpermissions"></a>
Geben Sie `true` an, dass nicht AWS SAM automatisch eine `AWS::Lambda::Permissions` Ressource erstellt wird, um Berechtigungen zwischen Ihrer `AWS::Serverless::Api` Ressource und der Autorisierungs-Lambda-Funktion bereitzustellen.  
*Standardwert*: `false`  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `FunctionArn`   <a name="sam-api-lambdarequestauthorizer-functionarn"></a>
Geben Sie den Funktions-ARN der Lambda-Funktion an, die die Autorisierung für die API bereitstellt.  
AWS SAM erstellt automatisch eine `AWS::Lambda::Permissions` Ressource, wenn dies angegeben `FunctionArn` ist. `AWS::Serverless::Api` Die `AWS::Lambda::Permissions` Ressource stellt Berechtigungen zwischen Ihrer API und der Autorisierungs-Lambda-Funktion bereit.
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `FunctionInvokeRole`   <a name="sam-api-lambdarequestauthorizer-functioninvokerole"></a>
Fügt der OpenApi Definition des Lambda-Autorisierers Autorisierer-Anmeldeinformationen hinzu.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. CloudFormation 

 `FunctionPayloadType`   <a name="sam-api-lambdarequestauthorizer-functionpayloadtype"></a>
Diese Eigenschaft kann verwendet werden, um den Typ des Lambda Authorizers für eine API zu definieren.  
*Zulässige Werte*: `TOKEN` oder `REQUEST`.  
*Typ:* Zeichenfolge  
*Required*: No  
*Standardwert*: `TOKEN`  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig AWS SAM und hat kein CloudFormation Äquivalent.

 `Identity`   <a name="sam-api-lambdarequestauthorizer-identity"></a>
Diese Eigenschaft kann verwendet werden, um `IdentitySource` in einer eingehenden Anfrage einen Autorisierer anzugeben. Diese Eigenschaft ist nur erforderlich, wenn die `FunctionPayloadType` Eigenschaft auf `REQUEST` gesetzt ist.  
*Typ:* [LambdaRequestAuthorizationIdentity](sam-property-api-lambdarequestauthorizationidentity.md)  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-api-lambdarequestauthorizer--examples"></a>

### LambdaRequestAuth
<a name="sam-property-api-lambdarequestauthorizer--examples--lambdarequestauth"></a>

#### YAML
<a name="sam-property-api-lambdarequestauthorizer--examples--lambdarequestauth--yaml"></a>

```
Authorizers:
  MyLambdaRequestAuth:
    FunctionPayloadType: REQUEST
    FunctionArn:
      Fn::GetAtt:
        - MyAuthFunction
        - Arn
    FunctionInvokeRole:
      Fn::GetAtt:
        - LambdaAuthInvokeRole
        - Arn
    Identity:
      Headers:
        - Authorization1
```

# LambdaRequestAuthorizationIdentity
<a name="sam-property-api-lambdarequestauthorizationidentity"></a>

Diese Eigenschaft kann verwendet werden, um IdentitySource in einer eingehenden Anfrage nach einem Autorisierer ein anzugeben. Weitere Informationen dazu finden IdentitySource Sie unter der [ApiGateway Authorizer-Erweiterung OpenApi ](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-authorizer.html).

## Syntax
<a name="sam-property-api-lambdarequestauthorizationidentity-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-api-lambdarequestauthorizationidentity-syntax.yaml"></a>

```
  [Context](#sam-api-lambdarequestauthorizationidentity-context): List
  [Headers](#sam-api-lambdarequestauthorizationidentity-headers): List
  [QueryStrings](#sam-api-lambdarequestauthorizationidentity-querystrings): List
  [ReauthorizeEvery](#sam-api-lambdarequestauthorizationidentity-reauthorizeevery): Integer
  [StageVariables](#sam-api-lambdarequestauthorizationidentity-stagevariables): List
```

## Eigenschaften
<a name="sam-property-api-lambdarequestauthorizationidentity-properties"></a>

 `Context`   <a name="sam-api-lambdarequestauthorizationidentity-context"></a>
Konvertiert die angegebenen Kontextzeichenfolgen in die Mapping-Ausdrücke des Formats`context.contextString`.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Headers`   <a name="sam-api-lambdarequestauthorizationidentity-headers"></a>
Konvertiert die Header in eine durch Kommas getrennte Zeichenfolge von Zuordnungsausdrücken des Formats. `method.request.header.name`  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. CloudFormation 

 `QueryStrings`   <a name="sam-api-lambdarequestauthorizationidentity-querystrings"></a>
Konvertiert die angegebenen Abfragezeichenfolgen in eine durch Kommas getrennte Zeichenfolge von Zuordnungsausdrücken des Formats. `method.request.querystring.queryString`  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `ReauthorizeEvery`   <a name="sam-api-lambdarequestauthorizationidentity-reauthorizeevery"></a>
Der Zeitraum time-to-live (TTL) in Sekunden, der angibt, wie lange API Gateway Autorisierungsergebnisse zwischenspeichert. Wenn Sie einen Wert größer als 0 festlegen, speichert API Gateway die Genehmigerantworten im Cache. Standardmäßig legt API Gateway diese Eigenschaft auf 300 fest. Der maximale Wert ist 3600, oder 1 Stunde.  
*Typ*: Ganzzahl  
*Required*: No  
*Standard: 300*  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `StageVariables`   <a name="sam-api-lambdarequestauthorizationidentity-stagevariables"></a>
Konvertiert die angegebenen Stufenvariablen in eine durch Kommas getrennte Zeichenfolge von Zuordnungsausdrücken des Formats. `stageVariables.stageVariable`  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-api-lambdarequestauthorizationidentity--examples"></a>

### LambdaRequestIdentity
<a name="sam-property-api-lambdarequestauthorizationidentity--examples--lambdarequestidentity"></a>

#### YAML
<a name="sam-property-api-lambdarequestauthorizationidentity--examples--lambdarequestidentity--yaml"></a>

```
Identity:
  QueryStrings:
    - auth
  Headers:
    - Authorization
  StageVariables:
    - VARIABLE
  Context:
    - authcontext
  ReauthorizeEvery: 100
```

# LambdaTokenAuthorizer
<a name="sam-property-api-lambdatokenauthorizer"></a>

Konfigurieren Sie einen Lambda Authorizer, um den Zugriff auf Ihre API mit einer Lambda-Funktion zu kontrollieren.

Weitere Informationen und Beispiele finden Sie unter [Kontrollieren Sie den API-Zugriff mit Ihrer AWS SAM Vorlage](serverless-controlling-access-to-apis.md).

## Syntax
<a name="sam-property-api-lambdatokenauthorizer-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-api-lambdatokenauthorizer-syntax.yaml"></a>

```
DisableFunctionDefaultPermissions: Boolean
[FunctionArn](#sam-api-lambdatokenauthorizer-functionarn): String
[FunctionInvokeRole](#sam-api-lambdatokenauthorizer-functioninvokerole): String
[FunctionPayloadType](#sam-api-lambdatokenauthorizer-functionpayloadtype): String
[Identity](#sam-api-lambdatokenauthorizer-identity): LambdaTokenAuthorizationIdentity
```

## Eigenschaften
<a name="sam-property-api-lambdatokenauthorizer-properties"></a>

 `DisableFunctionDefaultPermissions`   <a name="sam-api-lambdatokenauthorizer-disablefunctiondefaultpermissions"></a>
Geben Sie `true` an, dass nicht AWS SAM automatisch eine `AWS::Lambda::Permissions` Ressource erstellt wird, um Berechtigungen zwischen Ihrer `AWS::Serverless::Api` Ressource und der Autorisierungs-Lambda-Funktion bereitzustellen.  
*Standardwert*: `false`  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `FunctionArn`   <a name="sam-api-lambdatokenauthorizer-functionarn"></a>
Geben Sie den Funktions-ARN der Lambda-Funktion an, die die Autorisierung für die API bereitstellt.  
AWS SAM erstellt automatisch eine `AWS::Lambda::Permissions` Ressource, wenn dies angegeben `FunctionArn` ist. `AWS::Serverless::Api` Die `AWS::Lambda::Permissions` Ressource stellt Berechtigungen zwischen Ihrer API und der Autorisierungs-Lambda-Funktion bereit.
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `FunctionInvokeRole`   <a name="sam-api-lambdatokenauthorizer-functioninvokerole"></a>
Fügt der OpenApi Definition des Lambda-Autorisierers Autorisierer-Anmeldeinformationen hinzu.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. CloudFormation 

 `FunctionPayloadType`   <a name="sam-api-lambdatokenauthorizer-functionpayloadtype"></a>
Diese Eigenschaft kann verwendet werden, um den Typ des Lambda Authorizers für eine Api zu definieren.  
*Zulässige Werte*: `TOKEN` oder `REQUEST`.  
*Typ:* Zeichenfolge  
*Required*: No  
*Standardwert*: `TOKEN`  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig AWS SAM und hat kein CloudFormation Äquivalent.

 `Identity`   <a name="sam-api-lambdatokenauthorizer-identity"></a>
Diese Eigenschaft kann verwendet werden, um `IdentitySource` in einer eingehenden Anfrage einen Autorisierer anzugeben. Diese Eigenschaft ist nur erforderlich, wenn die `FunctionPayloadType` Eigenschaft auf `REQUEST` gesetzt ist.  
*Typ:* [LambdaTokenAuthorizationIdentity](sam-property-api-lambdatokenauthorizationidentity.md)  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-api-lambdatokenauthorizer--examples"></a>

### LambdaTokenAuth
<a name="sam-property-api-lambdatokenauthorizer--examples--lambdatokenauth"></a>

#### YAML
<a name="sam-property-api-lambdatokenauthorizer--examples--lambdatokenauth--yaml"></a>

```
Authorizers:
  MyLambdaTokenAuth:
    FunctionArn:
      Fn::GetAtt:
        - MyAuthFunction
        - Arn
    Identity:
      Header: MyCustomAuthHeader # OPTIONAL; Default: 'Authorization'
      ValidationExpression: mycustomauthexpression # OPTIONAL
      ReauthorizeEvery: 20 # OPTIONAL; Service Default: 300
```

### BasicLambdaTokenAuth
<a name="sam-property-api-lambdatokenauthorizer--examples--basiclambdatokenauth"></a>

#### YAML
<a name="sam-property-api-lambdatokenauthorizer--examples--basiclambdatokenauth--yaml"></a>

```
Authorizers:
  MyLambdaTokenAuth:
    FunctionArn:
      Fn::GetAtt:
        - MyAuthFunction
        - Arn
```

# LambdaTokenAuthorizationIdentity
<a name="sam-property-api-lambdatokenauthorizationidentity"></a>

Diese Eigenschaft kann verwendet werden, um IdentitySource in einer eingehenden Anfrage einen Autorisierer anzugeben. Weitere Informationen dazu finden IdentitySource Sie unter der [ApiGateway Authorizer-Erweiterung OpenApi ](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-authorizer.html).

## Syntax
<a name="sam-property-api-lambdatokenauthorizationidentity-syntax"></a>

 Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren. 

### YAML
<a name="sam-property-api-lambdatokenauthorizationidentity-syntax.yaml"></a>

```
  [Header](#sam-api-lambdatokenauthorizationidentity-header): String
  [ReauthorizeEvery](#sam-api-lambdatokenauthorizationidentity-reauthorizeevery): Integer
  [ValidationExpression](#sam-api-lambdatokenauthorizationidentity-validationexpression): String
```

## Eigenschaften
<a name="sam-property-api-lambdatokenauthorizationidentity-properties"></a>

 `Header`   <a name="sam-api-lambdatokenauthorizationidentity-header"></a>
Geben Sie den Header-Namen für Authorization in der OpenApi Definition an.  
*Typ:* Zeichenfolge  
*Required*: No  
*Standard*: Autorisierung  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `ReauthorizeEvery`   <a name="sam-api-lambdatokenauthorizationidentity-reauthorizeevery"></a>
Der Zeitraum time-to-live (TTL) in Sekunden, der angibt, wie lange API Gateway Autorisierungsergebnisse zwischenspeichert. Wenn Sie einen Wert größer als 0 festlegen, speichert API Gateway die Genehmigerantworten im Cache. Standardmäßig legt API Gateway diese Eigenschaft auf 300 fest. Der maximale Wert ist 3600, oder 1 Stunde.  
*Typ*: Ganzzahl  
*Required*: No  
*Standard: 300*  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `ValidationExpression`   <a name="sam-api-lambdatokenauthorizationidentity-validationexpression"></a>
Geben Sie einen Validierungsausdruck für die Validierung der eingehenden Identität an.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-api-lambdatokenauthorizationidentity--examples"></a>

### LambdaTokenIdentity
<a name="sam-property-api-lambdatokenauthorizationidentity--examples--lambdatokenidentity"></a>

#### YAML
<a name="sam-property-api-lambdatokenauthorizationidentity--examples--lambdatokenidentity--yaml"></a>

```
Identity:
  Header: MyCustomAuthHeader
  ValidationExpression: Bearer.*
  ReauthorizeEvery: 30
```

# ResourcePolicyStatement
<a name="sam-property-api-resourcepolicystatement"></a>

Konfiguriert eine Ressourcenrichtlinie für alle Methoden und Pfade einer API. Weitere Informationen zu Ressourcenrichtlinien finden Sie unter [Steuern des Zugriffs auf eine API mit API-Gateway-Ressourcenrichtlinien](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies.html) im *API Gateway Developer Guide*.

## Syntax
<a name="sam-property-api-resourcepolicystatement-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-api-resourcepolicystatement-syntax.yaml"></a>

```
  [AwsAccountBlacklist](#sam-api-resourcepolicystatement-awsaccountblacklist): List
  [AwsAccountWhitelist](#sam-api-resourcepolicystatement-awsaccountwhitelist): List
  [CustomStatements](#sam-api-resourcepolicystatement-customstatements): List
  [IntrinsicVpcBlacklist](#sam-api-resourcepolicystatement-intrinsicvpcblacklist): List
  [IntrinsicVpcWhitelist](#sam-api-resourcepolicystatement-intrinsicvpcwhitelist): List
  [IntrinsicVpceBlacklist](#sam-api-resourcepolicystatement-intrinsicvpceblacklist): List
  [IntrinsicVpceWhitelist](#sam-api-resourcepolicystatement-intrinsicvpcewhitelist): List
  [IpRangeBlacklist](#sam-api-resourcepolicystatement-iprangeblacklist): List
  [IpRangeWhitelist](#sam-api-resourcepolicystatement-iprangewhitelist): List
  [SourceVpcBlacklist](#sam-api-resourcepolicystatement-sourcevpcblacklist): List
  [SourceVpcWhitelist](#sam-api-resourcepolicystatement-sourcevpcwhitelist): List
```

## Eigenschaften
<a name="sam-property-api-resourcepolicystatement-properties"></a>

 `AwsAccountBlacklist`   <a name="sam-api-resourcepolicystatement-awsaccountblacklist"></a>
Die zu blockierenden AWS Konten.  
*Typ*: Liste von Zeichenfolgen  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig AWS SAM und hat kein CloudFormation Äquivalent.

 `AwsAccountWhitelist`   <a name="sam-api-resourcepolicystatement-awsaccountwhitelist"></a>
Die AWS Konten, die zugelassen werden sollen. Ein Beispiel für die Verwendung dieser Eigenschaft finden Sie im Abschnitt Beispiele unten auf dieser Seite.  
*Typ*: Liste von Zeichenfolgen  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `CustomStatements`   <a name="sam-api-resourcepolicystatement-customstatements"></a>
Eine Liste von benutzerdefinierten Ressourcenrichtlinien-Anweisungen, die auf diese API angewendet werden sollen. Ein Beispiel für die Verwendung dieser Eigenschaft finden Sie im Abschnitt Beispiele unten auf dieser Seite.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `IntrinsicVpcBlacklist`   <a name="sam-api-resourcepolicystatement-intrinsicvpcblacklist"></a>
Die Liste der zu blockierenden virtuellen privaten Clouds (VPCs), wobei jede VPC als Referenz angegeben ist, z. B. als [dynamische Referenz](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) oder als `Ref` [intrinsische Funktion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). Ein Beispiel für die Verwendung dieser Eigenschaft finden Sie im Abschnitt Beispiele unten auf dieser Seite.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `IntrinsicVpcWhitelist`   <a name="sam-api-resourcepolicystatement-intrinsicvpcwhitelist"></a>
Die Liste der VPCs Zulässigen, wobei jede VPC als Referenz angegeben wird, z. B. als [dynamische Referenz](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) oder als `Ref` [intrinsische Funktion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig AWS SAM und hat kein Äquivalent. CloudFormation 

 `IntrinsicVpceBlacklist`   <a name="sam-api-resourcepolicystatement-intrinsicvpceblacklist"></a>
[Die Liste der zu blockierenden VPC-Endpunkte, wobei jeder VPC-Endpunkt als Referenz angegeben ist, z. B. als [dynamische Referenz oder als intrinsische](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) Funktion. `Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. CloudFormation 

 `IntrinsicVpceWhitelist`   <a name="sam-api-resourcepolicystatement-intrinsicvpcewhitelist"></a>
[Die Liste der VPC-Endpunkte, die zugelassen werden sollen, wobei jeder VPC-Endpunkt als Referenz angegeben ist, z. B. als [dynamische Referenz](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) oder als systemeigene Funktion. `Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) Ein Beispiel für die Verwendung dieser Eigenschaft finden Sie im Abschnitt Beispiele unten auf dieser Seite.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `IpRangeBlacklist`   <a name="sam-api-resourcepolicystatement-iprangeblacklist"></a>
Die IP-Adressen oder Adressbereiche, die blockiert werden sollen. Ein Beispiel für die Verwendung dieser Eigenschaft finden Sie im Abschnitt Beispiele unten auf dieser Seite.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `IpRangeWhitelist`   <a name="sam-api-resourcepolicystatement-iprangewhitelist"></a>
Die IP-Adressen oder Adressbereiche, die zugelassen werden sollen.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `SourceVpcBlacklist`   <a name="sam-api-resourcepolicystatement-sourcevpcblacklist"></a>
Die Quell-VPC oder die VPC-Endpoints, die blockiert werden sollen. Quell-VPC-Namen müssen mit beginnen `"vpc-"` und Quell-VPC-Endpunktnamen müssen mit beginnen. `"vpce-"` Ein Beispiel für die Verwendung dieser Eigenschaft finden Sie im Abschnitt Beispiele unten auf dieser Seite.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `SourceVpcWhitelist`   <a name="sam-api-resourcepolicystatement-sourcevpcwhitelist"></a>
Die Quell-VPC oder VPC-Endpoints, die zugelassen werden sollen. Quell-VPC-Namen müssen mit beginnen `"vpc-"` und Quell-VPC-Endpunktnamen müssen mit beginnen. `"vpce-"`  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-api-resourcepolicystatement--examples"></a>

### Beispiel für eine Ressourcenrichtlinie
<a name="sam-property-api-resourcepolicystatement--examples--resource-policy-example"></a>

Das folgende Beispiel blockiert zwei IP-Adressen und eine Quell-VPC und lässt ein AWS Konto zu.

#### YAML
<a name="sam-property-api-resourcepolicystatement--examples--resource-policy-example--yaml"></a>

```
Auth:
  ResourcePolicy:
    CustomStatements: [{
                         "Effect": "Allow",
                         "Principal": "*",
                         "Action": "execute-api:Invoke",
                         "Resource": "execute-api:/Prod/GET/pets",
                         "Condition": {
                           "IpAddress": {
                             "aws:SourceIp": "1.2.3.4"
                           }
                         }
                       }]
    IpRangeBlacklist:
      - "10.20.30.40"
      - "1.2.3.4"
    SourceVpcBlacklist:
      - "vpce-1a2b3c4d"
    AwsAccountWhitelist:
      - "111122223333"
    IntrinsicVpcBlacklist:
      - "{{resolve:ssm:SomeVPCReference:1}}" 
      - !Ref MyVPC
    IntrinsicVpceWhitelist:
      - "{{resolve:ssm:SomeVPCEReference:1}}" 
      - !Ref MyVPCE
```

# ApiDefinition
<a name="sam-property-api-apidefinition"></a>

Ein OpenAPI-Dokument, das die API definiert.

## Syntax
<a name="sam-property-api-apidefinition-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-api-apidefinition-syntax.yaml"></a>

```
  [Bucket](#sam-api-apidefinition-bucket): String
  [Key](#sam-api-apidefinition-key): String
  [Version](#sam-api-apidefinition-version): String
```

## Eigenschaften
<a name="sam-property-api-apidefinition-properties"></a>

 `Bucket`   <a name="sam-api-apidefinition-bucket"></a>
Der Name des Amazon S3 S3-Buckets, in dem die OpenAPI-Datei gespeichert ist.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-bucket)` Eigenschaft des `AWS::ApiGateway::RestApi` `S3Location` Datentyps übergeben.

 `Key`   <a name="sam-api-apidefinition-key"></a>
Der Amazon S3 S3-Schlüssel der OpenAPI-Datei.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Key](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-key)` Eigenschaft des `AWS::ApiGateway::RestApi` `S3Location` Datentyps übergeben.

 `Version`   <a name="sam-api-apidefinition-version"></a>
Für versionierte Objekte die Version der OpenAPI-Datei.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Version](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-version)` Eigenschaft des `AWS::ApiGateway::RestApi` `S3Location` Datentyps übergeben.

## Beispiele
<a name="sam-property-api-apidefinition--examples"></a>

### Definition: Uri, Beispiel.
<a name="sam-property-api-apidefinition--examples--definition-uri-example"></a>

Beispiel für eine API-Definition

#### YAML
<a name="sam-property-api-apidefinition--examples--definition-uri-example--yaml"></a>

```
DefinitionUri:
  Bucket: amzn-s3-demo-bucket-name
  Key: mykey-name
  Version: 121212
```

# CorsConfiguration
<a name="sam-property-api-corsconfiguration"></a>

Verwalten Sie Cross-Origin Resource Sharing (CORS) für Ihr API Gateway. APIs Geben Sie die Domäne, die zugelassen werden soll, als Zeichenfolge an oder geben Sie ein Wörterbuch mit zusätzlicher Cors-Konfiguration an.

**Anmerkung**  
CORS erfordert eine AWS SAM Änderung Ihrer OpenAPI-Definition. Erstellen Sie eine Inline-OpenAPI-Definition in`DefinitionBody`, um CORS zu aktivieren. Wenn `CorsConfiguration` das in der OpenAPI-Definition und auch auf Eigenschaftsebene festgelegt ist, werden sie AWS SAM zusammengeführt. Die Eigenschaftsebene hat Vorrang vor der OpenAPI-Definition.

Weitere Informationen zu CORS finden Sie unter [Aktivieren von CORS für eine API-Gateway-REST-API-Ressource](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-cors.html) im *API Gateway Developer Guide*.

## Syntax
<a name="sam-property-api-corsconfiguration-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-api-corsconfiguration-syntax.yaml"></a>

```
  [AllowCredentials](#sam-api-corsconfiguration-allowcredentials): Boolean
  [AllowHeaders](#sam-api-corsconfiguration-allowheaders): String
  [AllowMethods](#sam-api-corsconfiguration-allowmethods): String
  [AllowOrigin](#sam-api-corsconfiguration-alloworigin): String
  [MaxAge](#sam-api-corsconfiguration-maxage): String
```

## Eigenschaften
<a name="sam-property-api-corsconfiguration-properties"></a>

 `AllowCredentials`   <a name="sam-api-corsconfiguration-allowcredentials"></a>
Boolescher Wert, der angibt, ob die Anfrage Anmeldeinformationen enthalten darf.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `AllowHeaders`   <a name="sam-api-corsconfiguration-allowheaders"></a>
Zeichenfolge von Headern, die zugelassen werden sollen.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `AllowMethods`   <a name="sam-api-corsconfiguration-allowmethods"></a>
Zeichenfolge, die die zuzulassenden HTTP-Methoden enthält.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `AllowOrigin`   <a name="sam-api-corsconfiguration-alloworigin"></a>
Quellzeichenfolge, die zugelassen werden soll. Dies kann eine durch Kommas getrennte Liste im Zeichenkettenformat sein.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `MaxAge`   <a name="sam-api-corsconfiguration-maxage"></a>
Zeichenfolge, die die Anzahl der Sekunden enthält, um die CORS-Preflight-Anfrage zwischenzuspeichern.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-api-corsconfiguration--examples"></a>

### CorsConfiguration
<a name="sam-property-api-corsconfiguration--examples--corsconfiguration"></a>

Beispiel für eine CORS-Konfiguration. Dies ist nur ein Teil einer AWS SAM Vorlagendatei, die eine [AWS::Serverless::Api](sam-resource-api.md) Definition mit konfiguriertem CORS und einem zeigt. [AWS::Serverless::Function](sam-resource-function.md) Wenn Sie eine Lambda-Proxyintegration oder eine HTTP-Proxyintegration verwenden, muss Ihr Backend die Header `Access-Control-Allow-Origin``Access-Control-Allow-Methods`, und `Access-Control-Allow-Headers` zurückgeben.

#### YAML
<a name="sam-property-api-corsconfiguration--examples--corsconfiguration--yaml"></a>

```
Resources:
  ApiGatewayApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      Cors:
        AllowMethods: "'POST, GET'"
        AllowHeaders: "'X-Forwarded-For'"
        AllowOrigin: "'https://example.com'"
        MaxAge: "'600'"
        AllowCredentials: true
  ApiFunction: # Adds a GET method at the root resource via an Api event
    Type: AWS::Serverless::Function
    Properties:
      Events:
        ApiEvent:
          Type: Api
          Properties:
            Path: /
            Method: get
            RestApiId:
              Ref: ApiGatewayApi
      Runtime: python3.10
      Handler: index.handler
      InlineCode: |
        import json
        def handler(event, context):
          return {
          'statusCode': 200,
          'headers': {
            'Access-Control-Allow-Headers': 'Content-Type',
            'Access-Control-Allow-Origin': 'https://example.com',
            'Access-Control-Allow-Methods': 'POST, GET'
            },
          'body': json.dumps('Hello from Lambda!')
          }
```

# DomainConfiguration
<a name="sam-property-api-domainconfiguration"></a>

Konfiguriert eine benutzerdefinierte Domain für eine API.

## Syntax
<a name="sam-property-api-domainconfiguration-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-api-domainconfiguration-syntax.yaml"></a>

```
  [AccessAssociation](#sam-api-domainconfiguration-domainaccessassociation): DomainAccessAssociation
  [BasePath](#sam-api-domainconfiguration-basepath): List
  [CertificateArn](#sam-api-domainconfiguration-certificatearn): String
  [DomainName](#sam-api-domainconfiguration-domainname): String
  [EndpointConfiguration](#sam-api-domainconfiguration-endpointconfiguration): String
  [MutualTlsAuthentication](#sam-api-domainconfiguration-mutualtlsauthentication): [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication)
  [NormalizeBasePath](#sam-api-domainconfiguration-normalizebasepath): Boolean
  [OwnershipVerificationCertificateArn](#sam-api-domainconfiguration-ownershipverificationcertificatearn): String
  [Policy: ](#sam-api-domainconfiguration-policy)Json
  [Route53](#sam-api-domainconfiguration-route53): Route53Configuration
  [SecurityPolicy](#sam-api-domainconfiguration-securitypolicy): String
```

## Eigenschaften
<a name="sam-property-api-domainconfiguration-properties"></a>

 `AccessAssociation`   <a name="sam-api-domainconfiguration-domainaccessassociation"></a>
Die Konfiguration, die zum Generieren der ` AWS::ApiGateway::DomainNameAccessAssociation` Ressource erforderlich ist.  
AWS SAM generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html)Ressource, wenn diese Eigenschaft festgelegt ist. Hinweise zu generierten CloudFormation Ressourcen finden Sie unter[Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md).  
*Typ:* [DomainAccessAssociation](sam-property-api-domainaccessassociation.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `BasePath`   <a name="sam-api-domainconfiguration-basepath"></a>
Eine Liste der Basepfade, die mit dem Amazon API Gateway Gateway-Domänennamen konfiguriert werden sollen.  
*Typ*: Liste  
*Required*: No  
*Standard:/*  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[BasePath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath)` Eigenschaft einer `AWS::ApiGateway::BasePathMapping` Ressource. AWS SAM erstellt mehrere `AWS::ApiGateway::BasePathMapping` Ressourcen, eine pro, die in dieser Eigenschaft `BasePath` angegeben ist.

 `CertificateArn`   <a name="sam-api-domainconfiguration-certificatearn"></a>
Der Amazon-Ressourcenname (ARN) eines AWS verwalteten Zertifikats, der Endpunkt dieses Domainnamens. AWS Certificate Manager ist die einzige unterstützte Quelle.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[CertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn)` Eigenschaft einer `AWS::ApiGateway::DomainName` Ressource. Wenn auf `REGIONAL` (der Standardwert) gesetzt `EndpointConfiguration` ist, `CertificateArn` wird [RegionalCertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn)in zugeordnet`AWS::ApiGateway::DomainName`. Wenn der auf gesetzt `EndpointConfiguration` ist`EDGE`, `CertificateArn` wird [CertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn)in zugeordnet`AWS::ApiGateway::DomainName`. Wenn auf gesetzt `EndpointConfiguration` ist`PRIVATE`, wird diese Eigenschaft an die [AWS::ApiGateway::DomainNameV2-Ressource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2) übergeben.  
*Zusätzliche Hinweise*: Für einen `EDGE` Endpunkt müssen Sie das Zertifikat in der `us-east-1` AWS Region erstellen.

 `DomainName`   <a name="sam-api-domainconfiguration-domainname"></a>
Der benutzerdefinierte Domainname für Ihre API-Gateway-API. Großbuchstaben werden nicht unterstützt.  
AWS SAM generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html)Ressource, wenn diese Eigenschaft festgelegt ist. Hinweise zu diesem Szenario finden Sie unter[DomainName Eigenschaft ist angegeben](sam-specification-generated-resources-api.md#sam-specification-generated-resources-api-domain-name). Hinweise zu generierten CloudFormation Ressourcen finden Sie unter[Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md).  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname)` Eigenschaft einer `AWS::ApiGateway::DomainName` Ressource übergeben, oder an [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2)when, auf gesetzt EndpointConfiguration ist`PRIVATE`.

 `EndpointConfiguration`   <a name="sam-api-domainconfiguration-endpointconfiguration"></a>
Definiert den Typ des API-Gateway-Endpunkts, der der benutzerdefinierten Domain zugeordnet werden soll. Der Wert dieser Eigenschaft bestimmt, wie die `CertificateArn` Eigenschaft zugeordnet wird. CloudFormation  
*Gültige Werte*: `EDGE`, `REGIONAL`, oder `PRIVATE`  
*Typ:* Zeichenfolge  
*Required*: No  
*Standardwert*: `REGIONAL`  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `MutualTlsAuthentication`   <a name="sam-api-domainconfiguration-mutualtlsauthentication"></a>
Die TLS-Authentifizierungskonfiguration (Mutual Transport Layer Security) für einen benutzerdefinierten Domainnamen.  
*Typ:* [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication)` Eigenschaft einer `AWS::ApiGateway::DomainName` Ressource übergeben.

 `NormalizeBasePath`   <a name="sam-api-domainconfiguration-normalizebasepath"></a>
Gibt an, ob nicht-alphanumerische Zeichen in den durch die Eigenschaft definierten Basepfaden zulässig sind. `BasePath` Wenn auf gesetzt, werden nicht-alphanumerische Zeichen aus `True` Basepfaden entfernt.  
Wird zusammen mit der Eigenschaft verwendet. `NormalizeBasePath` `BasePath`  
*Typ*: Boolesch  
*Required*: No  
*Standard*: Wahr  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `OwnershipVerificationCertificateArn`   <a name="sam-api-domainconfiguration-ownershipverificationcertificatearn"></a>
Die ARN des öffentlichen Zertifikats, das von ACM ausgestellt wurde, um den Besitz Ihrer benutzerdefinierten Domain zu überprüfen. Nur erforderlich, wenn Sie Mutual TLS konfigurieren und einen von ACM importierten oder privaten CA-Zertifikat-ARN für angeben. `CertificateArn`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[OwnershipVerificationCertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-ownershipverificationcertificatearn)` Eigenschaft einer `AWS::ApiGateway::DomainName` Ressource übergeben.

 `Policy`   <a name="sam-api-domainconfiguration-policy"></a>
Die IAM-Richtlinie, die an den API-Gateway-Domänennamen angehängt werden soll. Gilt nur, wenn auf `PRIVATE` eingestellt `EndpointConfiguration` ist.  
*Type*: Json  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `Policy` Eigenschaft einer `AWS::ApiGateway::DomainNameV2` Ressource übergeben, wenn sie auf gesetzt `EndpointConfiguration` ist`PRIVATE`. Beispiele für gültige Richtliniendokumente finden Sie unter [AWS::ApiGateway::DomainNameV2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2).

 `Route53`   <a name="sam-api-domainconfiguration-route53"></a>
Definiert eine Amazon Route 53-Konfiguration.  
*Typ*: [Route53-Konfiguration](sam-property-api-route53configuration.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. CloudFormation 

 `SecurityPolicy`   <a name="sam-api-domainconfiguration-securitypolicy"></a>
Die TLS-Version plus die Cipher Suite für diesen Domainnamen.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[SecurityPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy)` Eigenschaft einer `AWS::ApiGateway::DomainName` Ressource übergeben, oder an [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2)when `EndpointConfiguration` ist auf gesetzt. `PRIVATE` Für `PRIVATE` Endgeräte wird nur TLS\$11\$12 unterstützt.

## Beispiele
<a name="sam-property-api-domainconfiguration--examples"></a>

### DomainName
<a name="sam-property-api-domainconfiguration--examples--domainname"></a>

DomainName Beispiel

#### YAML
<a name="sam-property-api-domainconfiguration--examples--domainname--yaml"></a>

```
Domain:
  DomainName: www.example.com
  CertificateArn: arn-example
  EndpointConfiguration: EDGE
  Route53:
    HostedZoneId: Z1PA6795UKMFR9
  BasePath:
    - foo
    - bar
```

# DomainAccessAssociation
<a name="sam-property-api-domainaccessassociation"></a>

Konfiguriert eine Domänenzugriffszuordnung zwischen einer Zugriffszuordnungsquelle und einem privaten benutzerdefinierten Domänennamen. Die einzige unterstützte Quelle für die Zugriffszuweisung ist eine VPC-Endpunkt-ID. Weitere Informationen finden Sie unter [Benutzerdefinierte Domainnamen für private APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html).

## Syntax
<a name="sam-property-api-domainaccessassociation-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-api-domainaccessassociation-syntax.yaml"></a>

```
 VpcEndpointId: String
```

## Eigenschaften
<a name="sam-property-api-domainaccessassociation-properties"></a>

 `VpcEndpointId`   <a name="sam-api-domainaccessassociation-vpcendpointid"></a>
Die Endpunkt-ID des VPC-Schnittstellenendpunkts, der dem API Gateway VPC-Dienst zugeordnet ist.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ AccessAssociationSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html#cfn-apigateway-domainnameaccessassociation-accessassociationsource)` Eigenschaft einer `AWS::ApiGateway::DomainNameAccessAssociation` Ressource übergeben.

# Route53Configuration
<a name="sam-property-api-route53configuration"></a>

Konfiguriert die Route53-Datensätze für eine API.

## Syntax
<a name="sam-property-api-route53configuration-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS Serverless Application Model (AWS SAM) -Vorlage zu deklarieren.

### YAML
<a name="sam-property-api-route53configuration-syntax.yaml"></a>

```
  [DistributionDomainName](#sam-api-route53configuration-distributiondomainname): String
  [EvaluateTargetHealth](#sam-api-route53configuration-evaluatetargethealth): Boolean
  [HostedZoneId](#sam-api-route53configuration-hostedzoneid): String
  [HostedZoneName](#sam-api-route53configuration-hostedzonename): String
  [IpV6](#sam-api-route53configuration-ipv6): Boolean
  Region: String
  SetIdentifier: String
  VpcEndpointDomainName: String
  VpcEndpointHostedZoneId: String
```

## Eigenschaften
<a name="sam-property-api-route53configuration-properties"></a>

 `DistributionDomainName`   <a name="sam-api-route53configuration-distributiondomainname"></a>
Konfiguriert eine benutzerdefinierte Verteilung des benutzerdefinierten API-Domänennamens.  
*Typ:* Zeichenfolge  
*Required*: No  
*Standard*: Verwenden Sie die API Gateway Gateway-Distribution.  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[DNSName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget-1.html#cfn-route53-aliastarget-dnshostname)` Eigenschaft einer `AWS::Route53::RecordSetGroup AliasTarget` Ressource übergeben.  
*Zusätzliche Hinweise*: Der Domainname einer [CloudFrontDistribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html).

 `EvaluateTargetHealth`   <a name="sam-api-route53configuration-evaluatetargethealth"></a>
Wenn EvaluateTargetHealth wahr, erbt ein Aliaseintrag den Zustand der referenzierten AWS Ressource, z. B. eines Elastic Load Balancing Balancing-Load Balancers oder eines anderen Datensatzes in der Hosting-Zone.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[EvaluateTargetHealth](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth)` Eigenschaft einer `AWS::Route53::RecordSetGroup AliasTarget` Ressource übergeben.  
*Zusätzliche Hinweise*: Sie können den Wert nicht auf „true“ EvaluateTargetHealth setzen, wenn es sich bei dem Alias-Ziel um eine CloudFront Distribution handelt.

 `HostedZoneId`   <a name="sam-api-route53configuration-hostedzoneid"></a>
Die ID der gehosteten Zone, in der Sie Datensätze erstellen möchten.  
Geben Sie `HostedZoneName` oder `HostedZoneId` an, jedoch nicht beides. Wenn Sie mehrere gehostete Zonen mit dem gleichen Domainnamen haben, müssen Sie die gehostete Zone mit der `HostedZoneId` angeben.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[HostedZoneId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-hostedzoneid)` Eigenschaft einer `AWS::Route53::RecordSetGroup RecordSet` Ressource übergeben.

 `HostedZoneName`   <a name="sam-api-route53configuration-hostedzonename"></a>
Der Name der gehosteten Zone, in der Sie Datensätze erstellen möchten.  
Geben Sie `HostedZoneName` oder `HostedZoneId` an, jedoch nicht beides. Wenn Sie mehrere gehostete Zonen mit dem gleichen Domainnamen haben, müssen Sie die gehostete Zone mit der `HostedZoneId` angeben.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[HostedZoneName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-hostedzonename)` Eigenschaft einer `AWS::Route53::RecordSetGroup RecordSet` Ressource übergeben.

 `IpV6`   <a name="sam-api-route53configuration-ipv6"></a>
Wenn diese Eigenschaft gesetzt ist, wird eine `AWS::Route53::RecordSet` Ressource AWS SAM erstellt und [Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type) `AAAA` für die angegebene Ressource auf gesetzt HostedZone.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

`Region`  <a name="sam-api-route53configuration-region"></a>
*Nur latenzbasierte Ressourcendatensätze:* Die EC2 Amazon-Region, in der Sie die Ressource erstellt haben, auf die sich dieser Ressourcendatensatz bezieht. Bei der Ressource handelt es sich in der Regel um eine AWS Ressource, z. B. eine EC2 Instance oder einen ELB-Load Balancer, auf die je nach Datensatztyp mit einer IP-Adresse oder einem DNS-Domainnamen verwiesen wird.  
Wenn Amazon Route 53 eine DNS-Abfrage für einen Domainnamen und einen Domain-Typ empfängt, für den Sie Latenzressourcendatensätze erstellt haben, wählt Route 53 den Latenzressourcendatensatz aus, der die niedrigste Latenz zwischen dem Endbenutzer und der zugehörigen EC2 Amazon-Region aufweist. Route 53 gibt dann den Wert zurück, der dem ausgewählten Ressourcendatensatz zugeordnet ist.  
Beachten Sie Folgendes:  
+ Sie können nur einen `ResourceRecord` pro Latenz-Ressourcendatensatz angeben.
+ Sie können nur einen Latenzressourcendatensatz für jede EC2 Amazon-Region erstellen.
+ Sie müssen keine Latenzressourcendatensätze für alle EC2 Amazon-Regionen erstellen. Route 53 wählt die Region mit der besten Latenz aus den Regionen aus, für die Sie Latenz-Ressourcendatensätze erstellen.
+ Sie können keine Nicht-Latenz-Ressourcendatensätze erstellen, die die gleichen Werte für die Elemente `Name` und `Type` haben wie Latenz-Ressourcendatensätze.
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ Region](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-region)` Eigenschaft eines `AWS::Route53::RecordSetGroup` `RecordSet` Datentyps übergeben.

`SetIdentifier`  <a name="sam-api-route53configuration-setidentifier"></a>
*Ressourcendatensätze, die eine andere Routing-Richtlinie als "einfach" haben:* Ein Bezeichner, der zwischen mehreren Ressourcendatensätzen unterscheidet, die die gleiche Kombination aus Name und Typ haben, wie beispielsweise mehrere gewichtete Ressourcendatensätze namens acme.example.com, die einen Typ A haben. In einer Gruppe von Ressourcendatensätzen, die den gleichen Namen und Typ haben, muss der Wert von `SetIdentifier` für jeden Ressourcen-Datensatz eindeutig sein.  
Informationen zu Routing-Richtlinien finden Sie unter [Auswahl einer Routing-Richtlinie](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) im *Amazon Route 53-Entwicklerhandbuch*.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ SetIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-setidentifier)` Eigenschaft eines `AWS::Route53::RecordSetGroup` `RecordSet` Datentyps übergeben.

`VpcEndpointDomainName`  <a name="sam-api-route53configuration-vpcendpointdomainname"></a>
Ein DNS-Name des VPC-Schnittstellenendpunkts, der dem API Gateway VPC-Dienst zugeordnet ist. Diese Eigenschaft ist nur für private Domänen erforderlich.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[DNSName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-aliastarget.html)` Eigenschaft eines `AWS::Route53::RecordSet` `AliasTarget` Feldes übergeben.

`VpcEndpointHostedZoneId`  <a name="sam-api-route53configuration-vpcendpointhostedzoneid"></a>
Die Hosting-Zonen-ID des VPC-Schnittstellenendpunkts, der dem API Gateway VPC-Dienst zugeordnet ist. Diese Eigenschaft ist nur für private Domänen erforderlich.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[HostedZoneId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-aliastarget.html)` Eigenschaft eines `AWS::Route53::RecordSet` `AliasTarget` Feldes übergeben.

## Beispiele
<a name="sam-property-api-route53configuration--examples"></a>

### Einfaches Beispiel
<a name="sam-property-api-route53configuration--examples--route-53-configuration-example"></a>

In diesem Beispiel konfigurieren wir eine benutzerdefinierte Domain und Route 53-Datensätze für unsere API.

#### YAML
<a name="sam-property-api-route53configuration--examples--route-53-configuration-example--yaml"></a>

```
Resources:
  MyApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      Domain:
        DomainName: www.example.com
        CertificateArn: arn:aws:acm:us-east-1:123456789012:certificate/abcdef12-3456-7890-abcd-ef1234567890
        EndpointConfiguration: REGIONAL
        Route53:
          HostedZoneId: ABCDEFGHIJKLMNOP
```

# EndpointConfiguration
<a name="sam-property-api-endpointconfiguration"></a>

Der Endpunkttyp einer REST-API.

## Syntax
<a name="sam-property-api-endpointconfiguration-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-api-endpointconfiguration-syntax.yaml"></a>

```
  [IpAddressType](#sam-api-endpointconfiguration-ipaddresstype): String
  [Type](#sam-api-endpointconfiguration-type): String
  [VPCEndpointIds](#sam-api-endpointconfiguration-vpcendpointids): List
```

## Eigenschaften
<a name="sam-property-api-endpointconfiguration-properties"></a>

 `IpAddressType`   <a name="sam-api-endpointconfiguration-ipaddresstype"></a>
Die IP-Adresstypen, die eine API (RestApi) aufrufen können.  
*Zulässige Werte*: `ipv4` oder `dualstack`.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[IpAddressType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-ipaddresstype)` Eigenschaft des `AWS::ApiGateway::RestApi` `EndpointConfiguration` Datentyps übergeben.

 `Type`   <a name="sam-api-endpointconfiguration-type"></a>
Der Endpunkttyp einer REST-API.  
*Gültige Werte*: `EDGE` oder `REGIONAL` oder `PRIVATE`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Types](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-types)` Eigenschaft des `AWS::ApiGateway::RestApi` `EndpointConfiguration` Datentyps übergeben.

 `VPCEndpointIds`   <a name="sam-api-endpointconfiguration-vpcendpointids"></a>
Eine Liste der VPC-Endpunkte IDs einer REST-API, für die Route53-Aliase erstellt werden sollen.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[VpcEndpointIds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-vpcendpointids)` Eigenschaft des Datentyps übergeben. `AWS::ApiGateway::RestApi` `EndpointConfiguration`

## Beispiele
<a name="sam-property-api-endpointconfiguration--examples"></a>

### EndpointConfiguration
<a name="sam-property-api-endpointconfiguration--examples--endpointconfiguration"></a>

Beispiel für eine Endpunktkonfiguration

#### YAML
<a name="sam-property-api-endpointconfiguration--examples--endpointconfiguration--yaml"></a>

```
EndpointConfiguration:
  Type: PRIVATE
  VPCEndpointIds:
    - vpce-123a123a
    - vpce-321a321a
```

# AWS::Serverless::Application
<a name="sam-resource-application"></a>

Bettet eine serverlose Anwendung aus dem [AWS Serverless Application Repository](https://serverlessrepo.aws.amazon.com/applications)oder aus einem Amazon S3 S3-Bucket als verschachtelte Anwendung ein. Verschachtelte Anwendungen werden als verschachtelte [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html)Ressourcen bereitgestellt, die mehrere andere Ressourcen, einschließlich anderer Ressourcen, enthalten können. [AWS::Serverless::Application](#sam-resource-application)

**Anmerkung**  
Bei der Bereitstellung auf werden AWS CloudFormation Ihre AWS SAM Ressourcen in AWS SAM Ressourcen umgewandelt. CloudFormation Weitere Informationen finden Sie unter [Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md).

## Syntax
<a name="sam-resource-application-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-resource-application-syntax.yaml"></a>

```
Type: AWS::Serverless::Application
Properties:
  [Location](#sam-application-location): String | ApplicationLocationObject
  [NotificationARNs](#sam-application-notificationarns): List
  [Parameters](#sam-application-parameters): Map
  [Tags](#sam-application-tags): Map
  [TimeoutInMinutes](#sam-application-timeoutinminutes): Integer
```

## Eigenschaften
<a name="sam-resource-application-properties"></a>

 `Location`   <a name="sam-application-location"></a>
Vorlagen-URL, Dateipfad oder Standortobjekt einer verschachtelten Anwendung.  
Wenn eine Vorlagen-URL bereitgestellt wird, muss sie dem in der [CloudFormation TemplateUrl Dokumentation angegebenen Format entsprechen](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-templateurl) und eine gültige CloudFormation SAM-Vorlage enthalten. An [ApplicationLocationObject](sam-property-application-applicationlocationobject.md) kann verwendet werden, um eine Anwendung anzugeben, die auf der veröffentlicht wurde [AWS Serverless Application Repository](https://docs.aws.amazon.com/serverlessrepo/latest/devguide/what-is-serverlessrepo.html).  
Wenn ein lokaler Dateipfad angegeben wird, muss die Vorlage den Workflow durchlaufen, der den `sam package` Befehl `sam deploy` oder enthält, damit die Anwendung ordnungsgemäß transformiert werden kann.  
*Typ*: Zeichenfolge \$1 [ApplicationLocationObject](sam-property-application-applicationlocationobject.md)  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[TemplateURL](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-templateurl)` Eigenschaft einer `AWS::CloudFormation::Stack` Ressource. Die CloudFormation Version benötigt keine Zeit[ApplicationLocationObject](sam-property-application-applicationlocationobject.md), um eine Anwendung von der abzurufen AWS Serverless Application Repository.

 `NotificationARNs`   <a name="sam-application-notificationarns"></a>
Eine Liste vorhandener Amazon SNS SNS-Themen, an die Benachrichtigungen über Stack-Ereignisse gesendet werden.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[NotificationARNs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-notificationarns)` Eigenschaft einer `AWS::CloudFormation::Stack` Ressource übergeben.

 `Parameters`   <a name="sam-application-parameters"></a>
Werte der Anwendungsparameter.  
*Typ*: Karte  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Parameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-parameters)` Eigenschaft einer `AWS::CloudFormation::Stack` Ressource übergeben.

 `Tags`   <a name="sam-application-tags"></a>
Eine Zuordnung (Zeichenfolge zu Zeichenfolge), die die Tags angibt, die dieser Anwendung hinzugefügt werden sollen. Schlüssel und Werte sind auf alphanumerische Zeichen beschränkt. Schlüssel können 1 bis 127 Unicode-Zeichen lang sein und ihnen darf nicht das Präfix aws: vorangestellt werden. Werte können 1 bis 255 Unicode-Zeichen lang sein.  
*Typ*: Karte  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-tags)` Eigenschaft einer `AWS::CloudFormation::Stack` Ressource. Die Tags-Eigenschaft in SAM besteht aus Key:Value-Paaren; darin besteht CloudFormation sie aus einer Liste von Tag-Objekten. Wenn der Stack erstellt ist, fügt SAM dieser Anwendung automatisch ein `lambda:createdBy:SAM` Tag hinzu. Wenn diese Anwendung aus dem stammt AWS Serverless Application Repository, dann wird SAM außerdem automatisch die beiden zusätzlichen Tags `serverlessrepo:applicationId:ApplicationId` und`serverlessrepo:semanticVersion:SemanticVersion`.

 `TimeoutInMinutes`   <a name="sam-application-timeoutinminutes"></a>
Die Zeitspanne in Minuten, die darauf CloudFormation wartet, dass der verschachtelte Stapel den `CREATE_COMPLETE` Status erreicht. Standardmäßig gibt es keine Zeitüberschreitung. Wenn CloudFormation erkannt wird, dass der verschachtelte Stapel den `CREATE_COMPLETE` Status erreicht hat, markiert es die Ressource des verschachtelten Stacks als `CREATE_COMPLETE` im übergeordneten Stapel und setzt die Erstellung des übergeordneten Stacks fort. Wenn der Timeout-Zeitraum abläuft, bevor der verschachtelte Stack den Wert erreicht`CREATE_COMPLETE`, wird der verschachtelte Stack als ausgefallen CloudFormation markiert und sowohl der verschachtelte Stack als auch der übergeordnete Stack zurückgesetzt.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[TimeoutInMinutes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html#cfn-cloudformation-stack-timeoutinminutes)` Eigenschaft einer Ressource übergeben. `AWS::CloudFormation::Stack`

## Rückgabewerte
<a name="sam-resource-application-return-values"></a>

### Punkt
<a name="sam-resource-application-return-values-ref"></a>

Wenn die logische ID dieser Ressource der `Ref` systemeigenen Funktion zur Verfügung gestellt wird, gibt sie den Ressourcennamen der zugrunde liegenden `AWS::CloudFormation::Stack` Ressource zurück.

Weitere Informationen zur Verwendung der `Ref` Funktion finden Sie [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)im *AWS CloudFormation Benutzerhandbuch*. 

### Fn:: GetAtt
<a name="sam-resource-application-return-values-fn--getatt"></a>

`Fn::GetAtt` gibt einen Wert für ein angegebenes Attribut dieses Typs zurück. Im Folgenden sehen Sie die verfügbaren Attribute und Beispielrückgabewerte. 

Weitere Informationen zur Verwendung `Fn::GetAtt` finden Sie [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html)im *AWS CloudFormation Benutzerhandbuch*. 

`Outputs.ApplicationOutputName`  <a name="Outputs.ApplicationOutputName-fn::getatt"></a>
Der Wert der Stack-Ausgabe mit dem Namen`ApplicationOutputName`.

## Beispiele
<a name="sam-resource-application--examples"></a>

### SAR-Anwendung
<a name="sam-resource-application--examples--sar-application"></a>

Anwendung, die eine Vorlage aus dem Serverless Application Repository verwendet

#### YAML
<a name="sam-resource-application--examples--sar-application--yaml"></a>

```
Type: AWS::Serverless::Application
Properties:
  Location:
    ApplicationId: 'arn:aws:serverlessrepo:us-east-1:012345678901:applications/my-application'
    SemanticVersion: 1.0.0
  Parameters:
    StringParameter: parameter-value
    IntegerParameter: 2
```

### Normale Anwendung
<a name="sam-resource-application--examples--normal-application"></a>

Anwendung von einer S3-URL

#### YAML
<a name="sam-resource-application--examples--normal-application--yaml"></a>

```
Type: AWS::Serverless::Application
Properties:
  Location: https://s3.amazonaws.com/sam-s3-demo-bucket/template.yaml
```

# ApplicationLocationObject
<a name="sam-property-application-applicationlocationobject"></a>

Eine Anwendung, die auf dem veröffentlicht wurde [AWS Serverless Application Repository](https://docs.aws.amazon.com/serverlessrepo/latest/devguide/what-is-serverlessrepo.html).

## Syntax
<a name="sam-property-application-applicationlocationobject-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-application-applicationlocationobject-syntax.yaml"></a>

```
  [ApplicationId](#sam-application-applicationlocationobject-applicationid): String
  [SemanticVersion](#sam-application-applicationlocationobject-semanticversion): String
```

## Eigenschaften
<a name="sam-property-application-applicationlocationobject-properties"></a>

 `ApplicationId`   <a name="sam-application-applicationlocationobject-applicationid"></a>
Der Amazon-Ressourcenname (ARN) der Anwendung.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `SemanticVersion`   <a name="sam-application-applicationlocationobject-semanticversion"></a>
Die semantische Version der Anwendung.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-application-applicationlocationobject--examples"></a>

### meine Anwendung
<a name="sam-property-application-applicationlocationobject--examples--my-application"></a>

Beispiel für ein Objekt für den Speicherort einer Anwendung

#### YAML
<a name="sam-property-application-applicationlocationobject--examples--my-application--yaml"></a>

```
Location:
  ApplicationId: 'arn:aws:serverlessrepo:us-east-1:012345678901:applications/my-application'
  SemanticVersion: 1.0.0
```

# AWS::Serverless::CapacityProvider
<a name="sam-resource-capacityprovider"></a>

 Erstellt einen Kapazitätsanbieter für AWS Lambda Funktionen, der die Ausführung von Lambda Managed Instances auf kundeneigenen Amazon Elastic Compute Cloud-Instances ermöglicht. Diese Ressource ist Teil der Lambda Managed Instances-Funktion, die mithilfe von EC2 Amazon-Preismodellen eine Kostenoptimierung für umfangreiche Lambda-Workloads ermöglicht. 

 Der Kapazitätsanbieter verwaltet den Lebenszyklus von EC2 Amazon-Instances und stellt die erforderliche Infrastruktur bereit, damit Lambda-Funktionen auf kundeneigenen Rechenressourcen ausgeführt werden können, während das serverlose Programmiermodell beibehalten wird. 

**Anmerkung**  
Bei der Bereitstellung auf werden Ihre AWS CloudFormation AWS SAM Ressourcen in AWS SAM Ressourcen umgewandelt. CloudFormation Weitere Informationen finden Sie unter [Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md). 

## Syntax
<a name="sam-resource-capacityprovider-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS Serverless Application Model (AWS SAM) -Vorlage zu deklarieren.

### YAML
<a name="sam-resource-capacityprovider-syntax.yaml"></a>

```
Type: AWS::Serverless::CapacityProvider
Properties:
  [CapacityProviderName](#sam-capacityprovider-capacityprovidername): String
  [VpcConfig](#sam-capacityprovider-vpcconfig): VpcConfig
  [OperatorRole](#sam-capacityprovider-operatorrole): String
  [Tags](#sam-capacityprovider-tags): Map
  [PropagateTags](#sam-capacityprovider-propagatetags): Boolean
  [InstanceRequirements](#sam-capacityprovider-instancerequirements): InstanceRequirements
  [ScalingConfig](#sam-capacityprovider-scalingconfig): ScalingConfig
  [KmsKeyArn](#sam-capacityprovider-kmskeyarn): String
```

## Eigenschaften
<a name="sam-resource-capacityprovider-properties"></a>

 `CapacityProviderName`   <a name="sam-capacityprovider-capacityprovidername"></a>
Der Name des Kapazitätsanbieters. Dieser Name muss innerhalb Ihres AWS Kontos und Ihrer Region eindeutig sein.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[CapacityProviderName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-capacityprovidername)` Eigenschaft einer `AWS::Lambda::CapacityProvider` Ressource übergeben. 

 `VpcConfig`   <a name="sam-capacityprovider-vpcconfig"></a>
Die VPC-Konfiguration für den Kapazitätsanbieter. Gibt die VPC-Subnetze und Sicherheitsgruppen an, in denen EC2 Amazon-Instances gestartet werden.  
*Typ:* [VpcConfig](sam-property-capacityprovider-vpcconfig.md)  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-vpcconfig)` Eigenschaft einer `AWS::Lambda::CapacityProvider` Ressource übergeben. 

 `OperatorRole`   <a name="sam-capacityprovider-operatorrole"></a>
 Der ARN der Operator-Rolle für Lambda mit Berechtigungen zum Erstellen und Verwalten von EC2 Amazon-Instances und zugehörigen Ressourcen im Kundenkonto. Falls nicht angegeben, AWS SAM wird automatisch eine Rolle mit den erforderlichen Berechtigungen generiert.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[CapacityProviderOperatorRoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityproviderpermissionsconfig.html#cfn-lambda-capacityprovider-capacityproviderpermissionsconfig-capacityprovideroperatorrolearn)` Eigenschaft `[PermissionsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-permissionsconfig)` einer `AWS::Lambda::CapacityProvider` Ressource übergeben. 

 `Tags`   <a name="sam-capacityprovider-tags"></a>
Eine Zuordnung von Schlüssel-Wert-Paaren, die auf den Kapazitätsanbieter und die zugehörigen Ressourcen angewendet werden sollen.  
*Typ: Karte*  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-tags)` Eigenschaft einer `AWS::Lambda::CapacityProvider` Ressource übergeben. Die `Tags` Eigenschaft in AWS SAM besteht aus Schlüssel-Wert-Paaren (wohingegen CloudFormation diese Eigenschaft aus einer Liste von Tag-Objekten besteht). Fügt dieser Lambda-Funktion und den für diese Funktion generierten Standardrollen außerdem AWS SAM automatisch ein `lambda:createdBy:SAM` Tag hinzu. 

 `PropagateTags`   <a name="sam-capacityprovider-propagatetags"></a>
 Gibt an, ob Tags aus der Tags-Eigenschaft an Ihre `AWS::Serverless::CapacityProvider` generierten Ressourcen übergeben werden sollen oder nicht. Stellen Sie dies auf ein`True`, um Tags in Ihren generierten Ressourcen zu verbreiten.   
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `InstanceRequirements`   <a name="sam-capacityprovider-instancerequirements"></a>
 Spezifikationen für die Typen von Recheninstanzen, die der Kapazitätsanbieter verwenden kann. Dazu gehören Architekturanforderungen `allowed` und/oder `excluded` Instanztypen.  
*Typ:* [InstanceRequirements](sam-property-capacityprovider-instancerequirements.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[InstanceRequirements](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-instancerequirements)` Eigenschaft einer `AWS::Lambda::CapacityProvider` Ressource übergeben. 

 `ScalingConfig`   <a name="sam-capacityprovider-scalingconfig"></a>
 Die Skalierungskonfiguration für den Kapazitätsanbieter. Definiert, wie der Kapazitätsanbieter EC2 Amazon-Instances je nach Bedarf skaliert.  
*Typ:* [ScalingConfig](sam-property-capacityprovider-scalingconfig.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[CapacityProviderScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-capacityproviderscalingconfig)` Eigenschaft einer `AWS::Lambda::CapacityProvider` Ressource übergeben. 

 `KmsKeyArn`   <a name="sam-capacityprovider-kmskeyarn"></a>
Der ARN des AWS KMS Schlüssels, der zur Verschlüsselung von Daten im Ruhezustand und bei der Übertragung für den Kapazitätsanbieter verwendet wird.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-kmskeyarn)` Eigenschaft einer `AWS::Lambda::CapacityProvider` Ressource übergeben. 

## Rückgabewerte
<a name="sam-resource-capacityprovider-return-values"></a>

### Punkt
<a name="sam-resource-capacityprovider-return-values-ref"></a>

Wenn die logische ID dieser Ressource für die `Ref` systeminterne Funktion bereitgestellt wird, gibt sie den Namen des Kapazitätsanbieters zurück.

Weitere Informationen zur Verwendung der `Ref` Funktion finden Sie [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)im *AWS CloudFormation Benutzerhandbuch*. 

### Fn:: GetAtt
<a name="sam-resource-capacityprovider-return-values-fn--getatt"></a>

`Fn::GetAtt` gibt einen Wert für ein angegebenes Attribut dieses Typs zurück. Im Folgenden sehen Sie die verfügbaren Attribute und Beispielrückgabewerte. 

Weitere Informationen zur Verwendung `Fn::GetAtt` finden Sie [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html)im *AWS CloudFormation Benutzerhandbuch*. 

`Arn`  <a name="Arn-fn::getatt"></a>
Der ARN des Kapazitätsanbieters.

## Beispiele
<a name="sam-resource-capacityprovider-examples"></a>

### Basiskapazitätsanbieter
<a name="sam-resource-capacityprovider-examples-basic"></a>

Im folgenden Beispiel wird ein Basiskapazitätsanbieter mit VPC-Konfiguration erstellt.

```
MyCapacityProvider:
  Type: AWS::Serverless::CapacityProvider
  Properties:
    CapacityProviderName: my-capacity-provider
    VpcConfig:
      SubnetIds:
        - subnet-12345678
        - subnet-87654321
      SecurityGroupIds:
        - sg-12345678
    Tags:
      Environment: Production
      Team: ServerlessTeam
```

### Erweiterter Kapazitätsanbieter mit Skalierung
<a name="sam-resource-capacityprovider-examples-advanced"></a>

Im folgenden Beispiel wird ein Kapazitätsanbieter mit benutzerdefinierten Instanzanforderungen und Skalierungskonfiguration erstellt.

```
AdvancedCapacityProvider:
  Type: AWS::Serverless::CapacityProvider
  Properties:
    CapacityProviderName: advanced-capacity-provider
    VpcConfig:
      SubnetIds:
        - subnet-12345678
        - subnet-87654321
      SecurityGroupIds:
        - sg-12345678
    OperatorRole: arn:aws:iam::123456789012:role/MyCapacityProviderRole
    PropagateTags: true
    InstanceRequirements:
      Architectures:
        - x86_64
      ExcludedTypes:
        - t2.micro
    ScalingConfig:
      MaxInstanceCount: 10
      ManualScalingPolicies:
        AverageCPUUtilization: 70.0
    KmsKeyArn: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
    Tags:
      Environment: Production
      CostCenter: Engineering
```

# VpcConfig
<a name="sam-property-capacityprovider-vpcconfig"></a>

Konfiguriert die VPC-Einstellungen für einen Kapazitätsanbieter, einschließlich der Subnetze und Sicherheitsgruppen, in denen EC2 Instances gestartet werden.

## Syntax
<a name="sam-property-capacityprovider-vpcconfig-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-capacityprovider-vpcconfig-syntax.yaml"></a>

```
[SubnetIds](#sam-capacityprovider-vpcconfig-subnetids): List
[SecurityGroupIds](#sam-capacityprovider-vpcconfig-securitygroupids): List
```

## Eigenschaften
<a name="sam-property-capacityprovider-vpcconfig-properties"></a>

 `SubnetIds`   <a name="sam-capacityprovider-vpcconfig-subnetids"></a>
Eine Liste der Subnetze IDs , in denen EC2 Instances gestartet werden. Es muss mindestens ein Subnetz angegeben werden.  
*Typ*: Liste  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[SubnetIds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityprovidervpcconfig.html#cfn-lambda-capacityprovider-capacityprovidervpcconfig-subnetids)` Eigenschaft `[VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-vpcconfig) ` einer `AWS::Lambda::CapacityProvider` Ressource übergeben. 

 `SecurityGroupIds`   <a name="sam-capacityprovider-vpcconfig-securitygroupids"></a>
Eine Liste der Sicherheitsgruppen IDs , die den EC2 Instanzen zugeordnet werden sollen. Wenn nicht angegeben, wird die Standardsicherheitsgruppe für die VPC verwendet.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[SecurityGroupIds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityprovidervpcconfig.html#cfn-lambda-capacityprovider-capacityprovidervpcconfig-securitygroupids)` Eigenschaft oder `[VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-vpcconfig)` Eigenschaft einer `AWS::Lambda::CapacityProvider` Ressource übergeben. 

## Beispiele
<a name="sam-property-capacityprovider-vpcconfig-examples"></a>

### VPC-Konfiguration
<a name="sam-property-capacityprovider-vpcconfig-examples-basic"></a>

Das folgende Beispiel zeigt eine VPC-Konfiguration mit mehreren Subnetzen und Sicherheitsgruppen.

```
VpcConfig:
  SubnetIds:
    - subnet-12345678
    - subnet-87654321
  SecurityGroupIds:
    - sg-12345678
    - sg-87654321
```

# InstanceRequirements
<a name="sam-property-capacityprovider-instancerequirements"></a>

Spezifiziert die Anforderungen für EC2 Instances, die vom Kapazitätsanbieter gestartet werden, einschließlich Architekturen und Einschränkungen des Instanztyps.

## Syntax
<a name="sam-property-capacityprovider-instancerequirements-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-capacityprovider-instancerequirements-syntax.yaml"></a>

```
[Architectures](#sam-capacityprovider-instancerequirements-architectures): List
[AllowedTypes](#sam-capacityprovider-instancerequirements-allowedtypes): List
[ExcludedTypes](#sam-capacityprovider-instancerequirements-excludedtypes): List
```

**Anmerkung**  
Sie können wählen, ob Sie `ExcludedTypes` bei der Definition der Instanzanforderungen für Ihren Kapazitätsanbieter entweder eines `AllowedTypes` oder angeben möchten, aber nicht beide.

## Eigenschaften
<a name="sam-property-capacityprovider-instancerequirements-properties"></a>

 `Architectures`   <a name="sam-capacityprovider-instancerequirements-architectures"></a>
Die Befehlssatzarchitekturen für die Kapazitätsanbieter-Instances.  
*Zulässige Werte*: `x86_64` oder `arm64`.  
*Typ*: Liste  
*Required*: No  
*Standardwert*: `x86_64`  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Architectures](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-instancerequirements.html#cfn-lambda-capacityprovider-instancerequirements-architectures)` Eigenschaft `[InstanceRequirements](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-instancerequirements)` einer `AWS::Lambda::CapacityProvider` Ressource übergeben. 

 `AllowedTypes`   <a name="sam-capacityprovider-instancerequirements-allowedtypes"></a>
Eine Liste der zulässigen EC2 Instanztypen für die Kapazitätsanbieter-Instanz.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[AllowedInstanceTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-instancerequirements.html#cfn-lambda-capacityprovider-instancerequirements-allowedinstancetypes)` Eigenschaft `[InstanceRequirements](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-instancerequirements)` einer `AWS::Lambda::CapacityProvider` Ressource übergeben. 

 `ExcludedTypes`   <a name="sam-capacityprovider-instancerequirements-excludedtypes"></a>
Eine Liste von EC2 Instance-Typen, die vom Kapazitätsanbieter ausgeschlossen werden sollen.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ExcludedInstanceTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-instancerequirements.html#cfn-lambda-capacityprovider-instancerequirements-excludedinstancetypes)` Eigenschaft `[InstanceRequirements](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-instancerequirements)` einer `AWS::Lambda::CapacityProvider` Ressource übergeben. 

## Beispiele
<a name="sam-property-capacityprovider-instancerequirements-examples"></a>

### Konfiguration der Instanzanforderungen
<a name="sam-property-capacityprovider-instancerequirements-examples-basic"></a>

Das folgende Beispiel zeigt Instanzanforderungen mit spezifischen Einschränkungen für Architektur und Instanztyp.

```
InstanceRequirements:
  Architectures:
    - x86_64
  ExcludedTypes:
    - t2.micro
```

# ScalingConfig
<a name="sam-property-capacityprovider-scalingconfig"></a>

Konfiguriert, wie der Kapazitätsanbieter EC2 Instances je nach Bedarf skaliert, einschließlich maximaler Instanzlimits und Skalierungsrichtlinien.

## Syntax
<a name="sam-property-capacityprovider-scalingconfig-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-capacityprovider-scalingconfig-syntax.yaml"></a>

```
[MaxVCpuCount](#sam-capacityprovider-scalingconfig-maxvcpucount): Integer
[AverageCPUUtilization](#sam-capacityprovider-scalingconfig-averagecpuutilization): Double
```

## Eigenschaften
<a name="sam-property-capacityprovider-scalingconfig-properties"></a>

 `MaxVCpuCount`   <a name="sam-capacityprovider-scalingconfig-maxvcpucount"></a>
Die maximale Anzahl von vCPUs , die der Kapazitätsanbieter für alle Recheninstanzen bereitstellen kann.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MaxVCpuCount](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityproviderscalingconfig.html#cfn-lambda-capacityprovider-capacityproviderscalingconfig-maxvcpucount)` Eigenschaft `[CapacityProviderScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-capacityproviderscalingconfig)` einer `AWS::Lambda::CapacityProvider` Ressource übergeben. 

 `AverageCPUUtilization`   <a name="sam-capacityprovider-scalingconfig-averagecpuutilization"></a>
Der angestrebte durchschnittliche Prozentsatz der CPU-Auslastung (0-100) für Skalierungsentscheidungen. Wenn die durchschnittliche CPU-Auslastung diesen Schwellenwert überschreitet, skaliert der Kapazitätsanbieter EC2 Amazon-Instances. Falls angegeben, AWS SAM Konstrukte `[CapacityProviderScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html#cfn-lambda-capacityprovider-capacityproviderscalingconfig)` einer `AWS::Lambda::CapacityProvider` Ressource mit den Werten „auf“ `'Manual'` und `[ScalingMode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityproviderscalingconfig.html#cfn-lambda-capacityprovider-capacityproviderscalingconfig-scalingmode)` „`[ScalingPolicies](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-capacityprovider-capacityproviderscalingconfig.html#cfn-lambda-capacityprovider-capacityproviderscalingconfig-scalingpolicies)`gesetzt auf`[{PredefinedMetricType: 'LambdaCapacityProviderAverageCPUUtilization', TargetValue: <this value>}]`“.   
*Type*: Double  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent. 

## Beispiele
<a name="sam-property-capacityprovider-scalingconfig-examples"></a>

### Skalierungskonfiguration
<a name="sam-property-capacityprovider-scalingconfig-examples-basic"></a>

Das folgende Beispiel zeigt eine Skalierungskonfiguration mit maximaler VCpu Anzahl und durchschnittlicher CPU-Auslastung.

```
ScalingConfig:
  MaxVCpuCount: 10
  AverageCPUUtilization: 70.0
```

# AWS::Serverless::Connector
<a name="sam-resource-connector"></a>

Konfiguriert Berechtigungen zwischen zwei Ressourcen. Eine Einführung in Konnektoren finden Sie unter[Verwaltung von Ressourcenberechtigungen mit AWS SAM Konnektoren](managing-permissions-connectors.md).

Weitere Informationen zu generierten AWS CloudFormation Ressourcen finden Sie unter[CloudFormation Ressourcen, die generiert werden, wenn Sie angeben AWS::Serverless::Connector](sam-specification-generated-resources-connector.md).

Wenn Sie Feedback zu Konnektoren geben möchten, [reichen Sie eine neue Ausgabe](https://github.com/aws/serverless-application-model/issues/new?assignees=&labels=area%2Fconnectors,stage%2Fneeds-triage&template=other.md&title=%28Feature%20Request%29) im *serverless-application-model AWS GitHub Repository* ein.

**Anmerkung**  
Wenn Sie auf bereitstellen AWS CloudFormation, werden Ihre AWS SAM Ressourcen in AWS SAM CloudFormation Ressourcen umgewandelt. Weitere Informationen finden Sie unter [Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md).

## Syntax
<a name="sam-resource-connector-syntax"></a>

Verwenden Sie eine der folgenden Syntaxen, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

**Anmerkung**  
Für die meisten Anwendungsfälle empfehlen wir, die Syntax für eingebettete Konnektoren zu verwenden. Da sie in die Quellressource eingebettet ist, ist sie im Laufe der Zeit einfacher zu lesen und zu verwalten. Wenn Sie auf eine Quellressource verweisen müssen, die sich nicht in derselben AWS SAM Vorlage befindet, z. B. eine Ressource in einem verschachtelten Stapel oder eine gemeinsam genutzte Ressource, verwenden Sie die `AWS::Serverless::Connector` Syntax.

### Integrierte Konnektoren
<a name="sam-resource-connector-syntax-embedded"></a>

```
<source-resource-logical-id>:
  Connectors:
    <connector-logical-id:
      Properties:
        [Destination](#sam-connector-destination): ResourceReference | List of ResourceReference
        [Permissions](#sam-connector-permissions): List
        [SourceReference](#sam-connector-sourcereference): SourceReference
```

### AWS::Serverless::Connector
<a name="sam-resource-connector-syntax-connector"></a>

```
Type: AWS::Serverless::Connector
Properties:
  [Destination](#sam-connector-destination): ResourceReference | List of ResourceReference
  [Permissions](#sam-connector-permissions): List
  [Source](#sam-connector-source): ResourceReference
```

## Eigenschaften
<a name="sam-resource-connector-properties"></a>

 `Destination`   <a name="sam-connector-destination"></a>
Die Zielressource.  
*Typ*: [ResourceReference](sam-property-connector-resourcereference.md)\$1 Liste von [ResourceReference](sam-property-connector-resourcereference.md)  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Permissions`   <a name="sam-connector-permissions"></a>
Der Berechtigungstyp, den die Quellressource für die Zielressource ausführen darf.  
`Read`beinhaltet AWS Identity and Access Management (IAM) -Aktionen, die das Lesen von Daten aus der Ressource ermöglichen.  
`Write`beinhaltet IAM-Aktionen, die das Initiieren und Schreiben von Daten in eine Ressource ermöglichen.  
*Zulässige Werte*: `Read` oder `Write`.  
*Typ*: Liste  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. CloudFormation 

 `Source`   <a name="sam-connector-source"></a>
Die Quellressource. Erforderlich, wenn die `AWS::Serverless::Connector` Syntax verwendet wird.  
*Typ:* [ResourceReference](sam-property-connector-resourcereference.md)  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `SourceReference`   <a name="sam-connector-sourcereference"></a>
Die Quellressource.  
Wird zusammen mit der Syntax der eingebetteten Konnektoren verwendet, wenn Sie zusätzliche Eigenschaften für die Quellressource definieren.
*Typ:* [SourceReference](sam-property-connector-sourcereference.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-resource-connector-examples"></a>

### Eingebettete Anschlüsse
<a name="sam-resource-connector-examples-embedded"></a>

Das folgende Beispiel verwendet eingebettete Konnektoren, um eine `Write` Datenverbindung zwischen einer AWS Lambda Funktion und einer Amazon DynamoDB-Tabelle zu definieren:

```
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyTable:
    Type: AWS::Serverless::SimpleTable
  MyFunction:
    Type: AWS::Serverless::Function
    Connectors:
      MyConn:
        Properties:
          Destination:
            Id: MyTable
          Permissions:
            - Write
    ...
```

Im folgenden Beispiel werden eingebettete Konnektoren verwendet, um Berechtigungen zu definieren`Read`: `Write`

```
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyFunction:
    Type: AWS::Serverless::Function
    Connectors:
      MyConn:
        Properties:
          Destination:
            Id: MyTable
          Permissions:
            - Read
            - Write
  MyTable:
    Type: AWS::DynamoDB::Table
    ...
```

Im folgenden Beispiel werden eingebettete Konnektoren verwendet, um eine Quellressource mit einer anderen Eigenschaft als zu definieren`Id`:

```
Transform: AWS::Serverless-2016-10-31
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyApi:
    Type: AWS::Serverless::Api
    Connectors:
      ApitoLambdaConn:
        Properties:
          SourceReference:
            Qualifier: Prod/GET/foobar
          Destination:
            Id: MyTable
          Permissions:
            - Read
            - Write
  MyTable:
    Type: AWS::DynamoDB::Table
    ...
```

### AWS::Serverless::Connector
<a name="sam-resource-connector--examples-connector"></a>

Im folgenden Beispiel wird die [AWS::Serverless::Connector](#sam-resource-connector) Ressource verwendet, damit eine AWS Lambda Funktion aus einer Amazon DynamoDB-Tabelle liest und in diese schreibt:

```
MyConnector:
  Type: AWS::Serverless::Connector
  Properties:
    Source:
      Id: MyFunction
    Destination:
      Id: MyTable
    Permissions:
      - Read
      - Write
```

Im folgenden Beispiel wird die [AWS::Serverless::Connector](#sam-resource-connector) Ressource verwendet, damit eine Lambda-Funktion in ein Amazon SNS SNS-Thema schreibt, wobei sich beide Ressourcen in derselben Vorlage befinden:

```
MyConnector:
  Type: AWS::Serverless::Connector
  Properties:
    Source:
      Id: MyLambda
    Destination:
      Id: MySNSTopic
    Permissions:
      - Write
```

Im folgenden Beispiel wird die [AWS::Serverless::Connector](#sam-resource-connector) Ressource verwendet, um ein Amazon SNS SNS-Thema in eine Lambda-Funktion schreiben zu lassen, die dann in eine Amazon DynamoDB-Tabelle schreibt, wobei sich alle Ressourcen in derselben Vorlage befinden:

```
Transform: AWS::Serverless-2016-10-31
Resources:
  Topic:
    Type: AWS::SNS::Topic
    Properties:
      Subscription:
        - Endpoint: !GetAtt Function.Arn
          Protocol: lambda

  Function:
    Type: AWS::Serverless::Function
    Properties:
      Runtime: nodejs16.x
      Handler: index.handler
      InlineCode: |
        const AWS = require('aws-sdk');
        exports.handler = async (event, context) => {
          const docClient = new AWS.DynamoDB.DocumentClient();
          await docClient.put({ 
            TableName: process.env.TABLE_NAME, 
            Item: {
              id: context.awsRequestId,
              event: JSON.stringify(event)
            }
          }).promise();
        };
      Environment:
        Variables:
          TABLE_NAME: !Ref Table

  Table:
    Type: AWS::Serverless::SimpleTable

  TopicToFunctionConnector:
    Type: AWS::Serverless::Connector
    Properties:
      Source: 
        Id: Topic
      Destination: 
        Id: Function
      Permissions:
        - Write

  FunctionToTableConnector:
    Type: AWS::Serverless::Connector
    Properties:
      Source: 
        Id: Function
      Destination: 
        Id: Table
      Permissions:
        - Write
```

Im Folgenden sehen Sie die transformierte AWS CloudFormation Vorlage aus dem obigen Beispiel:

```
"FunctionToTableConnectorPolicy": {
  "Type": "AWS::IAM::ManagedPolicy",
  "Metadata": {
    "aws:sam:connectors": {
      "FunctionToTableConnector": {
        "Source": {
          "Type": "AWS::Lambda::Function"
        },
        "Destination": {
          "Type": "AWS::DynamoDB::Table"
        }
      }
    }
  },
  "Properties": {
    "PolicyDocument": {
      "Version": "2012-10-17",		 	 	 
      "Statement": [
        {
          "Effect": "Allow",
          "Action": [
            "dynamodb:PutItem",
            "dynamodb:UpdateItem",
            "dynamodb:DeleteItem",
            "dynamodb:BatchWriteItem",
            "dynamodb:PartiQLDelete",
            "dynamodb:PartiQLInsert",
            "dynamodb:PartiQLUpdate"
          ],
          "Resource": [
            {
              "Fn::GetAtt": [
                "MyTable",
                "Arn"
              ]
            },
            {
              "Fn::Sub": [
                "${DestinationArn}/index/*",
                {
                  "DestinationArn": {
                    "Fn::GetAtt": [
                      "MyTable",
                      "Arn"
                    ]
                  }
                }
              ]
            }
          ]
        }
      ]
    },
    "Roles": [
      {
        "Ref": "MyFunctionRole"
      }
    ]
  }
}
```

# ResourceReference
<a name="sam-property-connector-resourcereference"></a>

Ein Verweis auf eine Ressource, die der [AWS::Serverless::Connector](sam-resource-connector.md) Ressourcentyp verwendet.

**Anmerkung**  
Geben Sie für Ressourcen in derselben Vorlage den an`Id`. Verwenden Sie für Ressourcen, die nicht in derselben Vorlage enthalten sind, eine Kombination anderer Eigenschaften. Weitere Informationen finden Sie unter [AWS SAM Steckverbinderreferenz](reference-sam-connector.md).

## Syntax
<a name="sam-property-connector-resourcereference-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-connector-resourcereference-syntax.yaml"></a>

```
  [Arn](#sam-connector-resourcereference-arn): String
  [Id](#sam-connector-resourcereference-id): String
  [Name](#sam-connector-resourcereference-name): String
  [Qualifier](#sam-connector-resourcereference-qualifier): String
  [QueueUrl](#sam-connector-resourcereference-queueurl): String
  [ResourceId](#sam-connector-resourcereference-resourceid): String
  [RoleName](#sam-connector-resourcereference-rolename): String
  [Type](#sam-connector-resourcereference-type): String
```

## Eigenschaften
<a name="sam-property-connector-resourcereference-properties"></a>

 `Arn`   <a name="sam-connector-resourcereference-arn"></a>
Der ARN einer Ressource.  
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Id`   <a name="sam-connector-resourcereference-id"></a>
Die [logische ID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html) einer Ressource in derselben Vorlage.  
Wenn angegeben, `Id` wird, wenn der Connector AWS Identity and Access Management (IAM-) Richtlinien generiert, die diesen Richtlinien zugeordnete IAM-Rolle aus der Ressource abgeleitet. `Id` Wenn nicht angegeben, `Id` wird die Ressource für `RoleName` Connectors bereitgestellt, um generierte IAM-Richtlinien an eine IAM-Rolle anzuhängen.
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Name`   <a name="sam-connector-resourcereference-name"></a>
Der Name einer -Ressource.  
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Qualifier`   <a name="sam-connector-resourcereference-qualifier"></a>
Ein Qualifikator für eine Ressource, der ihren Umfang einschränkt. `Qualifier`ersetzt den `*` Wert am Ende einer Ressourcenbeschränkung ARN. Ein Beispiel finden Sie unter [API Gateway, das eine Lambda-Funktion aufruft](#sam-property-connector-resourcereference--examples--api-gateway-invoking-a-lambda-function).  
Die Definition des Qualifikators variiert je nach Ressourcentyp. Eine Liste der unterstützten Quell- und Zielressourcentypen finden Sie unter[AWS SAM Steckverbinderreferenz](reference-sam-connector.md).
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `QueueUrl`   <a name="sam-connector-resourcereference-queueurl"></a>
Die URL der Amazon SQS SQS-Warteschlange. Diese Eigenschaft gilt nur für Amazon SQS SQS-Ressourcen.  
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `ResourceId`   <a name="sam-connector-resourcereference-resourceid"></a>
Die ID einer Ressource. Zum Beispiel die API-Gateway-API-ID.  
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `RoleName`   <a name="sam-connector-resourcereference-rolename"></a>
Der Rollenname, der einer Ressource zugeordnet ist.  
Wenn angegeben, `Id` wird, wenn der Connector IAM-Richtlinien generiert, die diesen Richtlinien zugeordnete IAM-Rolle aus der Ressource abgeleitet. `Id` Wenn nicht angegeben, `Id` wird die Ressource für Connectoren bereitgestellt`RoleName`, um generierte IAM-Richtlinien an eine IAM-Rolle anzuhängen.
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Type`   <a name="sam-connector-resourcereference-type"></a>
Der CloudFormation Typ einer Ressource. Weitere Informationen finden Sie in der [Referenz zu AWS Ressourcen- und Eigenschaftstypen](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html).  
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-connector-resourcereference--examples"></a>

### API Gateway, das eine Lambda-Funktion aufruft
<a name="sam-property-connector-resourcereference--examples--api-gateway-invoking-a-lambda-function"></a>

Das folgende Beispiel verwendet die [AWS::Serverless::Connector](sam-resource-connector.md) Ressource, um Amazon API Gateway das Aufrufen einer AWS Lambda Funktion zu ermöglichen.

#### YAML
<a name="sam-property-connector-resourcereference--examples--api-gateway-invoking-a-lambda-function--yaml"></a>

```
Transform: AWS::Serverless-2016-10-31
Resources:
  MyRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Statement:
          - Effect: Allow
            Action: sts:AssumeRole
            Principal:
              Service: lambda.amazonaws.com
      ManagedPolicyArns:
        - !Sub arn:${AWS::Partition}:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole

  MyFunction:
    Type: AWS::Lambda::Function
    Properties:
      Role: !GetAtt MyRole.Arn
      Runtime: nodejs16.x
      Handler: index.handler
      Code:
        ZipFile: |
          exports.handler = async (event) => {
            return {
              statusCode: 200,
              body: JSON.stringify({
                "message": "It works!"
              }),
            };
          };

  MyApi:
    Type: AWS::ApiGatewayV2::Api
    Properties:
      Name: MyApi
      ProtocolType: HTTP

  MyStage:
    Type: AWS::ApiGatewayV2::Stage
    Properties:
      ApiId: !Ref MyApi
      StageName: prod
      AutoDeploy: True

  MyIntegration:
    Type: AWS::ApiGatewayV2::Integration
    Properties:
      ApiId: !Ref MyApi
      IntegrationType: AWS_PROXY
      IntegrationUri: !Sub arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${MyFunction.Arn}/invocations
      IntegrationMethod: POST
      PayloadFormatVersion: "2.0"

  MyRoute:
    Type: AWS::ApiGatewayV2::Route
    Properties:
      ApiId: !Ref MyApi
      RouteKey: GET /hello
      Target: !Sub integrations/${MyIntegration}

  MyConnector:
    Type: AWS::Serverless::Connector
    Properties:
      Source: # Use 'Id' when resource is in the same template
        Type: AWS::ApiGatewayV2::Api
        ResourceId: !Ref MyApi
        Qualifier: prod/GET/hello # Or "*" to allow all routes
      Destination: # Use 'Id' when resource is in the same template
        Type: AWS::Lambda::Function
        Arn: !GetAtt MyFunction.Arn
      Permissions:
        - Write

Outputs:
  Endpoint:
    Value: !Sub https://${MyApi}.execute-api.${AWS::Region}.${AWS::URLSuffix}/prod/hello
```

# SourceReference
<a name="sam-property-connector-sourcereference"></a>

Ein Verweis auf eine Quellressource, die der [AWS::Serverless::Connector](sam-resource-connector.md) Ressourcentyp verwendet.

## Syntax
<a name="sam-property-connector-sourcereference-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-connector-sourcereference-syntax.yaml"></a>

```
[Qualifier](#sam-connector-sourcereference-qualifier): String
```

## Eigenschaften
<a name="sam-property-connector-sourcereference-properties"></a>

 `Qualifier`   <a name="sam-connector-sourcereference-qualifier"></a>
Ein Qualifikator für eine Ressource, der ihren Geltungsbereich einschränkt. `Qualifier`ersetzt den `*` Wert am Ende einer Ressourcenbeschränkung ARN.  
Die Definition des Qualifikators variiert je nach Ressourcentyp. Eine Liste der unterstützten Quell- und Zielressourcentypen finden Sie unter[AWS SAM Steckverbinderreferenz](reference-sam-connector.md).
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-connector-sourcereference--examples"></a>

**Im folgenden Beispiel werden eingebettete Konnektoren verwendet, um eine Quellressource mit einer anderen Eigenschaft als zu definieren`Id`:**

```
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyApi:
    Type: AWS::Serverless::Api
    Connectors:
      ApitoLambdaConn:
        Properties:
          SourceReference:
            Qualifier: Prod/GET/foobar
          Destination:
            Id: MyTable
          Permissions:
            - Read
            - Write
  MyTable:
    Type: AWS::DynamoDB::Table
    ...
```

# AWS::Serverless::Function
<a name="sam-resource-function"></a>

Erstellt eine AWS Lambda Funktion, eine AWS Identity and Access Management (IAM-) Ausführungsrolle und Zuordnungen von Ereignisquellen, die die Funktion auslösen.

Die [AWS::Serverless::Function](#sam-resource-function) Ressource unterstützt auch das `Metadata` Ressourcenattribut, sodass Sie anweisen können, benutzerdefinierte Laufzeiten AWS SAM zu erstellen, die Ihre Anwendung benötigt. Weitere Informationen zum Erstellen benutzerdefinierter Laufzeiten finden Sie unter. [Erstellen von Lambda-Funktionen mit benutzerdefinierten Laufzeiten in AWS SAM](building-custom-runtimes.md)

**Anmerkung**  
Bei der Bereitstellung auf werden AWS CloudFormation Ihre AWS SAM Ressourcen in Ressourcen umgewandelt CloudFormation . AWS SAM Weitere Informationen finden Sie unter [Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md).

## Syntax
<a name="sam-resource-function-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-resource-function-syntax.yaml"></a>

```
Type: AWS::Serverless::Function
Properties:
  [Architectures](#sam-function-architectures): List
  [AssumeRolePolicyDocument](#sam-function-assumerolepolicydocument): JSON
  [AutoPublishAlias](#sam-function-autopublishalias): String
  AutoPublishAliasAllProperties: Boolean
  [AutoPublishCodeSha256](#sam-function-autopublishcodesha256): String
  [CapacityProviderConfig](#sam-function-capacityproviderconfig): CapacityProviderConfig
  [CodeSigningConfigArn](#sam-function-codesigningconfigarn): String
  [CodeUri](#sam-function-codeuri): String | FunctionCode
  [DeadLetterQueue](#sam-function-deadletterqueue): Map | DeadLetterQueue
  [DeploymentPreference](#sam-function-deploymentpreference): DeploymentPreference
  [Description](#sam-function-description): String
  [DurableConfig](#sam-function-durableconfig): DurableConfig
  [Environment](#sam-function-environment): [Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html)
  [EphemeralStorage](#sam-function-ephemeralstorage): [EphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage)
  [EventInvokeConfig](#sam-function-eventinvokeconfig): EventInvokeConfiguration
  [Events](#sam-function-events): EventSource
  [FileSystemConfigs](#sam-function-filesystemconfigs): List
  [FunctionName](#sam-function-functionname): String
  [FunctionScalingConfig](#sam-function-functionscalingconfig): FunctionScalingConfig
  [FunctionUrlConfig](#sam-function-functionurlconfig): FunctionUrlConfig
  [Handler](#sam-function-handler): String
  [ImageConfig](#sam-function-imageconfig): [ImageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig)
  [ImageUri](#sam-function-imageuri): String
  [InlineCode](#sam-function-inlinecode): String
  [KmsKeyArn](#sam-function-kmskeyarn): String
  [Layers](#sam-function-layers): List
  LoggingConfig: [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-loggingconfig.html)
  [MemorySize](#sam-function-memorysize): Integer
  [PackageType](#sam-function-packagetype): String
  [PermissionsBoundary](#sam-function-permissionsboundary): String
  [Policies](#sam-function-policies): String | List | Map
  [PublishToLatestPublished](#sam-function-publishtolatestpublished): Boolean
  PropagateTags: Boolean
  [ProvisionedConcurrencyConfig](#sam-function-provisionedconcurrencyconfig): [ProvisionedConcurrencyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig)
  RecursiveLoop: String
  [ReservedConcurrentExecutions](#sam-function-reservedconcurrentexecutions): Integer
  [Role](#sam-function-role): String
  [RolePath](#sam-function-rolepath): String
  [Runtime](#sam-function-runtime): String
  RuntimeManagementConfig: [RuntimeManagementConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html)
  SnapStart: [SnapStart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html)
  [SourceKMSKeyArn](#sam-function-sourcekmskeyarn): String
  [Tags](#sam-function-tags): Map
  [TenancyConfig](#sam-function-tenancyconfig): TenancyConfig
  [Timeout](#sam-function-timeout): Integer
  [Tracing](#sam-function-tracing): String
  [VersionDescription](#sam-function-versiondescription): String
  [VersionDeletionPolicy](#sam-function-versiondeletionpolicy): String
  [VpcConfig](#sam-function-vpcconfig): [VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html)
```

## Eigenschaften
<a name="sam-resource-function-properties"></a>

 `Architectures`   <a name="sam-function-architectures"></a>
Die Befehlssatzarchitektur für die Funktion.  
Weitere Informationen zu dieser Eigenschaft finden Sie unter [Lambda-Befehlssatzarchitekturen](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) im *AWS Lambda Developer* Guide.  
*Gültige Werte*: Einer von oder `x86_64` `arm64`  
*Typ*: Liste  
*Required*: No  
*Standardwert*: `x86_64`  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Architectures](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-architectures)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `AssumeRolePolicyDocument`   <a name="sam-function-assumerolepolicydocument"></a>
Fügt eine AssumeRolePolicyDocument für die Standardeinstellung hinzu, die `Role` für diese Funktion erstellt wurde. Wenn diese Eigenschaft nicht angegeben ist, wird eine Standardrolle für diese Funktion AWS SAM hinzugefügt.  
*Type*: JSON  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[AssumeRolePolicyDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-assumerolepolicydocument)` Eigenschaft einer `AWS::IAM::Role` Ressource. AWS SAM fügt diese Eigenschaft der generierten IAM-Rolle für diese Funktion hinzu. Wenn der Amazon-Ressourcenname (ARN) einer Rolle für diese Funktion angegeben wird, hat diese Eigenschaft keine Wirkung.

 `AutoPublishAlias`   <a name="sam-function-autopublishalias"></a>
Der Name des Lambda-Alias. *Weitere Informationen zu Lambda-Aliasen finden Sie unter [Lambda-Funktionsaliase](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) im Developer Guide.AWS Lambda * Beispiele, die diese Eigenschaft verwenden, finden Sie unter. [Schrittweise Bereitstellung serverloser Anwendungen mit AWS SAM](automating-updates-to-serverless-apps.md)  
AWS SAM generiert [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html)und verwendet [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html)Ressourcen, wenn diese Eigenschaft festgelegt ist. Informationen zu diesem Szenario finden Sie unter[AutoPublishAlias Eigenschaft ist angegeben](sam-specification-generated-resources-function.md#sam-specification-generated-resources-function-autopublishalias). Allgemeine Informationen zu generierten CloudFormation Ressourcen finden Sie unter[Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md).  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `AutoPublishAliasAllProperties`   <a name="sam-function-autopublishaliasallproperties"></a>
Gibt an, wann eine neue erstellt [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html)wird. Wann`true`, eine neue Lambda-Version wird erstellt, wenn eine Eigenschaft in der Lambda-Funktion geändert wird. Wann`false`, eine neue Lambda-Version wird nur erstellt, wenn eine der folgenden Eigenschaften geändert wird:  
+ `Environment`, `MemorySize`, oder `SnapStart`.
+ Jede Änderung, die zu einer Aktualisierung der `Code` Eigenschaft führt, z. B. `CodeDict``ImageUri`, oder`InlineCode`.
Diese Eigenschaft `AutoPublishAlias` muss definiert werden.  
Wenn ebenfalls angegeben `AutoPublishCodeSha256` ist, hat ihr Verhalten Vorrang `AutoPublishAliasAllProperties: true` vor.  
*Typ*: Boolesch  
*Required*: No  
*Standardwert*: `false`  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `AutoPublishCodeSha256`   <a name="sam-function-autopublishcodesha256"></a>
Wenn diese Zeichenfolge verwendet wird, bestimmt sie zusammen mit dem `CodeUri` Wert, ob eine neue Lambda-Version veröffentlicht werden muss. Diese Eigenschaft wird häufig verwendet, um das folgende Bereitstellungsproblem zu lösen: Ein Bereitstellungspaket wird an einem Amazon S3 S3-Standort gespeichert und durch ein neues Bereitstellungspaket mit aktualisiertem Lambda-Funktionscode ersetzt, aber die `CodeUri` Eigenschaft bleibt unverändert (im Gegensatz dazu, dass das neue Bereitstellungspaket an einen neuen Amazon S3 S3-Standort hochgeladen und dann an den neuen Speicherort geändert `CodeUri` wird).  
Dieses Problem ist durch eine AWS SAM Vorlage gekennzeichnet, die die folgenden Merkmale aufweist:  
+ Das `DeploymentPreference` Objekt ist für schrittweise Bereitstellungen konfiguriert (wie unter beschrieben[Schrittweise Bereitstellung serverloser Anwendungen mit AWS SAM](automating-updates-to-serverless-apps.md))
+ Die `AutoPublishAlias` Eigenschaft ist festgelegt und ändert sich zwischen den Bereitstellungen nicht
+ Die `CodeUri` Eigenschaft ist festgelegt und ändert sich zwischen den Bereitstellungen nicht.
In diesem Szenario `AutoPublishCodeSha256` führt die Aktualisierung dazu, dass eine neue Lambda-Version erfolgreich erstellt wird. Neuer Funktionscode, der in Amazon S3 bereitgestellt wird, wird jedoch nicht erkannt. Um neuen Funktionscode zu erkennen, sollten Sie erwägen, die Versionierung in Ihrem Amazon S3 S3-Bucket zu verwenden. Geben Sie die `Version` Eigenschaft für Ihre Lambda-Funktion an und konfigurieren Sie Ihren Bucket so, dass er immer das neueste Bereitstellungspaket verwendet.  
In diesem Szenario müssen Sie einen eindeutigen Wert für `AutoPublishCodeSha256` angeben, um die schrittweise Bereitstellung erfolgreich auszulösen.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `CapacityProviderConfig`   <a name="sam-function-capacityproviderconfig"></a>
Konfiguriert den Kapazitätsanbieter, an den veröffentlichte Versionen der Funktion angehängt werden. Dadurch kann die Funktion auf kundeneigenen EC2-Instances ausgeführt werden, die von Lambda Managed Instances verwaltet werden.  
*Typ:* [CapacityProviderConfig](sam-property-function-capacityproviderconfig.md)  
*Required*: No  
*CloudFormation Kompatibilität*: SAM reduziert die an die Eigenschaft einer `AWS::Lambda::Function` Ressource übergebene Eigenschaft und rekonstruiert die `[CapacityProviderConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-capacityproviderconfig)` verschachtelte Struktur.

 `CodeSigningConfigArn`   <a name="sam-function-codesigningconfigarn"></a>
Der ARN der [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html)Ressource, der verwendet wird, um die Codesignatur für diese Funktion zu aktivieren. Weitere Informationen zur Codesignatur finden Sie unter [Richten Sie die Codesignatur für Ihre AWS SAM Anwendung ein](authoring-codesigning.md).  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[CodeSigningConfigArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-codesigningconfigarn)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `CodeUri`   <a name="sam-function-codeuri"></a>
Der Code für die Funktion. Zu den akzeptierten Werten gehören:  
+ Die Amazon S3-URI der Funktion. Beispiel, `s3://bucket-123456789/sam-app/1234567890abcdefg`.
+ Der lokale Pfad zur Funktion. Beispiel, `hello_world/`.
+ Ein [FunctionCode](sam-property-function-functioncode.md)-Objekt.
Wenn Sie die Amazon S3-URI oder das Amazon [FunctionCode](sam-property-function-functioncode.md) S3-Objekt einer Funktion angeben, müssen Sie auf ein gültiges [Lambda-Bereitstellungspaket](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) verweisen.  
Wenn Sie einen lokalen Dateipfad angeben, verwenden Sie den, AWS SAMCLI um die lokale Datei bei der Bereitstellung hochzuladen. Weitere Informationen hierzu finden Sie unter [So werden lokale Dateien bei der Bereitstellung AWS SAM hochgeladen](deploy-upload-local-files.md).  
Wenn Sie systeminterne Funktionen in der `CodeUri` Eigenschaft verwenden, AWS SAM können die Werte nicht korrekt analysiert werden. Erwägen Sie stattdessen die Verwendung von [AWS::LanguageExtensions transform](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-languageextensions.html).
*Typ*: [Zeichenfolge \$1[FunctionCode](sam-property-function-functioncode.md)]  
*Erforderlich:* Bedingt. Wenn auf gesetzt `PackageType` ist`Zip`, `InlineCode` ist einer von `CodeUri` oder erforderlich.  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[ Code](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-code)` Eigenschaft einer `AWS::Lambda::Function` Ressource. Die verschachtelten Amazon S3 S3-Eigenschaften sind unterschiedlich benannt.

 `DeadLetterQueue`   <a name="sam-function-deadletterqueue"></a>
Konfiguriert ein Amazon Simple Notification Service (Amazon SNS) -Thema oder eine Amazon Simple Queue Service (Amazon SQS) -Warteschlange, in der Lambda Ereignisse sendet, die es nicht verarbeiten kann. *Weitere Informationen zur Funktionalität von Warteschlangen für unzustellbare Briefe finden Sie unter Warteschlangen für unzustellbare Briefe im [Entwicklerhandbuch](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-dlq).AWS Lambda *  
Wenn die Ereignisquelle Ihrer Lambda-Funktion eine Amazon SQS SQS-Warteschlange ist, konfigurieren Sie eine Warteschlange mit unzustellbaren Buchstaben für die Quellwarteschlange, nicht für die Lambda-Funktion. Die Warteschlange mit [unverschlüsselten Buchstaben, die Sie für eine Funktion konfigurieren, wird für die asynchrone](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html) Aufruf-Warteschlange der Funktion verwendet, nicht für Warteschlangen mit Ereignisquellen.
*Typ: Map \$1 [DeadLetterQueue](sam-property-function-deadletterqueue.md)*  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html)` Eigenschaft einer `AWS::Lambda::Function` Ressource. In wird CloudFormation der Typ von abgeleitet`TargetArn`, wohingegen AWS SAM Sie den Typ zusammen mit dem übergeben müssen`TargetArn`.

 `DeploymentPreference`   <a name="sam-function-deploymentpreference"></a>
Die Einstellungen zur Aktivierung schrittweiser Lambda-Bereitstellungen.  
Wenn ein `DeploymentPreference` Objekt angegeben ist, wird ein [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html)aufgerufenes Objekt `ServerlessDeploymentApplication` (eines pro Stapel), ein aufgerufenes und ein [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html)`<function-logical-id>DeploymentGroup`aufgerufenes Objekt AWS SAM [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)erstellt. `CodeDeployServiceRole`  
*Typ:* [DeploymentPreference](sam-property-function-deploymentpreference.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.  
*Siehe auch*: Weitere Informationen zu dieser Eigenschaft finden Sie unter[Schrittweise Bereitstellung serverloser Anwendungen mit AWS SAM](automating-updates-to-serverless-apps.md).

 `Description`   <a name="sam-function-description"></a>
Eine Beschreibung der Funktion.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-description)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `DurableConfig`   <a name="sam-function-durableconfig"></a>
Konfiguration für dauerhafte Funktionen. Ermöglicht die statusbehaftete Ausführung mit automatischen Checkpoint- und Wiedergabefunktionen.  
*Typ:* [DurableConfig](sam-property-function-durableconfig.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. CloudFormation 

 `Environment`   <a name="sam-function-environment"></a>
Die Konfiguration für die Laufzeitumgebung.  
*Typ*: [Umgebung](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `EphemeralStorage`   <a name="sam-function-ephemeralstorage"></a>
Ein Objekt, das den Festplattenspeicher in MB angibt, der Ihrer Lambda-Funktion in `/tmp` zur Verfügung steht.  
Weitere Informationen zu dieser Eigenschaft finden Sie unter [Lambda-Ausführungsumgebung](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html) im *AWS Lambda Entwicklerhandbuch*.  
*Typ:* [EphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[EphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `EventInvokeConfig`   <a name="sam-function-eventinvokeconfig"></a>
Das Objekt, das die Konfiguration des Ereignisaufrufs für eine Lambda-Funktion beschreibt.  
*Typ:* [EventInvokeConfiguration](sam-property-function-eventinvokeconfiguration.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Events`   <a name="sam-function-events"></a>
Gibt die Ereignisse an, die diese Funktion auslösen. Ereignisse bestehen aus einem Typ und einer Reihe von Eigenschaften, die vom Typ abhängen.  
*Typ:* [EventSource](sam-property-function-eventsource.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `FileSystemConfigs`   <a name="sam-function-filesystemconfigs"></a>
Liste der [FileSystemConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-filesystemconfig.html)Objekte, die die Verbindungseinstellungen für ein Amazon Elastic File System (Amazon EFS) -Dateisystem angeben.  
Wenn Ihre Vorlage eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)Ressource enthält, müssen Sie auch ein `DependsOn` Ressourcenattribut angeben, um sicherzustellen, dass das Mount-Ziel vor der Funktion erstellt oder aktualisiert wird.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FileSystemConfigs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-filesystemconfigs)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `FunctionName`   <a name="sam-function-functionname"></a>
Ein Name für die Funktion. Wenn Sie keinen Namen angeben, wird ein eindeutiger Name für Sie generiert.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FunctionName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionname)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `FunctionScalingConfig`   <a name="sam-function-functionscalingconfig"></a>
Konfiguriert das Skalierungsverhalten für Lambda-Funktionen, die auf Kapazitätsanbietern ausgeführt werden. Definiert die minimale und maximale Anzahl von Ausführungsumgebungen.  
*Typ:* [FunctionScalingConfig](sam-property-function-functionscalingconfig.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FunctionScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionscalingconfig)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `FunctionUrlConfig`   <a name="sam-function-functionurlconfig"></a>
Das Objekt, das eine Funktions-URL beschreibt. Eine Funktions-URL ist ein HTTPS-Endpunkt, mit dem Sie Ihre Funktion aufrufen können.  
Weitere Informationen finden Sie unter [Funktion URLs](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html) im *AWS Lambda Entwicklerhandbuch*.  
*Typ:* [FunctionUrlConfig](sam-property-function-functionurlconfig.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Handler`   <a name="sam-function-handler"></a>
Die Funktion in Ihrem Code, die aufgerufen wird, um mit der Ausführung zu beginnen. Diese Eigenschaft ist nur erforderlich, wenn die `PackageType` Eigenschaft auf gesetzt ist`Zip`.  
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Handler](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-handler)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `ImageConfig`   <a name="sam-function-imageconfig"></a>
Das Objekt, das zur Konfiguration der Lambda-Container-Image-Einstellungen verwendet wird. Weitere Informationen finden Sie unter [Verwenden von Container-Images mit Lambda](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) im *AWS Lambda Entwicklerhandbuch*.  
*Typ:* [ImageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ImageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `ImageUri`   <a name="sam-function-imageuri"></a>
Die URI des Amazon Elastic Container Registry (Amazon ECR) -Repositorys für das Container-Image der Lambda-Funktion. Diese Eigenschaft gilt nur, wenn die `PackageType` Eigenschaft auf gesetzt ist`Image`, andernfalls wird sie ignoriert. Weitere Informationen finden Sie unter [Verwenden von Container-Images mit Lambda](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) im *AWS Lambda Entwicklerhandbuch*.  
Wenn die `PackageType` Eigenschaft auf gesetzt ist`Image`, `ImageUri` ist entweder eine Option erforderlich, oder Sie müssen Ihre Anwendung mit den erforderlichen `Metadata` Einträgen in der AWS SAM Vorlagendatei erstellen. Weitere Informationen finden Sie unter [Standardbuild mit AWS SAM](serverless-sam-cli-using-build.md).
Das Erstellen Ihrer Anwendung mit den erforderlichen `Metadata` Einträgen hat Vorrang. Wenn Sie also beide angeben`ImageUri`, `ImageUri` wird das ignoriert.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ImageUri](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-imageuri)` Eigenschaft des `AWS::Lambda::Function` `Code` Datentyps übergeben.

 `InlineCode`   <a name="sam-function-inlinecode"></a>
Der Lambda-Funktionscode, der direkt in die Vorlage geschrieben ist. Diese Eigenschaft gilt nur, wenn die `PackageType` Eigenschaft auf gesetzt ist`Zip`, andernfalls wird sie ignoriert.  
Wenn die `PackageType` Eigenschaft auf `Zip` (Standard) gesetzt ist, `InlineCode` ist einer von `CodeUri` oder erforderlich.
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ZipFile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-zipfile)` Eigenschaft des `AWS::Lambda::Function` `Code` Datentyps übergeben.

 `KmsKeyArn`   <a name="sam-function-kmskeyarn"></a>
Der ARN eines AWS Key Management Service (AWS KMS) -Schlüssels, den Lambda zum Verschlüsseln und Entschlüsseln der Umgebungsvariablen Ihrer Funktion verwendet.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-kmskeyarn)` Eigenschaft einer Ressource übergeben. `AWS::Lambda::Function`

 `Layers`   <a name="sam-function-layers"></a>
Die Liste `LayerVersion` ARNs , die diese Funktion verwenden soll. Die hier angegebene Reihenfolge ist die Reihenfolge, in der sie importiert werden, wenn die Lambda-Funktion ausgeführt wird. Die Version ist entweder ein vollständiger ARN einschließlich der Version oder ein Verweis auf eine LayerVersion Ressource. Zum Beispiel `LayerVersion` wird ein Verweis auf a sein, `!Ref MyLayer` während ein vollständiger ARN einschließlich der Version sein wird`arn:aws:lambda:region:account-id:layer:layer-name:version`.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Layers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-layers)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `LoggingConfig`   <a name="sam-function-loggingconfig"></a>
Die Amazon CloudWatch Logs-Konfigurationseinstellungen der Funktion.  
*Typ:* [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-loggingconfig.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-loggingconfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-loggingconfig)Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `MemorySize`   <a name="sam-function-memorysize"></a>
Die Größe des Speichers in MB, der pro Aufruf der Funktion zugewiesen wird.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MemorySize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-memorysize)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `PackageType`   <a name="sam-function-packagetype"></a>
Der Bereitstellungspakettyp der Lambda-Funktion. Weitere Informationen finden Sie unter [Lambda-Bereitstellungspakete](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) im *AWS Lambda Developer Guide*.  
**Hinweise:**  
1. Wenn diese Eigenschaft auf `Zip` (Standard) gesetzt ist, `InlineCode` gilt entweder `CodeUri` oder und `ImageUri` wird ignoriert.  
2. Wenn diese Eigenschaft auf gesetzt ist`Image`, `ImageUri` gilt nur, `CodeUri` und beide `InlineCode` werden ignoriert. Das Amazon ECR-Repository, das zum Speichern des Container-Images der Funktion erforderlich ist, kann auto von der AWS SAMCLI erstellt werden. Weitere Informationen finden Sie unter [sam deploy](sam-cli-command-reference-sam-deploy.md).  
*Zulässige Werte*: `Zip` oder `Image`.  
*Typ:* Zeichenfolge  
*Required*: No  
*Standardwert*: `Zip`  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[PackageType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-packagetype)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `PermissionsBoundary`   <a name="sam-function-permissionsboundary"></a>
Der ARN einer Berechtigungsgrenze, die für die Ausführungsrolle dieser Funktion verwendet werden soll. Diese Eigenschaft funktioniert nur, wenn die Rolle für Sie generiert wurde.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[PermissionsBoundary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary)` Eigenschaft einer `AWS::IAM::Role` Ressource übergeben.

 `Policies`   <a name="sam-function-policies"></a>
Berechtigungsrichtlinien für diese Funktion. Richtlinien werden an die Standardausführungsrolle AWS Identity and Access Management (IAM) der Funktion angehängt.  
Diese Eigenschaft akzeptiert einen einzelnen Wert oder eine Liste von Werten. Gültige Werte sind:  
+ [AWS SAM Richtlinienvorlagen](serverless-policy-templates.md).
+ Die ARN einer [AWS verwalteten Richtlinie](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#aws-managed-policies) oder einer vom [Kunden verwalteten Richtlinie](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#customer-managed-policies).
+ Der Name einer AWS verwalteten Richtlinie aus der folgenden [Liste](https://github.com/aws/serverless-application-model/blob/develop/samtranslator/internal/data/aws_managed_policies.json).
+ Eine YAML als Map formatierte [Inline-IAM-Richtlinie](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#inline-policies).
Wenn Sie die `Role` Eigenschaft festlegen, wird diese Eigenschaft ignoriert.
*Typ*: Zeichenfolge \$1 Liste \$1 Karte  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[Policies](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-policies)` Eigenschaft einer `AWS::IAM::Role` Ressource.

 `PublishToLatestPublished`   <a name="sam-function-publishtolatestpublished"></a>
Gibt an, ob die neueste Funktionsversion veröffentlicht werden soll, wenn die Funktion aktualisiert wird.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[PublishToLatestPublished](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-publishtolatestpublished)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

`PropagateTags`  <a name="sam-function-propagatetags"></a>
Geben Sie an, ob Tags von der `Tags` Eigenschaft an Ihre [AWS::Serverless::Function](sam-specification-generated-resources-function.md) generierten Ressourcen übergeben werden sollen oder nicht. Geben Sie `True` an, dass Tags in Ihren generierten Ressourcen verbreitet werden sollen.  
*Typ*: Boolesch  
*Required*: No  
*Standardwert*: `False`  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `ProvisionedConcurrencyConfig`   <a name="sam-function-provisionedconcurrencyconfig"></a>
Die bereitgestellte Parallelitätskonfiguration des Alias einer Funktion.  
`ProvisionedConcurrencyConfig`kann nur angegeben werden, wenn der gesetzt `AutoPublishAlias` ist. Andernfalls tritt ein Fehler auf.
*Typ:* [ProvisionedConcurrencyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ProvisionedConcurrencyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig)` Eigenschaft einer `AWS::Lambda::Alias` Ressource übergeben.

 `RecursiveLoop`   <a name="sam-function-recursiveloop"></a>
Der Status der Konfiguration der rekursiven Schleifenerkennung Ihrer Funktion.  
Wenn dieser Wert auf gesetzt ist `Allow` und Lambda erkennt, dass Ihre Funktion als Teil einer rekursiven Schleife aufgerufen wird, ergreift es keine Aktion.  
Wenn dieser Wert auf gesetzt ist `Terminate` und Lambda erkennt, dass Ihre Funktion als Teil einer rekursiven Schleife aufgerufen wird, stoppt es den Aufruf Ihrer Funktion und benachrichtigt Sie.   
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die Eigenschaft der `[RecursiveLoop](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-recursiveloop)` Ressource übergeben. `AWS::Lambda::Function`

 `ReservedConcurrentExecutions`   <a name="sam-function-reservedconcurrentexecutions"></a>
Die maximale Anzahl gleichzeitiger Ausführungen, die Sie für die Funktion reservieren möchten.  
Weitere Informationen zu dieser Eigenschaft finden Sie unter [Lambda Function Scaling](https://docs.aws.amazon.com/lambda/latest/dg/scaling.html) im *AWS Lambda Developer Guide*.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ReservedConcurrentExecutions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-reservedconcurrentexecutions)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `Role`   <a name="sam-function-role"></a>
Der ARN einer IAM-Rolle, die als Ausführungsrolle dieser Funktion verwendet werden soll.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-role)` Eigenschaft einer `AWS::Lambda::Function` Ressource. Dies ist in erforderlich CloudFormation , aber nicht in AWS SAM. Wenn keine Rolle angegeben ist, wird für Sie eine mit der logischen ID von erstellt`<function-logical-id>Role`.

 `RolePath`   <a name="sam-function-rolepath"></a>
Der Pfad zur IAM-Ausführungsrolle der Funktion.  
Verwenden Sie diese Eigenschaft, wenn die Rolle für Sie generiert wird. Nicht verwenden, wenn die Rolle mit der `Role` Eigenschaft angegeben ist.  
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Path](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-path)` Eigenschaft einer `AWS::IAM::Role` Ressource übergeben.

 `Runtime`   <a name="sam-function-runtime"></a>
Die ID der [Laufzeit](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) der Funktion. Diese Eigenschaft ist nur erforderlich, wenn die `PackageType` Eigenschaft auf gesetzt ist`Zip`.  
Wenn Sie den `provided` Bezeichner für diese Eigenschaft angeben, können Sie das `Metadata` Ressourcenattribut verwenden, um anzuweisen, die benutzerdefinierte Laufzeit AWS SAM zu erstellen, die für diese Funktion erforderlich ist. Weitere Informationen zum Erstellen benutzerdefinierter Laufzeiten finden Sie unter. [Erstellen von Lambda-Funktionen mit benutzerdefinierten Laufzeiten in AWS SAM](building-custom-runtimes.md)
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Runtime](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtime)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `RuntimeManagementConfig`   <a name="sam-function-runtimemanagementconfig"></a>
Konfigurieren Sie Laufzeitverwaltungsoptionen für Ihre Lambda-Funktionen wie Updates der Laufzeitumgebung, Rollback-Verhalten und Auswahl einer bestimmten Laufzeitversion. Weitere Informationen finden Sie unter [Lambda Runtime Updates](https://docs.aws.amazon.com//lambda/latest/dg/runtimes-update.html) im *AWS Lambda Developer Guide*.  
*Typ:* [RuntimeManagementConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ RuntimeManagementConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `SnapStart`   <a name="sam-function-snapstart"></a>
Erstellen Sie einen Snapshot einer beliebigen neuen Lambda-Funktionsversion. Ein Snapshot ist ein zwischengespeicherter Status Ihrer initialisierten Funktion, einschließlich all ihrer Abhängigkeiten. Die Funktion wird nur einmal initialisiert und der zwischengespeicherte Status wird für alle future Aufrufe wiederverwendet, wodurch die Anwendungsleistung verbessert wird, indem die Häufigkeit, mit der Ihre Funktion initialisiert werden muss, reduziert wird. Weitere Informationen finden Sie unter [Verbessern der Startleistung mit Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) im *AWS Lambda Entwicklerhandbuch*.  
*Typ:* [SnapStart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[SnapStart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `SourceKMSKeyArn`   <a name="sam-function-sourcekmskeyarn"></a>
Stellt einen KMS-Schlüssel-ARN dar, der zur Verschlüsselung des ZIP-Funktionscodes des Kunden verwendet wird.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[SourceKMSKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-sourcekmskeyarn)` Eigenschaft eines `AWS::Lambda::Function` `Code` Datentyps übergeben.

 `Tags`   <a name="sam-function-tags"></a>
Eine Zuordnung (von Zeichenfolge zu Zeichenfolge), die die zu dieser Funktion hinzugefügten Tags angibt. Einzelheiten zu gültigen Schlüsseln und Werten für Tags finden Sie unter [Anforderungen an Tagschlüssel und -werte](https://docs.aws.amazon.com/lambda/latest/dg/configuration-tags.html#configuration-tags-restrictions) im *AWS Lambda Entwicklerhandbuch*.  
Wenn der Stack erstellt wird, fügt er dieser Lambda-Funktion und den Standardrollen, die für diese Funktion generiert werden, AWS SAM automatisch ein `lambda:createdBy:SAM` Tag hinzu.  
*Typ*: Karte  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tags)` Eigenschaft einer `AWS::Lambda::Function` Ressource. Die `Tags` Eigenschaft in AWS SAM besteht aus Schlüssel-Wert-Paaren (wohingegen CloudFormation diese Eigenschaft aus einer Liste von `Tag` Objekten besteht). Fügt dieser Lambda-Funktion und den Standardrollen, die für diese Funktion generiert werden, außerdem AWS SAM automatisch ein `lambda:createdBy:SAM` Tag hinzu.

 `TenancyConfig`   <a name="sam-function-tenancyconfig"></a>
Konfiguration für den Lambda-Mandantenisolationsmodus. Stellt sicher, dass Ausführungsumgebungen niemals von verschiedenen Mandanten gemeinsam genutzt werden IDs, sodass Anwendungen mit mehreren Mandanten isoliert werden können.  
*Typ:* [TenancyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-tenancyconfig.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[TenancyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tenancyconfig)` Eigenschaft einer Ressource übergeben. `AWS::Lambda::Function`

 `Timeout`   <a name="sam-function-timeout"></a>
Die maximale Zeit in Sekunden, während der die Funktion ausgeführt werden kann, bevor sie beendet wird.  
*Typ*: Ganzzahl  
*Required*: No  
*Standard:* 3  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Timeout](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-timeout)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `Tracing`   <a name="sam-function-tracing"></a>
Die Zeichenfolge, die den X-Ray-Tracing-Modus der Funktion angibt.  
+ `Active`— Aktiviert die Röntgenverfolgung für die Funktion.
+ `Disabled`— Deaktiviert X-Ray für die Funktion.
+ `PassThrough`— Aktiviert die Röntgenverfolgung für die Funktion. Die Entscheidung über die Probenahme wird an die nachgelagerten Dienststellen delegiert.
Wenn als `Active` oder angegeben `PassThrough` und die `Role` Eigenschaft nicht festgelegt ist, wird die `arn:aws:iam::aws:policy/AWSXrayWriteOnlyAccess` Richtlinie der Lambda-Ausführungsrolle AWS SAM hinzugefügt, die sie für Sie erstellt.  
Weitere Informationen zu X-Ray finden Sie [unter AWS Lambda Using with AWS X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/lambda-x-ray.html) im *AWS Lambda Developer Guide*.  
*Gültige Werte*: [`Active`\$1 `Disabled` \$1`PassThrough`]  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[TracingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tracingconfig)` Eigenschaft einer `AWS::Lambda::Function` Ressource.

 `VersionDescription`   <a name="sam-function-versiondescription"></a>
Gibt das `Description` Feld an, das der neuen Lambda-Versionsressource hinzugefügt wird.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-description)` Eigenschaft einer `AWS::Lambda::Version` Ressource übergeben.

 `VersionDeletionPolicy`   <a name="sam-function-versiondeletionpolicy"></a>
Gibt die Löschrichtlinie für die Lambda-Versionsressource an, die erstellt wird, wenn sie festgelegt `AutoPublishAlias` ist. Dies steuert, ob die Versionsressource beibehalten oder gelöscht wird, wenn der Stack gelöscht wird.  
*Gültige Werte*: `Delete`, `Retain`, oder `Snapshot`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent. Sie legt das `DeletionPolicy` Attribut für die generierte `AWS::Lambda::Version` Ressource fest.

 `VpcConfig`   <a name="sam-function-vpcconfig"></a>
Die Konfiguration, die dieser Funktion den Zugriff auf private Ressourcen innerhalb Ihrer Virtual Private Cloud (VPC) ermöglicht.  
*Typ:* [VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

## Rückgabewerte
<a name="sam-resource-function-return-values"></a>

### Punkt
<a name="sam-resource-function-return-values-ref"></a>

Wenn die logische ID dieser Ressource für die `Ref` systeminterne Funktion bereitgestellt wird, gibt sie den Ressourcennamen der zugrunde liegenden Lambda-Funktion zurück.

*Weitere Informationen zur Verwendung der `Ref` Funktion finden Sie [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)im AWS CloudFormation Benutzerhandbuch.* 

### Fn:: GetAtt
<a name="sam-resource-function-return-values-fn--getatt"></a>

`Fn::GetAtt` gibt einen Wert für ein angegebenes Attribut dieses Typs zurück. Im Folgenden sehen Sie die verfügbaren Attribute und Beispielrückgabewerte. 

Weitere Informationen zur Verwendung `Fn::GetAtt` finden Sie [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html)im *AWS CloudFormation Benutzerhandbuch*. 

`Arn`  <a name="Arn-fn::getatt"></a>
Der ARN der zugrunde liegenden Lambda-Funktion.

## Beispiele
<a name="sam-resource-function-examples"></a>

### Einfache Funktion
<a name="sam-resource-function-examples-simple-function"></a>

Im Folgenden finden Sie ein grundlegendes Beispiel für eine [AWS::Serverless::Function](#sam-resource-function) Ressource mit Pakettyp `Zip` (Standard) und Funktionscode in einem Amazon S3 S3-Bucket.

#### YAML
<a name="sam-resource-function-examples-simple-function--yaml"></a>

```
Type: AWS::Serverless::Function
Properties:
  Handler: index.handler
  Runtime: python3.9
  CodeUri: s3://bucket-name/key-name
```

### Beispiel für Funktionseigenschaften
<a name="sam-resource-function-examples-function-properties-example"></a>

Im Folgenden finden Sie ein Beispiel für einen [AWS::Serverless::Function](#sam-resource-function) Pakettyp `Zip` (Standard)`InlineCode`, der`Layers`,`Tracing`, `Policies``Amazon EFS`, und eine `Api` Ereignisquelle verwendet.

#### YAML
<a name="sam-resource-function-examples-function-properties-example--yaml"></a>

```
Type: AWS::Serverless::Function
DependsOn: MyMountTarget        # This is needed if an AWS::EFS::MountTarget resource is declared for EFS
Properties:
  Handler: index.handler
  Runtime: python3.9
  InlineCode: |
    def handler(event, context):
      print("Hello, world!")
  ReservedConcurrentExecutions: 30
  Layers:
    - Ref: MyLayer
  Tracing: Active
  Timeout: 120
  FileSystemConfigs:
    - Arn: !Ref MyEfsFileSystem
      LocalMountPath: /mnt/EFS
  Policies:
    - AWSLambdaExecute
    - Version: '2012-10-17		 	 	 ' 
      Statement:
        - Effect: Allow
          Action:
            - s3:GetObject
            - s3:GetObjectACL
          Resource: 'arn:aws:s3:::sam-s3-demo-bucket/*'
  Events:
    ApiEvent:
      Type: Api
      Properties:
        Path: /path
        Method: get
```

### ImageConfig Beispiel
<a name="sam-resource-function-examples-imageconfig-example"></a>

Das Folgende ist ein Beispiel `ImageConfig` für eine Lambda-Funktion vom Pakettyp`Image`.

#### YAML
<a name="sam-resource-function-examples-imageconfig-example--yaml"></a>

```
HelloWorldFunction:
  Type: AWS::Serverless::Function
  Properties:
    PackageType: Image
    ImageUri: account-id.dkr.ecr.region.amazonaws.com/ecr-repo-name:image-name
    ImageConfig:
      Command:
        - "app.lambda_handler"
      EntryPoint:
        - "entrypoint1"
      WorkingDirectory: "workDir"
```

### RuntimeManagementConfig Beispiele
<a name="sam-resource-function-examples-runtimemanagementconfig-examples"></a>

Eine Lambda-Funktion, die so konfiguriert ist, dass sie ihre Laufzeitumgebung entsprechend dem aktuellen Verhalten aktualisiert:

```
TestFunction
  Type: AWS::Serverless::Function
  Properties:
    ...
    Runtime: python3.9
    RuntimeManagementConfig:
      UpdateRuntimeOn: Auto
```

Eine Lambda-Funktion, die so konfiguriert ist, dass sie ihre Laufzeitumgebung aktualisiert, wenn die Funktion aktualisiert wird:

```
TestFunction
  Type: AWS::Serverless::Function
  Properties:
    ...
    Runtime: python3.9
    RuntimeManagementConfig:
      UpdateRuntimeOn: FunctionUpdate
```

Eine Lambda-Funktion, die so konfiguriert ist, dass sie ihre Laufzeitumgebung manuell aktualisiert:

```
TestFunction
  Type: AWS::Serverless::Function
  Properties:
    ...
    Runtime: python3.9
    RuntimeManagementConfig:
      RuntimeVersionArn: arn:aws:lambda:us-east-1::runtime:4c459dd0104ee29ec65dcad056c0b3ddbe20d6db76b265ade7eda9a066859b1e
      UpdateRuntimeOn: Manual
```

### SnapStart Beispiele
<a name="sam-resource-function-examples-snapstart-examples"></a>

Beispiel für eine Lambda-Funktion, die für future Versionen SnapStart aktiviert ist:

```
TestFunc
  Type: AWS::Serverless::Function
  Properties:
    ...
    SnapStart:
      ApplyOn: PublishedVersions
```

### TenancyConfig Beispiele
<a name="sam-resource-function-examples-tenancyconfig-examples"></a>

Beispiel für eine Lambda-Funktion mit aktiviertem Mandantenisolationsmodus:

```
TestFunction
  Type: AWS::Serverless::Function
  Properties:
    ...
    TenancyConfig:
      TenantIsolationMode: PER_TENANT
```

# DeadLetterQueue
<a name="sam-property-function-deadletterqueue"></a>

Gibt eine SQS-Warteschlange oder ein SNS-Thema an, an das AWS Lambda (Lambda) Ereignisse sendet, wenn sie nicht verarbeitet werden können. *Weitere Informationen zur Funktionalität von Warteschlangen für unzustellbare Briefe finden Sie unter [Warteschlangen für unzustellbare Briefe](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-dlq) im Entwicklerhandbuch.AWS Lambda *

SAM fügt Ihrer Lambda-Funktionsausführungsrolle automatisch die entsprechende Berechtigung hinzu, um dem Lambda-Dienst Zugriff auf die Ressource zu gewähren. sqs: SendMessage wird für SQS-Warteschlangen und sns:Publish für SNS-Themen hinzugefügt.

## Syntax
<a name="sam-property-function-deadletterqueue-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage () zu deklarieren. AWS Serverless Application Model AWS SAM

### YAML
<a name="sam-property-function-deadletterqueue-syntax.yaml"></a>

```
  [TargetArn](#sam-function-deadletterqueue-targetarn): String
  [Type](#sam-function-deadletterqueue-type): String
```

## Eigenschaften
<a name="sam-property-function-deadletterqueue-properties"></a>

 `TargetArn`   <a name="sam-function-deadletterqueue-targetarn"></a>
Der Amazon-Ressourcenname (ARN) einer Amazon SQS-Warteschlange oder eines Amazon SNS-Themas.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[TargetArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html#cfn-lambda-function-deadletterconfig-targetarn)` Eigenschaft des `AWS::Lambda::Function` `DeadLetterConfig` Datentyps übergeben.

 `Type`   <a name="sam-function-deadletterqueue-type"></a>
Der Typ der Warteschlange für unzustellbare Nachrichten.  
*Zulässige Werte*: `SNS`, `SQS`  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-function-deadletterqueue--examples"></a>

### DeadLetterQueue
<a name="sam-property-function-deadletterqueue--examples--deadletterqueue"></a>

Beispiel für eine Dead-Letter-Warteschlange für ein SNS-Thema.

#### YAML
<a name="sam-property-function-deadletterqueue--examples--deadletterqueue--yaml"></a>

```
DeadLetterQueue:
  Type: SNS
  TargetArn: arn:aws:sns:us-east-2:123456789012:my-topic
```

# DeploymentPreference
<a name="sam-property-function-deploymentpreference"></a>

Gibt die Konfigurationen an, um schrittweise Lambda-Bereitstellungen zu ermöglichen. Weitere Informationen zur Konfiguration schrittweiser Lambda-Bereitstellungen finden Sie unter. [Schrittweise Bereitstellung serverloser Anwendungen mit AWS SAM](automating-updates-to-serverless-apps.md)

**Anmerkung**  
Sie müssen ein `AutoPublishAlias` in Ihrem angeben[AWS::Serverless::Function](sam-resource-function.md), um ein `DeploymentPreference` Objekt verwenden zu können, andernfalls tritt ein Fehler auf.

## Syntax
<a name="sam-property-function-deploymentpreference-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-deploymentpreference-syntax.yaml"></a>

```
  [Alarms](#sam-function-deploymentpreference-alarms): List
  [Enabled](#sam-function-deploymentpreference-enabled): Boolean
  [Hooks](#sam-function-deploymentpreference-hooks): Hooks
  [PassthroughCondition](#sam-function-deploymentpreference-passthroughcondition): Boolean
  [Role](#sam-function-deploymentpreference-role): String
  [TriggerConfigurations](#sam-function-deploymentpreference-triggerconfigurations): List
  [Type](#sam-function-deploymentpreference-type): String
```

## Eigenschaften
<a name="sam-property-function-deploymentpreference-properties"></a>

 `Alarms`   <a name="sam-function-deploymentpreference-alarms"></a>
Eine Liste von CloudWatch Alarmen, die durch alle durch die Bereitstellung ausgelösten Fehler ausgelöst werden sollen.  
Diese Eigenschaft akzeptiert die `Fn::If` intrinsische Funktion. Im Abschnitt Beispiele am Ende dieses Themas finden Sie eine Beispielvorlage, die verwendet. `Fn::If`  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Enabled`   <a name="sam-function-deploymentpreference-enabled"></a>
Ob diese Bereitstellungspräferenz aktiviert ist.  
*Typ*: Boolesch  
*Required*: No  
*Standard*: Wahr  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Hooks`   <a name="sam-function-deploymentpreference-hooks"></a>
Validierung Lambda-Funktionen, die vor und nach der Verkehrsverlagerung ausgeführt werden.  
*[Typ: Hooks](sam-property-function-hooks.md)*  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig AWS SAM und hat kein CloudFormation Äquivalent.

 `PassthroughCondition`   <a name="sam-function-deploymentpreference-passthroughcondition"></a>
Bei True und wenn diese Bereitstellungseinstellung aktiviert ist, wird die Bedingung der Funktion an die generierte CodeDeploy Ressource weitergegeben. Im Allgemeinen sollten Sie dies auf True setzen. Andernfalls würde die CodeDeploy Ressource auch dann erstellt, wenn die Bedingung der Funktion auf False aufgelöst wird.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Role`   <a name="sam-function-deploymentpreference-role"></a>
Ein ARN mit einer IAM-Rolle, der für die Verkehrsverlagerung verwendet CodeDeploy wird. Eine IAM-Rolle wird nicht erstellt, wenn diese bereitgestellt wird.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `TriggerConfigurations`   <a name="sam-function-deploymentpreference-triggerconfigurations"></a>
Eine Liste der Triggerkonfigurationen, die Sie der Bereitstellungsgruppe zuordnen möchten. Wird verwendet, um ein SNS-Thema über Lebenszyklusereignisse zu informieren.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[TriggerConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-triggerconfigurations)` Eigenschaft einer `AWS::CodeDeploy::DeploymentGroup` Ressource übergeben.

 `Type`   <a name="sam-function-deploymentpreference-type"></a>
Derzeit gibt es zwei Kategorien von Bereitstellungstypen: Linear und Canary. Weitere Informationen zu den verfügbaren Bereitstellungstypen finden Sie unter[Schrittweise Bereitstellung serverloser Anwendungen mit AWS SAM](automating-updates-to-serverless-apps.md).  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-function-deploymentpreference--examples"></a>

### DeploymentPreference mit Haken vor und nach dem Verkehr.
<a name="sam-property-function-deploymentpreference--examples--deploymentpreference-with-pre--and-post-traffic-hooks."></a>

Beispiel für eine Bereitstellungspräferenz, die Hooks vor und nach dem Traffic enthält.

#### YAML
<a name="sam-property-function-deploymentpreference--examples--deploymentpreference-with-pre--and-post-traffic-hooks.--yaml"></a>

```
DeploymentPreference:
  Enabled: true
  Type: Canary10Percent10Minutes 
  Alarms:
    - !Ref: AliasErrorMetricGreaterThanZeroAlarm
    - !Ref: LatestVersionErrorMetricGreaterThanZeroAlarm
  Hooks:
    PreTraffic:
      !Ref: PreTrafficLambdaFunction
    PostTraffic:
      !Ref: PostTrafficLambdaFunction
```

### DeploymentPreference mit der intrinsischen Funktion Fn: :If
<a name="sam-property-function-deploymentpreference--examples--deploymentpreference-with-fn::if-intrinsic-function"></a>

Beispiel für eine Bereitstellungspräferenz, die `Fn::If` für die Konfiguration von Alarmen verwendet wird. In diesem Beispiel `Alarm1` wird konfiguriert, ob dies der Fall `MyCondition` ist`true`, `Alarm2` und `Alarm5` wird konfiguriert, wenn dies der Fall `MyCondition` ist`false`.

#### YAML
<a name="sam-property-function-deploymentpreference--examples--deploymentpreference-with-fn::if-intrinsic-function--yaml"></a>

```
DeploymentPreference:
  Enabled: true
  Type: Canary10Percent10Minutes 
  Alarms:
    Fn::If:
      - MyCondition
      - - Alarm1
      - - Alarm2
        - Alarm5
```

# Hooks
<a name="sam-property-function-hooks"></a>

Validierung Lambda-Funktionen, die vor und nach der Verkehrsverlagerung ausgeführt werden.

**Anmerkung**  
Die Lambda-Funktionen, auf die in dieser Eigenschaft verwiesen wird, konfigurieren das `CodeDeployLambdaAliasUpdate` Objekt der resultierenden [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html)Ressource. Weitere Informationen finden Sie unter [CodeDeployLambdaAliasUpdate Richtlinie](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-codedeploylambdaaliasupdate) im *AWS CloudFormation Benutzerhandbuch*.

## Syntax
<a name="sam-property-function-hooks-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-hooks-syntax.yaml"></a>

```
  [PostTraffic](#sam-function-hooks-posttraffic): String
  [PreTraffic](#sam-function-hooks-pretraffic): String
```

## Eigenschaften
<a name="sam-property-function-hooks-properties"></a>

 `PostTraffic`   <a name="sam-function-hooks-posttraffic"></a>
Lambda-Funktion, die nach einer Verkehrsverlagerung ausgeführt wird.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `PreTraffic`   <a name="sam-function-hooks-pretraffic"></a>
Lambda-Funktion, die vor der Verkehrsverlagerung ausgeführt wird.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-function-hooks--examples"></a>

### Hook
<a name="sam-property-function-hooks--examples--hooks"></a>

Beispiele für Hook-Funktionen

#### YAML
<a name="sam-property-function-hooks--examples--hooks--yaml"></a>

```
Hooks:
  PreTraffic:
    Ref: PreTrafficLambdaFunction
  PostTraffic:
    Ref: PostTrafficLambdaFunction
```

# DurableConfig
<a name="sam-property-function-durableconfig"></a>

Konfiguriert dauerhafte Ausführungseinstellungen für AWS Lambda Funktionen. Dauerhafte Funktionen können bis zu einem Jahr lang ausgeführt werden und überprüfen den Fortschritt automatisch, sodass Workflows mit langer Laufzeit und fehlertolerante Anwendungen ermöglicht werden. Weitere Informationen zu dauerhaften Funktionen finden Sie unter [Dauerhafte Lambda-Funktionen](https://docs.aws.amazon.com/lambda/latest/dg/durable-functions.html) im *AWS Lambda Entwicklerhandbuch*.

## Syntax
<a name="sam-property-function-durableconfig-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS Serverless Application Model (AWS SAM) -Vorlage zu deklarieren.

### YAML
<a name="sam-property-function-durableconfig-syntax.yaml"></a>

```
  [ExecutionTimeout](#sam-function-durableconfig-executiontimeout): Integer
  [RetentionPeriodInDays](#sam-function-durableconfig-retentionperiodindays): Integer
```

## Eigenschaften
<a name="sam-property-function-durableconfig-properties"></a>

 `ExecutionTimeout`   <a name="sam-function-durableconfig-executiontimeout"></a>
Die Zeitspanne (in Sekunden), die Lambda einer dauerhaften Funktion ermöglicht, bevor sie gestoppt wird. Das Maximum ist ein Jahr mit 366 Tagen oder 31.622.400 Sekunden.  
*Typ*: Ganzzahl  
*Erforderlich*: Ja  
*Minimum*: 1  
*Maximum*: 31622400  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ExecutionTimeout](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-durableconfig.html#cfn-lambda-function-durableconfig-executiontimeout)` Eigenschaft des `AWS::Lambda::Function` `DurableConfig` Datentyps übergeben.

 `RetentionPeriodInDays`   <a name="sam-function-durableconfig-retentionperiodindays"></a>
Die Anzahl der Tage, an denen Lambda nach Abschluss einer dauerhaften Ausführung seinen Verlauf beibehält, von einem bis 90 Tagen. Der Standardwert ist 14 Tage.  
*Typ*: Ganzzahl  
*Required*: No  
*Standard*: 14  
*Minimum*: 1  
*Maximal*: 90  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[RetentionPeriodInDays](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-durableconfig.html#cfn-lambda-function-durableconfig-retentionperiodindays)` Eigenschaft des `AWS::Lambda::Function` `DurableConfig` Datentyps übergeben.

## Beispiele
<a name="sam-property-function-durableconfig--examples"></a>

### DurableConfig
<a name="sam-property-function-durableconfig--examples--durableconfig"></a>

Beispiel für eine dauerhafte Konfiguration für eine Funktion mit einem Ausführungstimeout von 1 Stunde und einer Aufbewahrungsfrist von 7 Tagen.

#### YAML
<a name="sam-property-function-durableconfig--examples--durableconfig--yaml"></a>

```
DurableConfig:
  ExecutionTimeout: 3600
  RetentionPeriodInDays: 7
```

# EventInvokeConfiguration
<a name="sam-property-function-eventinvokeconfiguration"></a>

Konfigurationsoptionen für [asynchrone](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html) Lambda-Alias- oder Versionsaufrufe.

## Syntax
<a name="sam-property-function-eventinvokeconfiguration-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-eventinvokeconfiguration-syntax.yaml"></a>

```
  [DestinationConfig](#sam-function-eventinvokeconfiguration-destinationconfig): EventInvokeDestinationConfiguration
  [MaximumEventAgeInSeconds](#sam-function-eventinvokeconfiguration-maximumeventageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-eventinvokeconfiguration-maximumretryattempts): Integer
```

## Eigenschaften
<a name="sam-property-function-eventinvokeconfiguration-properties"></a>

 `DestinationConfig`   <a name="sam-function-eventinvokeconfiguration-destinationconfig"></a>
Ein Konfigurationsobjekt, das das Ziel eines Ereignisses angibt, nachdem Lambda es verarbeitet hat.  
*Typ:* [EventInvokeDestinationConfiguration](sam-property-function-eventinvokedestinationconfiguration.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html)` Eigenschaft einer `AWS::Lambda::EventInvokeConfig` Ressource. SAM benötigt einen zusätzlichen Parameter, „Type“, der in nicht existiert CloudFormation.

 `MaximumEventAgeInSeconds`   <a name="sam-function-eventinvokeconfiguration-maximumeventageinseconds"></a>
Das maximale Alter einer Anforderung, die Lambda an eine Funktion zur Verarbeitung sendet.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MaximumEventAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumeventageinseconds)` Eigenschaft einer `AWS::Lambda::EventInvokeConfig` Ressource übergeben.

 `MaximumRetryAttempts`   <a name="sam-function-eventinvokeconfiguration-maximumretryattempts"></a>
Die maximale Anzahl von Wiederholungen, bis die Funktion einen Fehler zurückgibt.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumretryattempts)` Eigenschaft einer `AWS::Lambda::EventInvokeConfig` Ressource übergeben.

## Beispiele
<a name="sam-property-function-eventinvokeconfiguration--examples"></a>

### MaximumEventAgeInSeconds
<a name="sam-property-function-eventinvokeconfiguration--examples--maximumeventageinseconds"></a>

MaximumEventAgeInSeconds Beispiel

#### YAML
<a name="sam-property-function-eventinvokeconfiguration--examples--maximumeventageinseconds--yaml"></a>

```
EventInvokeConfig:
  MaximumEventAgeInSeconds: 60
  MaximumRetryAttempts: 2
  DestinationConfig:
    OnSuccess:
      Type: SQS
      Destination: arn:aws:sqs:us-west-2:012345678901:my-queue
    OnFailure:
      Type: Lambda
      Destination: !GetAtt DestinationLambda.Arn
```

# EventInvokeDestinationConfiguration
<a name="sam-property-function-eventinvokedestinationconfiguration"></a>

Ein Konfigurationsobjekt, das das Ziel eines Ereignisses angibt, nachdem Lambda es verarbeitet hat.

## Syntax
<a name="sam-property-function-eventinvokedestinationconfiguration-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-eventinvokedestinationconfiguration-syntax.yaml"></a>

```
  [OnFailure](#sam-function-eventinvokedestinationconfiguration-onfailure): OnFailure
  [OnSuccess](#sam-function-eventinvokedestinationconfiguration-onsuccess): OnSuccess
```

## Eigenschaften
<a name="sam-property-function-eventinvokedestinationconfiguration-properties"></a>

 `OnFailure`   <a name="sam-function-eventinvokedestinationconfiguration-onfailure"></a>
Ein Ziel für Ereignisse, bei denen die Verarbeitung fehlgeschlagen ist.  
*Typ:* [OnFailure](sam-property-function-onfailure.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[OnFailure](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onfailure.html)` Eigenschaft einer `AWS::Lambda::EventInvokeConfig` Ressource. Erfordert eine zusätzliche Eigenschaft`Type`, die nur für SAM bestimmt ist.

 `OnSuccess`   <a name="sam-function-eventinvokedestinationconfiguration-onsuccess"></a>
Ein Ziel für Ereignisse, die erfolgreich verarbeitet wurden.  
*Typ:* [OnSuccess](sam-property-function-onsuccess.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[OnSuccess](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onsuccess)` Eigenschaft einer `AWS::Lambda::EventInvokeConfig` Ressource. Erfordert eine zusätzliche Eigenschaft`Type`, die nur für SAM bestimmt ist.

## Beispiele
<a name="sam-property-function-eventinvokedestinationconfiguration--examples"></a>

### OnSuccess
<a name="sam-property-function-eventinvokedestinationconfiguration--examples--onsuccess"></a>

OnSuccess Beispiel

#### YAML
<a name="sam-property-function-eventinvokedestinationconfiguration--examples--onsuccess--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SQS
      Destination: arn:aws:sqs:us-west-2:012345678901:my-queue
    OnFailure:
      Type: Lambda
      Destination: !GetAtt DestinationLambda.Arn
```

# OnFailure
<a name="sam-property-function-onfailure"></a>

Ein Ziel für Ereignisse, bei denen die Verarbeitung fehlgeschlagen ist.

## Syntax
<a name="sam-property-function-onfailure-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-onfailure-syntax.yaml"></a>

```
  [Destination](#sam-function-onfailure-destination): String
  [Type](#sam-function-onfailure-type): String
```

## Eigenschaften
<a name="sam-property-function-onfailure-properties"></a>

 `Destination`   <a name="sam-function-onfailure-destination"></a>
Der Amazon-Ressourcenname (ARN) der Zielressource.  
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[OnFailure](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onfailure.html)` Eigenschaft einer `AWS::Lambda::EventInvokeConfig` Ressource. SAM fügt der automatisch generierten IAM-Rolle, die mit dieser Funktion verknüpft ist, alle erforderlichen Berechtigungen hinzu, um auf die in dieser Eigenschaft referenzierte Ressource zuzugreifen.  
*Zusätzliche Hinweise*: Wenn der Typ Lambda/ istEventBridge, ist Destination erforderlich.

 `Type`   <a name="sam-function-onfailure-type"></a>
Typ der Ressource, auf die im Ziel verwiesen wird. Unterstützte Typen sind `SQS``SNS`,`S3`,`Lambda`, und`EventBridge`.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.  
*Zusätzliche Hinweise*: Wenn der Typ ist SQS/SNS und die `Destination` Eigenschaft leer gelassen wird, wird die SQS/SNS Ressource auto von SAM generiert. Um auf die Ressource zu verweisen, verwenden Sie `<function-logical-id>.DestinationQueue` für SQS oder `<function-logical-id>.DestinationTopic` für SNS. Wenn der Typ Lambda/ istEventBridge, `Destination` ist dies erforderlich.

## Beispiele
<a name="sam-property-function-onfailure--examples"></a>

### EventInvoke Konfigurationsbeispiel mit SQS- und Lambda-Zielen
<a name="sam-property-function-onfailure--examples--eventinvoke-configuration-example-with-sqs-and-lambda-destinations"></a>

In diesem Beispiel wurde kein Ziel für die OnSuccess SQS-Konfiguration angegeben, daher erstellt SAM implizit eine SQS-Warteschlange und fügt alle erforderlichen Berechtigungen hinzu. Auch für dieses Beispiel wird ein Ziel für eine in der Vorlagendatei deklarierte Lambda-Ressource in der OnFailure Konfiguration angegeben, sodass SAM dieser Lambda-Funktion die erforderlichen Berechtigungen zum Aufrufen der Lambda-Zielfunktion hinzufügt.

#### YAML
<a name="sam-property-function-onfailure--examples--eventinvoke-configuration-example-with-sqs-and-lambda-destinations--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SQS
    OnFailure:
      Type: Lambda
      Destination: !GetAtt DestinationLambda.Arn  # Arn of a Lambda function declared in the template file.
```

### EventInvoke Konfigurationsbeispiel mit SNS-Ziel
<a name="sam-property-function-onfailure--examples--eventinvoke-configuration-example-with-sns-destination"></a>

In diesem Beispiel wird ein Ziel für ein SNS-Thema angegeben, das in der Vorlagendatei für die OnSuccess Konfiguration deklariert ist.

#### YAML
<a name="sam-property-function-onfailure--examples--eventinvoke-configuration-example-with-sns-destination--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SNS
      Destination:
        Ref: DestinationSNS       # Arn of an SNS topic declared in the tempate file
```

# OnSuccess
<a name="sam-property-function-onsuccess"></a>

Ein Ziel für Ereignisse, die erfolgreich verarbeitet wurden.

## Syntax
<a name="sam-property-function-onsuccess-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-onsuccess-syntax.yaml"></a>

```
  [Destination](#sam-function-onsuccess-destination): String
  [Type](#sam-function-onsuccess-type): String
```

## Eigenschaften
<a name="sam-property-function-onsuccess-properties"></a>

 `Destination`   <a name="sam-function-onsuccess-destination"></a>
Der Amazon-Ressourcenname (ARN) der Zielressource.  
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[OnSuccess](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onsuccess)` Eigenschaft einer `AWS::Lambda::EventInvokeConfig` Ressource. SAM fügt der automatisch generierten IAM-Rolle, die mit dieser Funktion verknüpft ist, alle erforderlichen Berechtigungen hinzu, um auf die in dieser Eigenschaft referenzierte Ressource zuzugreifen.  
*Zusätzliche Hinweise*: Wenn der Typ Lambda/ istEventBridge, ist Destination erforderlich.

 `Type`   <a name="sam-function-onsuccess-type"></a>
Typ der Ressource, auf die im Ziel verwiesen wird. Unterstützte Typen sind `SQS``SNS`,`S3`,`Lambda`, und`EventBridge`.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.  
*Zusätzliche Hinweise*: Wenn der Typ ist SQS/SNS und die `Destination` Eigenschaft leer gelassen wird, wird die SQS/SNS Ressource auto von SAM generiert. Um auf die Ressource zu verweisen, verwenden Sie `<function-logical-id>.DestinationQueue` für SQS oder `<function-logical-id>.DestinationTopic` für SNS. Wenn der Typ Lambda/ istEventBridge, `Destination` ist dies erforderlich.

## Beispiele
<a name="sam-property-function-onsuccess--examples"></a>

### EventInvoke Konfigurationsbeispiel mit SQS- und Lambda-Destinationen
<a name="sam-property-function-onsuccess--examples--eventinvoke-configuration-example-with-sqs-and-lambda-destinations"></a>

In diesem Beispiel wurde kein Ziel für die OnSuccess SQS-Konfiguration angegeben, daher erstellt SAM implizit eine SQS-Warteschlange und fügt alle erforderlichen Berechtigungen hinzu. Auch für dieses Beispiel wird ein Ziel für eine in der Vorlagendatei deklarierte Lambda-Ressource in der OnFailure Konfiguration angegeben, sodass SAM dieser Lambda-Funktion die erforderlichen Berechtigungen zum Aufrufen der Lambda-Zielfunktion hinzufügt.

#### YAML
<a name="sam-property-function-onsuccess--examples--eventinvoke-configuration-example-with-sqs-and-lambda-destinations--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SQS
    OnFailure:
      Type: Lambda
      Destination: !GetAtt DestinationLambda.Arn  # Arn of a Lambda function declared in the template file.
```

### EventInvoke Konfigurationsbeispiel mit SNS-Ziel
<a name="sam-property-function-onsuccess--examples--eventinvoke-configuration-example-with-sns-destination"></a>

In diesem Beispiel wird ein Ziel für ein SNS-Thema angegeben, das in der Vorlagendatei für die OnSuccess Konfiguration deklariert ist.

#### YAML
<a name="sam-property-function-onsuccess--examples--eventinvoke-configuration-example-with-sns-destination--yaml"></a>

```
EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SNS
      Destination:
        Ref: DestinationSNS       # Arn of an SNS topic declared in the tempate file
```

# EventSource
<a name="sam-property-function-eventsource"></a>

Das Objekt, das die Quelle der Ereignisse beschreibt, die die Funktion auslösen. Jedes Ereignis besteht aus einem Typ und einer Reihe von Eigenschaften, die von diesem Typ abhängen. Weitere Informationen zu den Eigenschaften der einzelnen Ereignisquellen finden Sie in dem entsprechenden Thema.

## Syntax
<a name="sam-property-function-eventsource-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS Serverless Application Model (AWS SAM) -Vorlage zu deklarieren.

### YAML
<a name="sam-property-function-eventsource-syntax.yaml"></a>

```
  [Properties](#sam-function-eventsource-properties): AlexaSkill | Api | CloudWatchEvent | CloudWatchLogs | Cognito | DocumentDB | DynamoDB | EventBridgeRule | HttpApi | IoTRule | Kinesis | MQ | MSK | S3 | Schedule | ScheduleV2 | SelfManagedKafka | SNS | SQS
  [Type](#sam-function-eventsource-type): String
```

## Eigenschaften
<a name="sam-property-function-eventsource-properties"></a>

 `Properties`   <a name="sam-function-eventsource-properties"></a>
Objekt, das die Eigenschaften dieser Event-Mapping beschreibt. Der Satz von Eigenschaften muss dem definierten Typ entsprechen.  
*Typ* [[[: [AlexaSkill](sam-property-function-alexaskill.md)\$1 [Api](sam-property-function-api.md) \$1 \$1 [CloudWatchEvent](sam-property-function-cloudwatchevent.md)\$1 [Cognito [CloudWatchLogs](sam-property-function-cloudwatchlogs.md)](sam-property-function-cognito.md)\$1 [DocumentDB \$1 [DynamoDB](sam-property-function-dynamodb.md)](sam-property-function-documentdb.md) \$1 \$1 \$1 [Io [EventBridgeRule](sam-property-function-eventbridgerule.md)](sam-property-function-iotrule.md)\$1 [Kinesis [HttpApi](sam-property-function-httpapi.md)](sam-property-function-kinesis.md)\$1 [MQ TRule](sam-property-function-mq.md) \$1 [MSK](sam-property-function-msk.md) \$1 [S3 \$1 [Zeitplan](sam-property-function-schedule.md) \$1 ScheduleV2 \$1 \$1 SNS \$1 SQS [SelfManagedKafka](sam-property-function-selfmanagedkafka.md)](sam-property-function-s3.md)](sam-property-function-sqs.md)](sam-property-function-sns.md)](sam-property-function-schedulev2.md)  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für und hat kein Äquivalent. AWS SAM CloudFormation 

 `Type`   <a name="sam-function-eventsource-type"></a>
Der Ereignistyp.  
*Gültige Werte*: `AlexaSkill` `Api``CloudWatchEvent`,`CloudWatchLogs`,`Cognito`,`DocumentDB`,`DynamoDB`,`EventBridgeRule`,`HttpApi`,`IoTRule`,`Kinesis`, `MQ``MSK`,`S3`,`Schedule`,`ScheduleV2`,`SelfManagedKafka`,`SNS`, `SQS`  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-function-eventsource--examples"></a>

### APIEvent
<a name="sam-property-function-eventsource--examples--apievent"></a>

Beispiel für die Verwendung eines API-Ereignisses

#### YAML
<a name="sam-property-function-eventsource--examples--apievent--yaml"></a>

```
ApiEvent:
  Type: Api
  Properties:
    Method: get
    Path: /group/{user}
    RestApiId: 
      Ref: MyApi
```

# AlexaSkill
<a name="sam-property-function-alexaskill"></a>

Das Objekt, das einen `AlexaSkill` Ereignisquellentyp beschreibt.

## Syntax
<a name="sam-property-function-alexaskill-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-alexaskill-syntax.yaml"></a>

```
  [SkillId](#sam-function-alexaskill-skillid): String
```

## Eigenschaften
<a name="sam-property-function-alexaskill-properties"></a>

 `SkillId`   <a name="sam-function-alexaskill-skillid"></a>
Die Alexa Skill ID für Ihren Alexa Skill. Weitere Informationen zur Skill-ID finden [Sie unter Konfigurieren des Triggers für eine Lambda-Funktion](https://developer.amazon.com/docs/custom-skills/host-a-custom-skill-as-an-aws-lambda-function.html#configuring-the-alexa-skills-kit-trigger) in der Alexa Skills Kit-Dokumentation.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-function-alexaskill--examples"></a>

### AlexaSkillTrigger
<a name="sam-property-function-alexaskill--examples--alexaskilltrigger"></a>

Beispiel für ein Alexa Skill-Event

#### YAML
<a name="sam-property-function-alexaskill--examples--alexaskilltrigger--yaml"></a>

```
AlexaSkillEvent:
  Type: AlexaSkill
```

# Api
<a name="sam-property-function-api"></a>

Das Objekt, das einen `Api` Ereignisquellentyp beschreibt. Wenn eine [AWS::Serverless::Api](sam-resource-api.md) Ressource definiert ist, müssen der Pfad und die Methodenwerte einer Operation in der OpenAPI-Definition der API entsprechen.

Wenn nein definiert [AWS::Serverless::Api](sam-resource-api.md) ist, stellen die Eingabe und Ausgabe der Funktion die HTTP-Anfrage und die HTTP-Antwort dar.

Mithilfe der JavaScript API können beispielsweise der statusCode und der Hauptteil der Antwort gesteuert werden, indem ein Objekt mit den Schlüsseln StatusCode und body zurückgegeben wird.

## Syntax
<a name="sam-property-function-api-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-api-syntax.yaml"></a>

```
  [Auth](#sam-function-api-auth): ApiFunctionAuth
  [Method](#sam-function-api-method): String
  [Path](#sam-function-api-path): String
  [RequestModel](#sam-function-api-requestmodel): RequestModel
  [RequestParameters](#sam-function-api-requestparameters): List of [ String | RequestParameter ]
  [RestApiId](#sam-function-api-restapiid): String
  [ResponseTransferMode](#sam-function-api-responsetransfermode): String
  TimeoutInMillis: Integer
```

## Eigenschaften
<a name="sam-property-function-api-properties"></a>

 `Auth`   <a name="sam-function-api-auth"></a>
Authentifizierungskonfiguration für diese spezielle API\$1Path\$1Methode.  
Nützlich, um die Authentifizierungskonfiguration der `DefaultAuthorizer` API-Einstellung für einen einzelnen Pfad zu überschreiben, wenn kein Pfad angegeben `DefaultAuthorizer` ist, oder um die Standardeinstellung zu überschreiben. `ApiKeyRequired`  
*Typ:* [ApiFunctionAuth](sam-property-function-apifunctionauth.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. CloudFormation 

 `Method`   <a name="sam-function-api-method"></a>
HTTP-Methode, für die diese Funktion aufgerufen wird. Zu den Optionen gehören `DELETE``GET`,`HEAD`,`OPTIONS`,`PATCH`, `POST``PUT`, und`ANY`. Einzelheiten finden Sie unter [HTTP-Methode einrichten](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-settings-method-request.html#setup-method-add-http-method) im *API Gateway Developer Guide*.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Path`   <a name="sam-function-api-path"></a>
URI-Pfad, für den diese Funktion aufgerufen wird. Muss mit `/` beginnen.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig AWS SAM und hat kein CloudFormation Äquivalent.

 `RequestModel`   <a name="sam-function-api-requestmodel"></a>
Fordern Sie das Modell an, das für diese spezielle API\$1Path\$1Methode verwendet werden soll. Dies sollte auf den Namen eines Modells verweisen, das im `Models` Abschnitt einer Ressource angegeben ist. [AWS::Serverless::Api](sam-resource-api.md)  
*Typ:* [RequestModel](sam-property-function-requestmodel.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `RequestParameters`   <a name="sam-function-api-requestparameters"></a>
Fordern Sie die Parameterkonfiguration für diese spezielle API\$1Path\$1Methode an. Alle Parameternamen müssen mit, oder beginnen `method.request` und darauf beschränkt `method.request.header` sein. `method.request.querystring` `method.request.path`  
Eine Liste kann sowohl Zeichenketten als auch [RequestParameter](sam-property-function-requestparameter.md)Objekte mit Parameternamen enthalten. Bei Zeichenketten sind die `Caching` Eigenschaften `Required` und standardmäßig auf eingestellt`false`.  
*Typ*: Liste von [Zeichenfolge \$1 [RequestParameter](sam-property-function-requestparameter.md)]  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `RestApiId`   <a name="sam-function-api-restapiid"></a>
Bezeichner einer RestApi Ressource, die eine Operation mit dem angegebenen Pfad und der angegebenen Methode enthalten muss. In der Regel ist dies so eingestellt, dass es auf eine in dieser Vorlage definierte [AWS::Serverless::Api](sam-resource-api.md) Ressource verweist.  
Wenn Sie diese Eigenschaft nicht definieren, AWS SAM wird mithilfe eines generierten `OpenApi` Dokuments eine [AWS::Serverless::Api](sam-resource-api.md) Standardressource erstellt. Diese Ressource enthält eine Vereinigung aller Pfade und Methoden, die durch `Api` Ereignisse in derselben Vorlage definiert wurden, ohne dass a angegeben ist`RestApiId`.  
Dies kann nicht auf eine [AWS::Serverless::Api](sam-resource-api.md) Ressource verweisen, die in einer anderen Vorlage definiert ist.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

`ResponseTransferMode`  <a name="sam-function-api-responsetransfermode"></a>
Der Antwortübertragungsmodus für die Lambda-Funktionsintegration. Wird auf gesetzt`RESPONSE_STREAM`, um Lambda-Antwort-Streaming über API Gateway zu aktivieren, sodass die Funktion Antworten zurück an Clients streamen kann. Wenn auf gesetzt`RESPONSE_STREAM`, verwendet API Gateway die InvokeWithResponseStreaming Lambda-API.  
*Typ:* Zeichenfolge  
*Required*: No  
*Gültige Werte*: `BUFFERED` \$1 `RESPONSE_STREAM`  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-responsetransfermode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-responsetransfermode)Eigenschaft eines `AWS::ApiGateway::Method Integration` übergeben.

`TimeoutInMillis`  <a name="sam-function-api-timeoutinmillis"></a>
Benutzerdefinierte Zeitüberschreitung zwischen 50 und 29.000 Millisekunden.  
Wenn Sie diese Eigenschaft angeben, AWS SAM wird Ihre OpenAPI-Definition geändert. Die OpenAPI-Definition muss mithilfe der `DefinitionBody` Eigenschaft inline angegeben werden. 
*Typ*: Ganzzahl  
*Required*: No  
*Standard*: 29.000 Millisekunden oder 29 Sekunden  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. CloudFormation 

## Beispiele
<a name="sam-property-function-api--examples"></a>

### Einfaches Beispiel
<a name="sam-property-function-api--examples--apievent"></a>

#### YAML
<a name="sam-property-function-api--examples--apievent--yaml"></a>

```
Events:
  ApiEvent:
    Type: Api
    Properties:
      Path: /path
      Method: get
      RequestParameters:
        - method.request.header.Authorization
        - method.request.querystring.keyword:
            Required: true
            Caching: false
```

# ApiFunctionAuth
<a name="sam-property-function-apifunctionauth"></a>

Konfiguriert die Autorisierung auf Ereignisebene für eine bestimmte API, einen bestimmten Pfad und eine Methode.

## Syntax
<a name="sam-property-function-apifunctionauth-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-apifunctionauth-syntax.yaml"></a>

```
  [ApiKeyRequired](#sam-function-apifunctionauth-apikeyrequired): Boolean
  [AuthorizationScopes](#sam-function-apifunctionauth-authorizationscopes): List
  [Authorizer](#sam-function-apifunctionauth-authorizer): String
  [InvokeRole](#sam-function-apifunctionauth-invokerole): String
  OverrideApiAuth: Boolean
  [ResourcePolicy](#sam-function-apifunctionauth-resourcepolicy): ResourcePolicyStatement
```

## Eigenschaften
<a name="sam-property-function-apifunctionauth-properties"></a>

 `ApiKeyRequired`   <a name="sam-function-apifunctionauth-apikeyrequired"></a>
Erfordert einen API-Schlüssel für diese API, diesen Pfad und diese Methode.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `AuthorizationScopes`   <a name="sam-function-apifunctionauth-authorizationscopes"></a>
Die Autorisierungsbereiche, die für diese API, diesen Pfad und diese Methode gelten sollen.  
Die von Ihnen angegebenen Bereiche haben Vorrang vor allen Bereichen, die von der `DefaultAuthorizer` Eigenschaft angewendet werden, sofern Sie sie angegeben haben.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Authorizer`   <a name="sam-function-apifunctionauth-authorizer"></a>
Die `Authorizer` für eine bestimmte Funktion.  
Wenn Sie für Ihre `AWS::Serverless::Api` Ressource einen globalen Autorisierer angegeben haben, können Sie den Autorisierer überschreiben, indem Sie auf setzen`Authorizer`. `NONE` Ein Beispiel finden Sie unter [Überschreiben Sie einen globalen Autorisierer für Ihre Amazon API Gateway Gateway-REST-API](#sam-property-function-apifunctionauth--examples--override).  
Wenn Sie die `DefinitionBody` Eigenschaft einer `AWS::Serverless::Api` Ressource verwenden, um Ihre API zu beschreiben, müssen Sie `OverrideApiAuth` with verwenden, um Ihren globalen `Authorizer` Autorisierer zu überschreiben. Weitere Informationen finden Sie unter `OverrideApiAuth`.
*Gültige Werte*: `AWS_IAM``NONE`, oder die logische ID für jeden in Ihrer AWS SAM Vorlage definierten Authorizer.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `InvokeRole`   <a name="sam-function-apifunctionauth-invokerole"></a>
Gibt an, welche für `InvokeRole` die `AWS_IAM` Autorisierung verwendet werden soll.  
*Typ:* Zeichenfolge  
*Required*: No  
*Standardwert*: `CALLER_CREDENTIALS`  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.  
*Zusätzliche Hinweise*: `CALLER_CREDENTIALS` Mappings to`arn:aws:iam:::<user>/`, das die Anmeldeinformationen des Anrufers verwendet, um den Endpunkt aufzurufen.

`OverrideApiAuth`  <a name="sam-function-apifunctionauth-overrideapiauth"></a>
Geben Sie `true` an, ob die globale Autorisierungskonfiguration Ihrer Ressource überschrieben werden soll. `AWS::Serverless::Api` Diese Eigenschaft ist nur erforderlich, wenn Sie einen globalen Autorisierer angeben und die `DefinitionBody` Eigenschaft einer `AWS::Serverless::Api` Ressource verwenden, um Ihre API zu beschreiben.  
Wenn Sie `OverrideApiAuth` als angeben`true`, AWS SAM wird Ihr globaler Autorisierer mit allen für `ApiKeyRequired``Authorizer`, oder angegebenen Werten überschrieben. `ResourcePolicy` Daher muss bei der Verwendung `OverrideApiAuth` mindestens eine dieser Eigenschaften ebenfalls angegeben werden. Ein Beispiel finden Sie unter [Überschreiben Sie einen globalen Autorisierer, wenn DefinitionBody für AWS::Serverless::Api angegeben ist](#sam-property-function-apifunctionauth--examples--override2).
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `ResourcePolicy`   <a name="sam-function-apifunctionauth-resourcepolicy"></a>
Konfigurieren Sie die Ressourcenrichtlinie für diesen Pfad auf einer API.  
*Typ:* [ResourcePolicyStatement](sam-property-function-resourcepolicystatement.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-function-apifunctionauth--examples"></a>

### Funktions-Auth
<a name="sam-property-function-apifunctionauth--examples--function-auth"></a>

Das folgende Beispiel spezifiziert die Autorisierung auf Funktionsebene.

#### YAML
<a name="sam-property-function-apifunctionauth--examples--function-auth--yaml"></a>

```
Auth:
  ApiKeyRequired: true
  Authorizer: NONE
```

### Überschreiben Sie einen globalen Autorisierer für Ihre Amazon API Gateway Gateway-REST-API
<a name="sam-property-function-apifunctionauth--examples--override"></a>

Sie können einen globalen Autorisierer für Ihre `AWS::Serverless::Api` Ressource angeben. Im Folgenden finden Sie ein Beispiel für die Konfiguration eines globalen Standardautorisierers:

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyApiWithLambdaRequestAuth:
    Type: AWS::Serverless::Api
    Properties:
      ...
      Auth:
        Authorizers:
          MyLambdaRequestAuth:
            FunctionArn: !GetAtt MyAuthFn.Arn
        DefaultAuthorizer: MyLambdaRequestAuth
```

Um den Standardautorisierer für Ihre AWS Lambda Funktion zu überschreiben, können Sie als angeben. `Authorizer` `NONE` Im Folgenden wird ein Beispiel gezeigt:

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  ...
  MyFn:
    Type: AWS::Serverless::Function
    Properties:
      ...
      Events:
        LambdaRequest:
          Type: Api
          Properties:
            RestApiId: !Ref MyApiWithLambdaRequestAuth
            Method: GET
            Auth:
              Authorizer: NONE
```

### Überschreiben Sie einen globalen Autorisierer, wenn DefinitionBody für AWS::Serverless::Api angegeben ist
<a name="sam-property-function-apifunctionauth--examples--override2"></a>

Wenn Sie die `DefinitionBody` Eigenschaft zur Beschreibung Ihrer `AWS::Serverless::Api` Ressource verwenden, funktioniert die vorherige Override-Methode nicht. Im Folgenden finden Sie ein Beispiel für die Verwendung der `DefinitionBody` Eigenschaft für eine `AWS::Serverless::Api` Ressource:

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyApiWithLambdaRequestAuth:
    Type: AWS::Serverless::Api
    Properties:
      ...
      DefinitionBody:
        swagger: 2.0
        ...
        paths:
          /lambda-request:
            ...
      Auth:
        Authorizers:
          MyLambdaRequestAuth:
            FunctionArn: !GetAtt MyAuthFn.Arn
        DefaultAuthorizer: MyLambdaRequestAuth
```

Verwenden Sie die `OverrideApiAuth` Eigenschaft, um den globalen Autorisierer zu überschreiben. Im Folgenden finden Sie ein Beispiel, das verwendet wird, `OverrideApiAuth` um den globalen Autorisierer mit dem für angegebenen Wert zu überschreiben: `Authorizer`

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyApiWithLambdaRequestAuth:
    Type: AWS::Serverless::Api
    Properties:
      ...
      DefinitionBody:
        swagger: 2-0
        ...
        paths:
          /lambda-request:
            ...
      Auth:
        Authorizers:
          MyLambdaRequestAuth:
            FunctionArn: !GetAtt MyAuthFn.Arn
        DefaultAuthorizer: MyLambdaRequestAuth
    
    MyAuthFn:
      Type: AWS::Serverless::Function
      ...
    
    MyFn:
      Type: AWS::Serverless::Function
        Properties:
          ...
          Events:
            LambdaRequest:
              Type: Api
              Properties:
                RestApiId: !Ref MyApiWithLambdaRequestAuth
                Method: GET
                Auth:
                  Authorizer: NONE
                  OverrideApiAuth: true
                Path: /lambda-token
```

# ResourcePolicyStatement
<a name="sam-property-function-resourcepolicystatement"></a>

Konfiguriert eine Ressourcenrichtlinie für alle Methoden und Pfade einer API. Weitere Informationen zu Ressourcenrichtlinien finden Sie unter [Steuern des Zugriffs auf eine API mit API-Gateway-Ressourcenrichtlinien](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies.html) im *API Gateway Developer Guide*.

## Syntax
<a name="sam-property-function-resourcepolicystatement-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-resourcepolicystatement-syntax.yaml"></a>

```
  [AwsAccountBlacklist](#sam-function-resourcepolicystatement-awsaccountblacklist): List
  [AwsAccountWhitelist](#sam-function-resourcepolicystatement-awsaccountwhitelist): List
  [CustomStatements](#sam-function-resourcepolicystatement-customstatements): List
  [IntrinsicVpcBlacklist](#sam-function-resourcepolicystatement-intrinsicvpcblacklist): List
  [IntrinsicVpcWhitelist](#sam-function-resourcepolicystatement-intrinsicvpcwhitelist): List
  [IntrinsicVpceBlacklist](#sam-function-resourcepolicystatement-intrinsicvpceblacklist): List
  [IntrinsicVpceWhitelist](#sam-function-resourcepolicystatement-intrinsicvpcewhitelist): List
  [IpRangeBlacklist](#sam-function-resourcepolicystatement-iprangeblacklist): List
  [IpRangeWhitelist](#sam-function-resourcepolicystatement-iprangewhitelist): List
  [SourceVpcBlacklist](#sam-function-resourcepolicystatement-sourcevpcblacklist): List
  [SourceVpcWhitelist](#sam-function-resourcepolicystatement-sourcevpcwhitelist): List
```

## Eigenschaften
<a name="sam-property-function-resourcepolicystatement-properties"></a>

 `AwsAccountBlacklist`   <a name="sam-function-resourcepolicystatement-awsaccountblacklist"></a>
Die zu blockierenden AWS Konten.  
*Typ*: Liste von Zeichenfolgen  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig AWS SAM und hat kein CloudFormation Äquivalent.

 `AwsAccountWhitelist`   <a name="sam-function-resourcepolicystatement-awsaccountwhitelist"></a>
Die AWS Konten, die zugelassen werden sollen. Ein Beispiel für die Verwendung dieser Eigenschaft finden Sie im Abschnitt Beispiele unten auf dieser Seite.  
*Typ*: Liste von Zeichenfolgen  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `CustomStatements`   <a name="sam-function-resourcepolicystatement-customstatements"></a>
Eine Liste von benutzerdefinierten Ressourcenrichtlinien-Anweisungen, die auf diese API angewendet werden sollen. Ein Beispiel für die Verwendung dieser Eigenschaft finden Sie im Abschnitt Beispiele unten auf dieser Seite.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `IntrinsicVpcBlacklist`   <a name="sam-function-resourcepolicystatement-intrinsicvpcblacklist"></a>
Die Liste der zu blockierenden virtuellen privaten Clouds (VPCs), wobei jede VPC als Referenz angegeben ist, z. B. als [dynamische Referenz](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) oder als `Ref` [intrinsische Funktion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). Ein Beispiel für die Verwendung dieser Eigenschaft finden Sie im Abschnitt Beispiele unten auf dieser Seite.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `IntrinsicVpcWhitelist`   <a name="sam-function-resourcepolicystatement-intrinsicvpcwhitelist"></a>
Die Liste der VPCs Zulässigen, wobei jede VPC als Referenz angegeben wird, z. B. als [dynamische Referenz](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) oder als `Ref` [intrinsische Funktion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig AWS SAM und hat kein Äquivalent. CloudFormation 

 `IntrinsicVpceBlacklist`   <a name="sam-function-resourcepolicystatement-intrinsicvpceblacklist"></a>
[Die Liste der zu blockierenden VPC-Endpunkte, wobei jeder VPC-Endpunkt als Referenz angegeben ist, z. B. als [dynamische Referenz oder als intrinsische](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) Funktion. `Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. CloudFormation 

 `IntrinsicVpceWhitelist`   <a name="sam-function-resourcepolicystatement-intrinsicvpcewhitelist"></a>
[Die Liste der VPC-Endpunkte, die zugelassen werden sollen, wobei jeder VPC-Endpunkt als Referenz angegeben ist, z. B. als [dynamische Referenz](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) oder als systemeigene Funktion. `Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) Ein Beispiel für die Verwendung dieser Eigenschaft finden Sie im Abschnitt Beispiele unten auf dieser Seite.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `IpRangeBlacklist`   <a name="sam-function-resourcepolicystatement-iprangeblacklist"></a>
Die IP-Adressen oder Adressbereiche, die blockiert werden sollen. Ein Beispiel für die Verwendung dieser Eigenschaft finden Sie im Abschnitt Beispiele unten auf dieser Seite.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `IpRangeWhitelist`   <a name="sam-function-resourcepolicystatement-iprangewhitelist"></a>
Die IP-Adressen oder Adressbereiche, die zugelassen werden sollen.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `SourceVpcBlacklist`   <a name="sam-function-resourcepolicystatement-sourcevpcblacklist"></a>
Die Quell-VPC oder die VPC-Endpoints, die blockiert werden sollen. Quell-VPC-Namen müssen mit beginnen `"vpc-"` und Quell-VPC-Endpunktnamen müssen mit beginnen. `"vpce-"` Ein Beispiel für die Verwendung dieser Eigenschaft finden Sie im Abschnitt Beispiele unten auf dieser Seite.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `SourceVpcWhitelist`   <a name="sam-function-resourcepolicystatement-sourcevpcwhitelist"></a>
Die Quell-VPC oder VPC-Endpoints, die zugelassen werden sollen. Quell-VPC-Namen müssen mit beginnen `"vpc-"` und Quell-VPC-Endpunktnamen müssen mit beginnen. `"vpce-"`  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-function-resourcepolicystatement--examples"></a>

### Beispiel für eine Ressourcenrichtlinie
<a name="sam-property-function-resourcepolicystatement--examples--resource-policy-example"></a>

Das folgende Beispiel blockiert zwei IP-Adressen und eine Quell-VPC und lässt ein AWS Konto zu.

#### YAML
<a name="sam-property-function-resourcepolicystatement--examples--resource-policy-example--yaml"></a>

```
Auth:
  ResourcePolicy:
    CustomStatements: [{
                         "Effect": "Allow",
                         "Principal": "*",
                         "Action": "execute-api:Invoke",
                         "Resource": "execute-api:/Prod/GET/pets",
                         "Condition": {
                           "IpAddress": {
                             "aws:SourceIp": "1.2.3.4"
                           }
                         }
                       }]
    IpRangeBlacklist:
      - "10.20.30.40"
      - "1.2.3.4"
    SourceVpcBlacklist:
      - "vpce-1a2b3c4d"
    AwsAccountWhitelist:
      - "111122223333"
    IntrinsicVpcBlacklist:
      - "{{resolve:ssm:SomeVPCReference:1}}" 
      - !Ref MyVPC
    IntrinsicVpceWhitelist:
      - "{{resolve:ssm:SomeVPCEReference:1}}" 
      - !Ref MyVPCE
```

# RequestModel
<a name="sam-property-function-requestmodel"></a>

Konfiguriert ein Anforderungsmodell für eine bestimmte API\$1Path\$1Methode.

## Syntax
<a name="sam-property-function-requestmodel-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS Serverless Application Model (AWS SAM) -Vorlage zu deklarieren.

### YAML
<a name="sam-property-function-requestmodel-syntax.yaml"></a>

```
  [Model](#sam-function-requestmodel-model): String
  [Required](#sam-function-requestmodel-required): Boolean
  [ValidateBody](#sam-function-requestmodel-validatebody): Boolean
  [ValidateParameters](#sam-function-requestmodel-validateparameters): Boolean
```

## Eigenschaften
<a name="sam-property-function-requestmodel-properties"></a>

 `Model`   <a name="sam-function-requestmodel-model"></a>
Name eines Modells, das in der Models-Eigenschaft von definiert ist[AWS::Serverless::Api](sam-resource-api.md).  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Required`   <a name="sam-function-requestmodel-required"></a>
Fügt dem Parameterbereich der OpenApi Definition eine `required` Eigenschaft für den angegebenen API-Endpunkt hinzu.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `ValidateBody`   <a name="sam-function-requestmodel-validatebody"></a>
Gibt an, ob API Gateway den verwendet`Model`, um den Anfragetext zu validieren. Weitere Informationen finden Sie unter [Aktivieren der Anforderungsvalidierung in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) im *API Gateway Developer Guide*.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `ValidateParameters`   <a name="sam-function-requestmodel-validateparameters"></a>
Gibt an, ob API Gateway die `Model` zur Überprüfung von Anforderungspfadparametern, Abfragezeichenfolgen und Headern verwendet. Weitere Informationen finden Sie unter [Aktivieren der Anforderungsvalidierung in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) im *API Gateway Developer Guide*.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-function-requestmodel--examples"></a>

### Anforderungsmodell
<a name="sam-property-function-requestmodel--examples--request-model"></a>

Beispiel für ein Modell anfordern

#### YAML
<a name="sam-property-function-requestmodel--examples--request-model--yaml"></a>

```
RequestModel:
  Model: User
  Required: true
  ValidateBody: true
  ValidateParameters: true
```

# RequestParameter
<a name="sam-property-function-requestparameter"></a>

Konfigurieren Sie den Anforderungsparameter für eine bestimmte API\$1Path\$1Methode.

Für den `Required` `Caching` Anforderungsparameter muss entweder die Eigenschaft oder angegeben werden

## Syntax
<a name="sam-property-function-requestparameter-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-requestparameter-syntax.yaml"></a>

```
  [Caching](#sam-function-requestparameter-caching): Boolean
  [Required](#sam-function-requestparameter-required): Boolean
```

## Eigenschaften
<a name="sam-property-function-requestparameter-properties"></a>

 `Caching`   <a name="sam-function-requestparameter-caching"></a>
Fügt `cacheKeyParameters` einen Abschnitt zur OpenApi API-Gateway-Definition hinzu  
*Typ*: Boolesch  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Required`   <a name="sam-function-requestparameter-required"></a>
Dieses Feld gibt an, ob ein Parameter erforderlich ist  
*Typ*: Boolesch  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-function-requestparameter--examples"></a>

### Anfrageparameter
<a name="sam-property-function-requestparameter--examples--request-parameter"></a>

Beispiel für die Einstellung von Anforderungsparametern

#### YAML
<a name="sam-property-function-requestparameter--examples--request-parameter--yaml"></a>

```
RequestParameters:
  - method.request.header.Authorization:
      Required: true
      Caching: true
```

# CloudWatchEvent
<a name="sam-property-function-cloudwatchevent"></a>

Das Objekt, das einen `CloudWatchEvent` Ereignisquellentyp beschreibt.

AWS Serverless Application Model (AWS SAM) generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)Ressource, wenn dieser Ereignistyp gesetzt ist.

**Wichtiger Hinweis**: [EventBridgeRule](sam-property-function-eventbridgerule.md) ist der bevorzugte Typ der Ereignisquelle, der anstelle von verwendet wird`CloudWatchEvent`. `EventBridgeRule`und `CloudWatchEvent` verwenden Sie denselben zugrunde liegenden Dienst, dieselbe API und dieselben CloudFormation Ressourcen. AWS SAM Wird jedoch nur Unterstützung für neue Funktionen hinzufügen`EventBridgeRule`.

## Syntax
<a name="sam-property-function-cloudwatchevent-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-cloudwatchevent-syntax.yaml"></a>

```
  [Enabled](#sam-function-cloudwatchevent-enabled): Boolean
  [EventBusName](#sam-function-cloudwatchevent-eventbusname): String
  [Input](#sam-function-cloudwatchevent-input): String
  [InputPath](#sam-function-cloudwatchevent-inputpath): String
  [Pattern](#sam-function-cloudwatchevent-pattern): [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
  [State](#sam-function-cloudwatchevent-state): String
```

## Eigenschaften
<a name="sam-property-function-cloudwatchevent-properties"></a>

 `Enabled`   <a name="sam-function-cloudwatchevent-enabled"></a>
Gibt an, ob die Regel aktiviert ist.  
Um die Regel zu deaktivieren, setzen Sie diese Eigenschaft auf`false`.  
Geben Sie entweder die `State` Eigenschaft `Enabled` oder an, aber nicht beide.
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` Eigenschaft einer `AWS::Events::Rule` Ressource. Wenn diese Eigenschaft auf `true` gesetzt ist, gilt sie AWS SAM als erfolgreich`ENABLED`, andernfalls gilt sie als erfolgreich`DISABLED`.

 `EventBusName`   <a name="sam-function-cloudwatchevent-eventbusname"></a>
Der Ereignisbus, der dieser Regel zugeordnet werden soll. Wenn Sie diese Eigenschaft weglassen, AWS SAM wird der Standard-Event-Bus verwendet.  
*Typ:* Zeichenfolge  
*Required*: No  
*Standard: Standard-Event-Bus*  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[EventBusName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname)` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

 `Input`   <a name="sam-function-cloudwatchevent-input"></a>
Gültiger JSON-Text wurde an das Ziel übergeben. Wenn Sie diese Eigenschaft verwenden, wird nichts aus dem Ereignistext selbst an das Ziel weitergeleitet.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` Eigenschaft einer `AWS::Events::Rule Target` Ressource übergeben.

 `InputPath`   <a name="sam-function-cloudwatchevent-inputpath"></a>
Wenn Sie nicht das gesamte übereinstimmende Ereignis an das Ziel übergeben möchten, verwenden Sie die `InputPath` Eigenschaft, um zu beschreiben, welcher Teil des Ereignisses übergeben werden soll.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[InputPath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath)` Eigenschaft einer `AWS::Events::Rule Target` Ressource übergeben.

 `Pattern`   <a name="sam-function-cloudwatchevent-pattern"></a>
Beschreibt, welche Ereignisse an das angegebene Ziel weitergeleitet werden. Weitere Informationen finden Sie unter [Ereignisse und Ereignismuster EventBridge im EventBridge ](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) *Amazon-Benutzerhandbuch*.  
*Typ:* [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

 `State`   <a name="sam-function-cloudwatchevent-state"></a>
Der Status der Regel.  
*Zulässige Werte:* `DISABLED | ENABLED`  
Geben Sie entweder die `State` Eigenschaft `Enabled` oder an, aber nicht beide.
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

## Beispiele
<a name="sam-property-function-cloudwatchevent--examples"></a>

### CloudWatchEvent
<a name="sam-property-function-cloudwatchevent--examples--cloudwatchevent"></a>

Das Folgende ist ein Beispiel für einen `CloudWatchEvent` Ereignisquellentyp.

#### YAML
<a name="sam-property-function-cloudwatchevent--examples--cloudwatchevent--yaml"></a>

```
CWEvent:
  Type: CloudWatchEvent
  Properties:
    Enabled: false
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - running
```

# CloudWatchLogs
<a name="sam-property-function-cloudwatchlogs"></a>

Das Objekt, das einen `CloudWatchLogs` Ereignisquellentyp beschreibt.

Dieses Ereignis generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html)Ressource, spezifiziert einen Abonnementfilter und ordnet ihn der angegebenen Protokollgruppe zu.

## Syntax
<a name="sam-property-function-cloudwatchlogs-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-cloudwatchlogs-syntax.yaml"></a>

```
  [FilterPattern](#sam-function-cloudwatchlogs-filterpattern): String
  [LogGroupName](#sam-function-cloudwatchlogs-loggroupname): String
```

## Eigenschaften
<a name="sam-property-function-cloudwatchlogs-properties"></a>

 `FilterPattern`   <a name="sam-function-cloudwatchlogs-filterpattern"></a>
Die Filterausdrücke, die einschränken, was an die AWS Zielressource übermittelt wird. Weitere Informationen zur Syntax von Filtermustern finden Sie unter [Filters und Mustersyntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FilterPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-filterpattern)` Eigenschaft einer `AWS::Logs::SubscriptionFilter` Ressource übergeben.

 `LogGroupName`   <a name="sam-function-cloudwatchlogs-loggroupname"></a>
Die Protokollgruppe, die mit dem Abonnementfilter verknüpft werden soll. Alle Protokollereignisse, die in diese Protokollgruppe hochgeladen werden, werden gefiltert und an die angegebene AWS Ressource übermittelt, wenn das Filtermuster mit den Protokollereignissen übereinstimmt.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[LogGroupName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-loggroupname)` Eigenschaft einer `AWS::Logs::SubscriptionFilter` Ressource übergeben.

## Beispiele
<a name="sam-property-function-cloudwatchlogs--examples"></a>

### Cloudwatchlogs-Abonnementfilter
<a name="sam-property-function-cloudwatchlogs--examples--cloudwatchlogs-subscription-filter"></a>

Beispiel für einen Cloudwatchlogs-Abonnementfilter

#### YAML
<a name="sam-property-function-cloudwatchlogs--examples--cloudwatchlogs-subscription-filter--yaml"></a>

```
CWLog:
  Type: CloudWatchLogs
  Properties:
    LogGroupName:
      Ref: CloudWatchLambdaLogsGroup
    FilterPattern: My pattern
```

# Cognito
<a name="sam-property-function-cognito"></a>

Das Objekt, das einen `Cognito` Ereignisquellentyp beschreibt.

## Syntax
<a name="sam-property-function-cognito-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-cognito-syntax.yaml"></a>

```
  [Trigger](#sam-function-cognito-trigger): List
  [UserPool](#sam-function-cognito-userpool): String
```

## Eigenschaften
<a name="sam-property-function-cognito-properties"></a>

 `Trigger`   <a name="sam-function-cognito-trigger"></a>
Die Lambda-Auslösekonfiguration für den neuen Benutzerpool.  
*Typ*: Liste  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[LambdaConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html)` Eigenschaft einer `AWS::Cognito::UserPool` Ressource übergeben.

 `UserPool`   <a name="sam-function-cognito-userpool"></a>
Verweis auf, der in derselben Vorlage UserPool definiert ist  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-function-cognito--examples"></a>

### Cognito-Ereignis
<a name="sam-property-function-cognito--examples--cognito-event"></a>

Beispiel für ein Cognito-Event

#### YAML
<a name="sam-property-function-cognito--examples--cognito-event--yaml"></a>

```
CognitoUserPoolPreSignup:
  Type: Cognito
  Properties:
    UserPool:
      Ref: MyCognitoUserPool
    Trigger: PreSignUp
```

# DocumentDB
<a name="sam-property-function-documentdb"></a>

Das Objekt, das einen `DocumentDB` Ereignisquellentyp beschreibt. Weitere Informationen finden Sie unter [Using AWS Lambda with Amazon DocumentDB](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html) im *AWS Lambda Developer Guide*.

## Syntax
<a name="sam-property-function-documentdb-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS SAM Vorlage zu deklarieren.

### YAML
<a name="sam-property-function-documentdb-syntax-yaml"></a>

```
BatchSize: Integer
Cluster: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
CollectionName: String
DatabaseName: String
Enabled: Boolean
FilterCriteria: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
FullDocument: String
KmsKeyArn: String  
MaximumBatchingWindowInSeconds: Integer
SecretsManagerKmsKeyId: String
SourceAccessConfigurations: List
StartingPosition: String
StartingPositionTimestamp: Double
```

## Eigenschaften
<a name="sam-property-function-documentdb-properties"></a>

 `BatchSize`   <a name="sam-function-documentdb-batchsize"></a>
Gibt die maximale Anzahl der Elemente an, die in einem einzigen Stapel zurückzugeben werden.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `Cluster`   <a name="sam-function-documentdb-cluster"></a>
Der Amazon-Ressourcenname (ARN) des Amazon DocumentDB-Clusters.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `CollectionName`   <a name="sam-function-documentdb-collectionname"></a>
Der Name der Sammlung, die in der Datenbank verwendet werden soll. Wenn Sie keine Sammlung angeben, verbraucht Lambda alle Sammlungen.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ CollectionName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-collectionname)` Eigenschaft eines `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` Datentyps übergeben.

 `DatabaseName`   <a name="sam-function-documentdb-databasename"></a>
Der Name der Datenbank, die innerhalb des Amazon DocumentDB-Clusters verwendet werden soll.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ DatabaseName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-databasename)` Eigenschaft eines `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` Datentyps übergeben.

 `Enabled`   <a name="sam-function-documentdb-enabled"></a>
Falls`true`, ist die Zuordnung der Ereignisquelle aktiv. Um die Abfrage und den Aufruf zu unterbrechen, legen Sie den Wert auf fest. `false`  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `FilterCriteria`   <a name="sam-function-documentdb-filtercriteria"></a>
Ein Objekt, das die Kriterien definiert, die bestimmen, ob Lambda ein Ereignis verarbeiten soll. Weitere Informationen finden Sie unter [Lambda-Ereignisfilterung](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) im *AWS Lambda Developer Guide*.  
*Typ:* [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `FullDocument`   <a name="sam-function-documentdb-fulldocument"></a>
Legt fest, was Amazon DocumentDB bei Dokumentaktualisierungen an Ihren Event-Stream sendet. Wenn auf gesetzt`UpdateLookup`, sendet Amazon DocumentDB ein Delta, das die Änderungen beschreibt, zusammen mit einer Kopie des gesamten Dokuments. Andernfalls sendet Amazon DocumentDB nur einen Teil des Dokuments, das die Änderungen enthält.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ FullDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-fulldocument)` Eigenschaft eines `AWS::Lambda::EventSourceMapping` `DocumentDBEventSourceConfig` Datentyps übergeben.

 `KmsKeyArn`   <a name="sam-function-documentdb-kmskeyarn"></a>
Der Amazon-Ressourcenname (ARN) des Schlüssels zur Verschlüsselung von Informationen im Zusammenhang mit diesem Ereignis.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-documentdb-maximumbatchingwindowinseconds"></a>
Die maximale Zeitspanne zur Erfassung von Datensätzen vor dem Aufruf der Funktion in Sekunden.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `SecretsManagerKmsKeyId`   <a name="sam-function-documentdb-secretsmanagerkmskeyid"></a>
Die AWS Key Management Service (AWS KMS) Schlüssel-ID eines vom Kunden verwalteten Schlüssels von AWS Secrets Manager. Erforderlich, wenn Sie einen vom Kunden verwalteten Schlüssel von Secrets Manager mit einer Lambda-Ausführungsrolle verwenden, die die `kms:Decrypt` Berechtigung nicht enthält.  
Der Wert dieser Eigenschaft ist eine UUID. Beispiel: `1abc23d4-567f-8ab9-cde0-1fab234c5d67`.  
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `SourceAccessConfigurations`   <a name="sam-function-documentdb-sourceaccessconfigurations"></a>
Ein Array des Authentifizierungsprotokolls oder des virtuellen Hosts. Geben Sie dies mithilfe des [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html)Datentyps an.  
Für den Typ der `DocumentDB` Ereignisquelle ist der einzig gültige Konfigurationstyp`BASIC_AUTH`.  
+ `BASIC_AUTH`— Das Secrets Manager Manager-Geheimnis, in dem Ihre Broker-Anmeldeinformationen gespeichert werden. Für diesen Typ müssen die Anmeldeinformationen das folgende Format haben:`{"username": "your-username", "password": "your-password"}`. Nur ein Objekt des Typs `BASIC_AUTH` ist zulässig.
*Typ*: Liste  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `StartingPosition`   <a name="sam-function-documentdb-startingposition"></a>
Die Position im Stream, an der mit dem Lesen begonnen wird.  
+ `AT_TIMESTAMP`— Geben Sie einen Zeitpunkt an, ab dem mit dem Lesen von Datensätzen begonnen werden soll.
+ `LATEST`— Nur neue Datensätze lesen.
+ `TRIM_HORIZON`— Verarbeitet alle verfügbaren Datensätze.
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `StartingPositionTimestamp`   <a name="sam-function-documentdb-startingpositiontimestamp"></a>
Die Zeit, ab der mit dem Lesen begonnen werden soll, in Unix-Zeitsekunden. Definiert`StartingPositionTimestamp`, wann als angegeben `StartingPosition` ist`AT_TIMESTAMP`.  
*Type*: Double  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

## Beispiele
<a name="sam-property-function-documentdb-examples"></a>

### Amazon DocumentDB DocumentDB-Ereignisquelle
<a name="sam-property-function-documentdb-examples-example1"></a>

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyFunction:
    Type: AWS::Serverless::Function
    Properties:
    ...
      Events:
        MyDDBEvent:
          Type: DocumentDB
          Properties:
            Cluster: "arn:aws:rds:us-west-2:123456789012:cluster:docdb-2023-01-01"
            BatchSize: 10
            MaximumBatchingWindowInSeconds: 5
            DatabaseName: "db1"
            CollectionName: "collection1"
            FullDocument: "UpdateLookup"
            SourceAccessConfigurations:
              - Type: BASIC_AUTH
                URI: "arn:aws:secretsmanager:us-west-2:123456789012:secret:doc-db"
```

# DynamoDB
<a name="sam-property-function-dynamodb"></a>

Das Objekt, das einen `DynamoDB` Ereignisquellentyp beschreibt. Weitere Informationen finden Sie unter [Using AWS Lambda with Amazon DynamoDB](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html) im *AWS Lambda Developer* Guide.

AWS SAM generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)Ressource, wenn dieser Ereignistyp festgelegt ist.

## Syntax
<a name="sam-property-function-dynamodb-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-dynamodb-syntax.yaml"></a>

```
  [BatchSize](#sam-function-dynamodb-batchsize): Integer
  [BisectBatchOnFunctionError](#sam-function-dynamodb-bisectbatchonfunctionerror): Boolean
  [DestinationConfig](#sam-function-dynamodb-destinationconfig): [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)
  [Enabled](#sam-function-dynamodb-enabled): Boolean
  [FilterCriteria](#sam-function-dynamodb-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [FunctionResponseTypes](#sam-function-dynamodb-functionresponsetypes): List
  KmsKeyArn: String          
  [MaximumBatchingWindowInSeconds](#sam-function-dynamodb-maximumbatchingwindowinseconds): Integer
  [MaximumRecordAgeInSeconds](#sam-function-dynamodb-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-dynamodb-maximumretryattempts): Integer
  [MetricsConfig](#sam-function-dynamodb-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)
  [ParallelizationFactor](#sam-function-dynamodb-parallelizationfactor): Integer
  [StartingPosition](#sam-function-dynamodb-startingposition): String
  StartingPositionTimestamp: Double
  [Stream](#sam-function-dynamodb-stream): String
  [TumblingWindowInSeconds](#sam-function-dynamodb-tumblingwindowinseconds): Integer
```

## Eigenschaften
<a name="sam-property-function-dynamodb-properties"></a>

 `BatchSize`   <a name="sam-function-dynamodb-batchsize"></a>
Gibt die maximale Anzahl der Elemente an, die in einem einzigen Stapel zurückzugeben werden.  
*Typ*: Ganzzahl  
*Required*: No  
*Standard*: 100  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.  
*Minimum*: `1`  
*Maximum*: `1000`

 `BisectBatchOnFunctionError`   <a name="sam-function-dynamodb-bisectbatchonfunctionerror"></a>
Wenn die Funktion einen Fehler zurückgibt, teilen Sie den Stapel in zwei Teile auf und versuchen Sie es erneut.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `DestinationConfig`   <a name="sam-function-dynamodb-destinationconfig"></a>
Eine Amazon Simple Queue Service (Amazon SQS) -Warteschlange oder ein Amazon Simple Notification Service (Amazon SNS) -Themenziel für verworfene Datensätze.  
*Typ:* [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)` Eigenschaft einer Ressource übergeben. `AWS::Lambda::EventSourceMapping`

 `Enabled`   <a name="sam-function-dynamodb-enabled"></a>
Deaktiviert den Ereignis-Quellzuweisung zum Anhalten und Aufrufen von Abfragen.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `FilterCriteria`   <a name="sam-function-dynamodb-filtercriteria"></a>
Ein Objekt, das die Kriterien definiert, anhand derer bestimmt wird, ob Lambda ein Ereignis verarbeiten soll. Weitere Informationen finden Sie unter [AWS Lambda Ereignisfilterung](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) im *AWS Lambda Entwicklerhandbuch*.  
*Typ:* [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `FunctionResponseTypes`   <a name="sam-function-dynamodb-functionresponsetypes"></a>
Eine Liste der Antworttypen, die derzeit auf die Ereignisquellenzuordnung angewendet werden. Weitere Informationen finden Sie unter [Melden von Batch-Elementen](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting) im *AWS Lambda -Leitfaden für Entwickler*.  
*Gültige Werte*: `ReportBatchItemFailures`  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `KmsKeyArn`   <a name="sam-function-dynamodb-kmskeyarn"></a>
Der Amazon-Ressourcenname (ARN) des Schlüssels zur Verschlüsselung von Informationen im Zusammenhang mit diesem Ereignis.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-dynamodb-maximumbatchingwindowinseconds"></a>
Die maximale Zeitspanne zur Erfassung von Datensätzen vor dem Aufruf der Funktion in Sekunden.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MaximumRecordAgeInSeconds`   <a name="sam-function-dynamodb-maximumrecordageinseconds"></a>
Das maximale Alter eines Datensatzes, den Lambda zur Verarbeitung an eine Funktion sendet.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MaximumRetryAttempts`   <a name="sam-function-dynamodb-maximumretryattempts"></a>
Die maximale Anzahl der Wiederholungen, wenn die Funktion einen Fehler zurückgibt.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MetricsConfig`   <a name="sam-function-dynamodb-metricsconfig"></a>
Eine optionale Konfiguration, um erweiterte Metriken für Zuordnungen von Ereignisquellen zu erhalten, die jede Phase der Verarbeitung erfassen. Ein Beispiel finden Sie unter [MetricsConfig Ereignis](#sam-property-function-dynamodb-example-metricsconfigevent).  
*Typ:* [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)` Eigenschaft einer Ressource übergeben. `AWS::Lambda::EventSourceMapping`

 `ParallelizationFactor`   <a name="sam-function-dynamodb-parallelizationfactor"></a>
Die Anzahl der Batches, die von jedem Shard gleichzeitig verarbeitet werden sollen.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ParallelizationFactor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor)` Eigenschaft einer Ressource übergeben. `AWS::Lambda::EventSourceMapping`

 `StartingPosition`   <a name="sam-function-dynamodb-startingposition"></a>
Die Position im Stream, an der mit dem Lesen begonnen wird.  
+ `AT_TIMESTAMP`— Geben Sie einen Zeitpunkt an, ab dem mit dem Lesen von Datensätzen begonnen werden soll.
+ `LATEST`— Nur neue Datensätze lesen.
+ `TRIM_HORIZON`— Verarbeitet alle verfügbaren Datensätze.
*Zulässige Werte*: `AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON`  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `StartingPositionTimestamp`   <a name="sam-function-dynamodb-startingpositiontimestamp"></a>
Die Zeit, ab der mit dem Lesen begonnen werden soll, in Unix-Zeitsekunden. Definiert`StartingPositionTimestamp`, wann als angegeben `StartingPosition` ist`AT_TIMESTAMP`.  
*Type*: Double  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `Stream`   <a name="sam-function-dynamodb-stream"></a>
Der Amazon-Ressourcenname (ARN) des DynamoDB-Streams.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `TumblingWindowInSeconds`   <a name="sam-function-dynamodb-tumblingwindowinseconds"></a>
Die Dauer eines Verarbeitungsfensters in Sekunden. Der gültige Bereich liegt zwischen 1 und 900 (15 Minuten).  
Weitere Informationen finden Sie unter [Tumbling windows](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#streams-tumbling) im *AWS Lambda Entwicklerhandbuch*.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[TumblingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tumblingwindowinseconds)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

## Beispiele
<a name="sam-property-function-dynamodb--examples"></a>

### MetricsConfig Ereignis
<a name="sam-property-function-dynamodb-example-metricsconfigevent"></a>

Im Folgenden finden Sie ein Beispiel für eine Ressource, die die `MetricsConfig` Eigenschaft verwendet, um jede Phase der Verarbeitung ihrer Ereignisquellenzuordnungen zu erfassen.

```
Resources:
  FilteredEventsFunction:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: s3://sam-demo-bucket/metricsConfig.zip
      Handler: index.handler
      Runtime: nodejs16.x
      Events:
        KinesisStream:
          Type: Kinesis
          Properties:
            Stream: !GetAtt KinesisStream.Arn
            StartingPosition: LATEST
            MetricsConfig:
              Metrics:
              - EventCount
```

### DynamoDB-Ereignisquelle für bestehende DynamoDB-Tabelle
<a name="sam-property-function-dynamodb--examples--dynamodb-event-source-for-existing-dynamodb-table"></a>

DynamoDB-Ereignisquelle für eine DynamoDB-Tabelle, die bereits in einem Konto vorhanden ist. AWS 

#### YAML
<a name="sam-property-function-dynamodb--examples--dynamodb-event-source-for-existing-dynamodb-table--yaml"></a>

```
Events:
  DDBEvent:
    Type: DynamoDB
    Properties:
      Stream: arn:aws:dynamodb:us-east-1:123456789012:table/TestTable/stream/2016-08-11T21:21:33.291
      StartingPosition: TRIM_HORIZON
      BatchSize: 10
      Enabled: false
```

### DynamoDB-Ereignis für in der Vorlage deklarierte DynamoDB-Tabelle
<a name="sam-property-function-dynamodb--examples--dynamodb-event-for-dynamodb-table-declared-in-template"></a>

DynamoDB-Ereignis für eine DynamoDB-Tabelle, die in derselben Vorlagendatei deklariert ist.

#### YAML
<a name="sam-property-function-dynamodb--examples--dynamodb-event-for-dynamodb-table-declared-in-template--yaml"></a>

```
Events:
  DDBEvent:
    Type: DynamoDB
    Properties:
      Stream: 
        !GetAtt MyDynamoDBTable.StreamArn   # This must be the name of a DynamoDB table declared in the same template file
      StartingPosition: TRIM_HORIZON
      BatchSize: 10
      Enabled: false
```

# EventBridgeRule
<a name="sam-property-function-eventbridgerule"></a>

Das Objekt, das einen `EventBridgeRule` Ereignisquellentyp beschreibt, der Ihre serverlose Funktion als Ziel einer EventBridge Amazon-Regel festlegt. Weitere Informationen finden Sie unter [Was ist Amazon EventBridge?](https://docs.aws.amazon.com/eventbridge/latest/userguide/what-is-amazon-eventbridge.html) im * EventBridge Amazon-Benutzerhandbuch*.

AWS SAM generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)Ressource, wenn dieser Ereignistyp festgelegt ist. AWS SAM erstellt auch eine `AWS::Lambda::Permission` Ressource, die benötigt wird, damit Lambda aufgerufen werden `EventBridgeRule` kann.

## Syntax
<a name="sam-property-function-eventbridgerule-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-eventbridgerule-syntax.yaml"></a>

```
  [DeadLetterConfig](#sam-function-eventbridgerule-deadletterconfig): DeadLetterConfig
  [EventBusName](#sam-function-eventbridgerule-eventbusname): String
  [Input](#sam-function-eventbridgerule-input): String
  [InputPath](#sam-function-eventbridgerule-inputpath): String
  InputTransformer: [InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html)
  [Pattern](#sam-function-eventbridgerule-pattern): [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
  [RetryPolicy](#sam-function-eventbridgerule-retrypolicy): [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)
  RuleName: String 
  State: String
  [Target](#sam-function-eventbridgerule-target): Target
```

## Eigenschaften
<a name="sam-property-function-eventbridgerule-properties"></a>

 `DeadLetterConfig`   <a name="sam-function-eventbridgerule-deadletterconfig"></a>
Konfigurieren Sie die Amazon Simple Queue Service (Amazon SQS) -Warteschlange, über die Ereignisse nach einem fehlgeschlagenen Zielaufruf EventBridge gesendet werden. Der Aufruf kann beispielsweise fehlschlagen, wenn ein Ereignis an eine Lambda-Funktion gesendet wird, die nicht existiert, oder wenn EventBridge die Berechtigungen zum Aufrufen der Lambda-Funktion nicht ausreichen. *Weitere Informationen finden Sie unter [Richtlinien zur Wiederholung von Ereignissen und Verwenden von Warteschlangen mit unerlaubten Briefen im Amazon-Benutzerhandbuch](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html). EventBridge *  
Der [AWS::Serverless::Function](sam-resource-function.md) Ressourcentyp hat einen ähnlichen Datentyp`DeadLetterQueue`, der Fehler behandelt, die nach einem erfolgreichen Aufruf der Lambda-Zielfunktion auftreten. Beispiele für diese Arten von Fehlern sind Lambda-Drosselung oder Fehler, die von der Lambda-Zielfunktion zurückgegeben werden. *Weitere Informationen zur `DeadLetterQueue` Funktionseigenschaft finden Sie im Developer Guide unter Warteschlangen mit [uneingeschränktem Inhalt.](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)AWS Lambda *
*Typ:* [DeadLetterConfig](sam-property-function-deadletterconfig.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig)` Eigenschaft des Datentyps. `AWS::Events::Rule` `Target` Die AWS SAM Version dieser Eigenschaft enthält zusätzliche Untereigenschaften für den Fall, dass Sie die Warteschlange AWS SAM für unzustellbare Briefe erstellen möchten.

 `EventBusName`   <a name="sam-function-eventbridgerule-eventbusname"></a>
Der Ereignisbus, der dieser Regel zugeordnet werden soll. Wenn Sie diese Eigenschaft weglassen, wird der AWS SAM Standardereignisbus verwendet.  
*Typ:* Zeichenfolge  
*Required*: No  
*Standard: Standard-Event-Bus*  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[EventBusName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname)` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

 `Input`   <a name="sam-function-eventbridgerule-input"></a>
Gültiger JSON-Text wurde an das Ziel übergeben. Wenn Sie diese Eigenschaft verwenden, wird nichts aus dem Ereignistext selbst an das Ziel weitergeleitet.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` Eigenschaft einer `AWS::Events::Rule Target` Ressource übergeben.

 `InputPath`   <a name="sam-function-eventbridgerule-inputpath"></a>
Wenn Sie nicht das gesamte übereinstimmende Ereignis an das Ziel übergeben möchten, verwenden Sie die `InputPath` Eigenschaft, um zu beschreiben, welcher Teil des Ereignisses übergeben werden soll.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[InputPath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath)` Eigenschaft einer `AWS::Events::Rule Target` Ressource übergeben.

 `InputTransformer`   <a name="sam-function-eventbridgerule-inputtransformer"></a>
Einstellungen, mit denen Sie benutzerdefinierte Eingaben für ein Ziel basierend auf bestimmten Ereignisdaten bereitstellen können. Sie können einzelne oder mehrere Schlüssel-Wert-Paare aus dem Ereignis extrahieren und diese Daten dann verwenden, um benutzerdefinierte Eingaben an das Ziel zu senden. Weitere Informationen finden Sie unter [Amazon EventBridge Input Transformation](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-transform-target-input.html) im * EventBridge Amazon-Benutzerhandbuch*.   
*Typ:* [InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputtransformer)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html)` Eigenschaft eines `AWS::Events::Rule` `Target` Datentyps übergeben.

 `Pattern`   <a name="sam-function-eventbridgerule-pattern"></a>
Beschreibt, welche Ereignisse an das angegebene Ziel weitergeleitet werden. Weitere Informationen finden Sie unter [ EventBridgeAmazon-Ereignisse](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events.html) und [EventBridge -Ereignismuster](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html) im * EventBridge Amazon-Benutzerhandbuch*.  
*Typ:* [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

 `RetryPolicy`   <a name="sam-function-eventbridgerule-retrypolicy"></a>
Ein `RetryPolicy`-Objekt, das Informationen zu den Richtlinieneinstellungen für Wiederholungsversuche enthält. *Weitere Informationen finden Sie unter [Richtlinien zur Wiederholung von Ereignissen und Verwenden von Warteschlangen mit unerlaubten Briefen im Amazon-Benutzerhandbuch](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html). EventBridge *  
*Typ:* [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)` Eigenschaft des Datentyps übergeben. `AWS::Events::Rule` `Target`

 `RuleName`   <a name="sam-function-eventbridgerule-rulename"></a>
Der Name der Regel.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name)` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

 `State`   <a name="sam-function-eventbridgerule-state"></a>
Der Status der Regel.  
*Zulässige Werte*: `DISABLED` \$1 `ENABLED` \$1 `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state) ` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

 `Target`   <a name="sam-function-eventbridgerule-target"></a>
Die AWS Ressource, die EventBridge aufgerufen wird, wenn eine Regel ausgelöst wird. Sie können diese Eigenschaft verwenden, um die logische ID des Ziels anzugeben. Wenn diese Eigenschaft nicht angegeben ist, wird die logische ID des Ziels AWS SAM generiert.  
*Typ*: [Ziel](sam-property-function-target.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[Targets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets)` Eigenschaft einer `AWS::Events::Rule` Ressource. `Amazon EC2 RebootInstances API call`ist ein Beispiel für eine Zieleigenschaft. In der AWS SAM Version dieser Eigenschaft können Sie nur die logische ID eines einzelnen Ziels angeben.

## Beispiele
<a name="sam-property-function-eventbridgerule--examples"></a>

### EventBridgeRule
<a name="sam-property-function-eventbridgerule--examples--eventbridgerule"></a>

Im Folgenden finden Sie ein Beispiel für einen `EventBridgeRule` Ereignisquellentyp.

#### YAML
<a name="sam-property-function-eventbridgerule--examples--eventbridgerule--yaml"></a>

```
EBRule:
  Type: EventBridgeRule
  Properties:
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - terminated
    RetryPolicy:
      MaximumRetryAttempts: 5
      MaximumEventAgeInSeconds: 900
    DeadLetterConfig:
      Type: SQS
      QueueLogicalId: EBRuleDLQ
    Target:
      Id: MyTarget
```

# DeadLetterConfig
<a name="sam-property-function-deadletterconfig"></a>

Das Objekt, das zur Angabe der Amazon Simple Queue Service (Amazon SQS) -Warteschlange verwendet wird, über die Ereignisse nach einem fehlgeschlagenen Zielaufruf EventBridge gesendet werden. Der Aufruf kann beispielsweise fehlschlagen, wenn ein Ereignis an eine Lambda-Funktion gesendet wird, die nicht existiert, oder wenn die Berechtigungen zum Aufrufen der Lambda-Funktion nicht ausreichen. *Weitere Informationen finden Sie unter [Richtlinien zur Wiederholung von Ereignissen und Verwenden von Warteschlangen mit unerlaubten Briefen im Amazon-Benutzerhandbuch](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html). EventBridge *

**Anmerkung**  
Der [AWS::Serverless::Function](sam-resource-function.md) Ressourcentyp hat einen ähnlichen Datentyp, `DeadLetterQueue` der Fehler behandelt, die nach einem erfolgreichen Aufruf der Lambda-Zielfunktion auftreten. Beispiele für diese Art von Fehler sind Lambda-Drosselung oder Fehler, die von der Lambda-Zielfunktion zurückgegeben werden. *Weitere Informationen zur `DeadLetterQueue` Funktionseigenschaft finden Sie im Entwicklerhandbuch unter Warteschlangen mit [uneingeschränktem Inhalt.](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)AWS Lambda *

## Syntax
<a name="sam-property-function-deadletterconfig-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS Serverless Application Model (AWS SAM) -Vorlage zu deklarieren.

### YAML
<a name="sam-property-function-deadletterconfig-syntax.yaml"></a>

```
  [Arn](#sam-function-deadletterconfig-arn): String
  [QueueLogicalId](#sam-function-deadletterconfig-queuelogicalid): String
  [Type](#sam-function-deadletterconfig-type): String
```

## Eigenschaften
<a name="sam-property-function-deadletterconfig-properties"></a>

 `Arn`   <a name="sam-function-deadletterconfig-arn"></a>
Der Amazon-Ressourcenname (ARN) der Amazon SQS-Warteschlange, der als Ziel für die Warteschlange mit unzustellbaren Briefen angegeben wurde.  
Geben Sie entweder die `Type` Eigenschaft oder `Arn` die Eigenschaft an, aber nicht beide.
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Arn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn)` Eigenschaft des `AWS::Events::Rule` `DeadLetterConfig` Datentyps übergeben.

 `QueueLogicalId`   <a name="sam-function-deadletterconfig-queuelogicalid"></a>
Der benutzerdefinierte Name der Warteschlange mit unerlaubten Briefen, die sie AWS SAM erstellt, `Type` ist angegeben.  
Wenn die `Type` Eigenschaft nicht festgelegt ist, wird diese Eigenschaft ignoriert.
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Type`   <a name="sam-function-deadletterconfig-type"></a>
Der Typ der Warteschlange. Wenn diese Eigenschaft festgelegt ist, wird AWS SAM automatisch eine Warteschlange für unzustellbare Nachrichten erstellt und die erforderliche [ressourcenbasierte Richtlinie](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-perms) angehängt, um der Regelressource die Erlaubnis zu erteilen, Ereignisse an die Warteschlange zu senden.  
Geben Sie entweder die `Type` Eigenschaft oder die Eigenschaft an, aber nicht beide`Arn`.
*Gültige Werte*: `SQS`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-function-deadletterconfig--examples"></a>

### DeadLetterConfig
<a name="sam-property-function-deadletterconfig--examples--deadletterconfig"></a>

DeadLetterConfig

#### YAML
<a name="sam-property-function-deadletterconfig--examples--deadletterconfig--yaml"></a>

```
DeadLetterConfig:
  Type: SQS
  QueueLogicalId: MyDLQ
```

# Target
<a name="sam-property-function-target"></a>

Konfiguriert die AWS Ressource, die EventBridge aufgerufen wird, wenn eine Regel ausgelöst wird.

## Syntax
<a name="sam-property-function-target-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-target-syntax.yaml"></a>

```
  [Id](#sam-function-target-id): String
```

## Eigenschaften
<a name="sam-property-function-target-properties"></a>

 `Id`   <a name="sam-function-target-id"></a>
Die logische ID des Ziels.  
Der Wert von `Id` kann alphanumerische Zeichen, Punkte (`.`), Bindestriche () und Unterstriche (`-`) enthalten. `_`  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Id](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id)` Eigenschaft des Datentyps übergeben. `AWS::Events::Rule` `Target`

## Beispiele
<a name="sam-property-function-target--examples"></a>

### Target
<a name="sam-property-function-target--examples--target"></a>

#### YAML
<a name="sam-property-function-target--examples--target--yaml"></a>

```
EBRule:
  Type: EventBridgeRule
  Properties:
    Target:
      Id: MyTarget
```

# HttpApi
<a name="sam-property-function-httpapi"></a>

Das Objekt, das eine Ereignisquelle mit Typ beschreibt HttpApi.

Wenn eine OpenApi Definition für den angegebenen Pfad und die angegebene Methode in der API vorhanden ist, fügt SAM den Abschnitt Lambda-Integration und -Sicherheit (falls zutreffend) für Sie hinzu.

Wenn in der API keine OpenApi Definition für den angegebenen Pfad und die angegebene Methode vorhanden ist, erstellt SAM diese Definition für Sie.

## Syntax
<a name="sam-property-function-httpapi-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-httpapi-syntax.yaml"></a>

```
  [ApiId](#sam-function-httpapi-apiid): String
  [Auth](#sam-function-httpapi-auth): HttpApiFunctionAuth
  [Method](#sam-function-httpapi-method): String
  [Path](#sam-function-httpapi-path): String
  [PayloadFormatVersion](#sam-function-httpapi-payloadformatversion): String
  [RouteSettings](#sam-function-httpapi-routesettings): [RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)
  [TimeoutInMillis](#sam-function-httpapi-timeoutinmillis): Integer
```

## Eigenschaften
<a name="sam-property-function-httpapi-properties"></a>

 `ApiId`   <a name="sam-function-httpapi-apiid"></a>
Bezeichner einer in dieser Vorlage definierten [AWS::Serverless::HttpApi](sam-resource-httpapi.md) Ressource.  
Falls nicht definiert, wird eine [AWS::Serverless::HttpApi](sam-resource-httpapi.md) Standardressource erstellt, die `ServerlessHttpApi` mithilfe eines generierten OpenApi Dokuments aufgerufen wird, das eine Vereinigung aller Pfade und Methoden enthält, die durch API-Ereignisse definiert sind, die in dieser Vorlage definiert sind und keine angeben`ApiId`.  
Dies kann nicht auf eine in einer anderen Vorlage definierte [AWS::Serverless::HttpApi](sam-resource-httpapi.md) Ressource verweisen.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Auth`   <a name="sam-function-httpapi-auth"></a>
Authentifizierungskonfiguration für diese spezielle API\$1Path\$1Methode.  
Nützlich, um die APIs zu überschreiben `DefaultAuthorizer` oder die Authentifizierungskonfiguration für einen einzelnen Pfad festzulegen, wenn keine angegeben ist. `DefaultAuthorizer`  
*Typ:* [HttpApiFunctionAuth](sam-property-function-httpapifunctionauth.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Method`   <a name="sam-function-httpapi-method"></a>
HTTP-Methode, für die diese Funktion aufgerufen wird.  
Wenn nein `Path` und angegeben `Method` sind, erstellt SAM einen Standard-API-Pfad, der alle Anfragen weiterleitet, die nicht einem anderen Endpunkt dieser Lambda-Funktion zugeordnet sind. Pro API kann nur einer dieser Standardpfade existieren.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Path`   <a name="sam-function-httpapi-path"></a>
URI-Pfad, für den diese Funktion aufgerufen wird. Muss mit `/` beginnen.  
Wenn nein `Path` und angegeben `Method` sind, erstellt SAM einen Standard-API-Pfad, der alle Anfragen weiterleitet, die nicht einem anderen Endpunkt dieser Lambda-Funktion zugeordnet sind. Pro API kann nur einer dieser Standardpfade existieren.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `PayloadFormatVersion`   <a name="sam-function-httpapi-payloadformatversion"></a>
Gibt das Format der an eine Integration gesendeten Nutzlast an.  
HINWEIS: PayloadFormatVersion erfordert, dass SAM Ihre OpenAPI-Definition ändert, sodass es nur mit Inline funktioniert, die in der `DefinitionBody` Eigenschaft OpenApi definiert ist.  
*Typ:* Zeichenfolge  
*Required*: No  
*Standard*: 2.0  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `RouteSettings`   <a name="sam-function-httpapi-routesettings"></a>
Die Routeneinstellungen pro Route für diese HTTP-API. Weitere Informationen zu Routeneinstellungen finden Sie [AWS::ApiGatewayV2::Stage RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html)im *API Gateway Developer Guide*.  
Hinweis: Wenn sie sowohl in der HttpApi Ressource als auch in der Ereignisquelle angegeben RouteSettings sind, werden sie mit den Eigenschaften der Ereignisquelle AWS SAM zusammengeführt, die Vorrang haben.  
*Typ:* [RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)` Eigenschaft einer `AWS::ApiGatewayV2::Stage` Ressource übergeben.

 `TimeoutInMillis`   <a name="sam-function-httpapi-timeoutinmillis"></a>
Benutzerdefinierte Zeitüberschreitung zwischen 50 und 29.000 Millisekunden.  
HINWEIS: TimeoutInMillis erfordert, dass SAM Ihre OpenAPI-Definition ändert, sodass es nur mit Inline funktioniert, die in der `DefinitionBody` Eigenschaft OpenApi definiert ist.  
*Typ*: Ganzzahl  
*Required*: No  
*Standard*: 5000  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-function-httpapi--examples"></a>

### HttpApi Standardereignis
<a name="sam-property-function-httpapi--examples--default-httpapi-event"></a>

HttpApi Ereignis, das den Standardpfad verwendet. Alle nicht zugewiesenen Pfade und Methoden auf dieser API werden zu diesem Endpunkt weitergeleitet.

#### YAML
<a name="sam-property-function-httpapi--examples--default-httpapi-event--yaml"></a>

```
Events:
  HttpApiEvent:
    Type: HttpApi
```

### HttpApi
<a name="sam-property-function-httpapi--examples--httpapi"></a>

HttpApi Ereignis, das einen bestimmten Pfad und eine bestimmte Methode verwendet.

#### YAML
<a name="sam-property-function-httpapi--examples--httpapi--yaml"></a>

```
Events:
  HttpApiEvent:
    Type: HttpApi
    Properties:
      Path: /
      Method: GET
```

### HttpApi Autorisierung
<a name="sam-property-function-httpapi--examples--httpapi-authorization"></a>

HttpApi Ereignis, das einen Authorizer verwendet.

#### YAML
<a name="sam-property-function-httpapi--examples--httpapi-authorization--yaml"></a>

```
Events:
  HttpApiEvent:
    Type: HttpApi
    Properties:
      Path: /authenticated
      Method: GET
      Auth:
        Authorizer: OpenIdAuth
        AuthorizationScopes:
          - scope1
          - scope2
```

# HttpApiFunctionAuth
<a name="sam-property-function-httpapifunctionauth"></a>

Konfiguriert die Autorisierung auf Veranstaltungsebene.

Konfigurieren Sie Auth für eine bestimmte API \$1 Path \$1 Methode

## Syntax
<a name="sam-property-function-httpapifunctionauth-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS Serverless Application Model (AWS SAM) -Vorlage zu deklarieren.

### YAML
<a name="sam-property-function-httpapifunctionauth-syntax.yaml"></a>

```
  [AuthorizationScopes](#sam-function-httpapifunctionauth-authorizationscopes): List
  [Authorizer](#sam-function-httpapifunctionauth-authorizer): String
```

## Eigenschaften
<a name="sam-property-function-httpapifunctionauth-properties"></a>

 `AuthorizationScopes`   <a name="sam-function-httpapifunctionauth-authorizationscopes"></a>
Die Autorisierungsbereiche, die für diese API, diesen Pfad und diese Methode gelten sollen.  
Die hier aufgelisteten Bereiche setzen alle Bereiche außer Kraft, die von angewendet werden, `DefaultAuthorizer` falls vorhanden.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Authorizer`   <a name="sam-function-httpapifunctionauth-authorizer"></a>
Die `Authorizer` für eine bestimmte Funktion. Um die IAM-Autorisierung zu verwenden, geben Sie `EnableIamAuthorizer` im `Globals` Abschnitt Ihrer Vorlage die Angabe `AWS_IAM` und Spezifizierung `true` für an.  
Wenn Sie in der API einen Global Authorizer angegeben haben und eine bestimmte Funktion öffentlich machen möchten, überschreiben Sie dies, indem Sie auf setzen`Authorizer`. `NONE`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-function-httpapifunctionauth--examples"></a>

### Funktions-Auth
<a name="sam-property-function-httpapifunctionauth--examples--function-auth"></a>

Autorisierung auf Funktionsebene angeben

#### YAML
<a name="sam-property-function-httpapifunctionauth--examples--function-auth--yaml"></a>

```
Auth:
  Authorizer: OpenIdAuth
  AuthorizationScopes:
    - scope1
    - scope2
```

### IAM-Autorisierung
<a name="sam-property-function-httpapifunctionauth--examples--iam-authorization"></a>

Gibt die IAM-Autorisierung auf Ereignisebene an. Um die `AWS_IAM` Autorisierung auf Veranstaltungsebene zu verwenden, müssen Sie `EnableIamAuthorizer` im `Globals` Abschnitt Ihrer Vorlage auch `true` for angeben. Weitere Informationen finden Sie unter [Abschnitt „Globals“ der Vorlage AWS SAM](sam-specification-template-anatomy-globals.md).

#### YAML
<a name="sam-property-function-httpapifunctionauth--examples--iam-authorization--yaml"></a>

```
Globals:
  HttpApi:
    Auth:
      EnableIamAuthorizer: true

Resources:
  HttpApiFunctionWithIamAuth:
    Type: AWS::Serverless::Function
    Properties:
      Events:
        ApiEvent:
          Type: HttpApi
          Properties:
            Path: /iam-auth
            Method: GET
            Auth:
              Authorizer: AWS_IAM
      Handler: index.handler
      InlineCode: |
        def handler(event, context):
          return {'body': 'HttpApiFunctionWithIamAuth', 'statusCode': 200}
      Runtime: python3.9
```

# IoTRule
<a name="sam-property-function-iotrule"></a>

Das Objekt, das einen `IoTRule` Ereignisquellentyp beschreibt.

Erstellt eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html)Ressource zur Deklaration einer AWS IoT Regel. Weitere Informationen finden Sie in der [CloudFormation Dokumentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html)

## Syntax
<a name="sam-property-function-iotrule-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS Serverless Application Model (AWS SAM) -Vorlage zu deklarieren.

### YAML
<a name="sam-property-function-iotrule-syntax.yaml"></a>

```
  [AwsIotSqlVersion](#sam-function-iotrule-awsiotsqlversion): String
  [Sql](#sam-function-iotrule-sql): String
```

## Eigenschaften
<a name="sam-property-function-iotrule-properties"></a>

 `AwsIotSqlVersion`   <a name="sam-function-iotrule-awsiotsqlversion"></a>
Die Version der SQL-Regel-Engine, die beim Auswerten der Regel verwendet wird.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[AwsIotSqlVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-awsiotsqlversion)` Eigenschaft einer `AWS::IoT::TopicRule TopicRulePayload` Ressource übergeben.

 `Sql`   <a name="sam-function-iotrule-sql"></a>
Die SQL-Anweisung für die Abfrage des Themas. Weitere Informationen finden Sie in der [AWS IoT SQL-Referenz](https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) im *AWS IoT Entwicklerhandbuch*.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Sql](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-sql)` Eigenschaft einer `AWS::IoT::TopicRule TopicRulePayload` Ressource übergeben.

## Beispiele
<a name="sam-property-function-iotrule--examples"></a>

### IOT-Regel
<a name="sam-property-function-iotrule--examples--iot-rule"></a>

Beispiel für eine IOT-Regel

#### YAML
<a name="sam-property-function-iotrule--examples--iot-rule--yaml"></a>

```
IoTRule:
  Type: IoTRule
  Properties:
    Sql: SELECT * FROM 'topic/test'
```

# Kinesis
<a name="sam-property-function-kinesis"></a>

Das Objekt, das einen `Kinesis` Ereignisquellentyp beschreibt. Weitere Informationen finden Sie unter [Using AWS Lambda with Amazon Kinesis](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html) im *AWS Lambda Developer Guide*.

AWS SAM generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)Ressource, wenn dieser Ereignistyp festgelegt ist.

## Syntax
<a name="sam-property-function-kinesis-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-kinesis-syntax.yaml"></a>

```
  [BatchSize](#sam-function-kinesis-batchsize): Integer
  [BisectBatchOnFunctionError](#sam-function-kinesis-bisectbatchonfunctionerror): Boolean
  [DestinationConfig](#sam-function-kinesis-destinationconfig): [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)
  [Enabled](#sam-function-kinesis-enabled): Boolean
  [FilterCriteria](#sam-function-kinesis-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [FunctionResponseTypes](#sam-function-kinesis-functionresponsetypes): List
  KmsKeyArn: String          
  [MaximumBatchingWindowInSeconds](#sam-function-kinesis-maximumbatchingwindowinseconds): Integer
  [MaximumRecordAgeInSeconds](#sam-function-kinesis-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-kinesis-maximumretryattempts): Integer
  [MetricsConfig](#sam-function-kinesis-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)
  [ParallelizationFactor](#sam-function-kinesis-parallelizationfactor): Integer
  [StartingPosition](#sam-function-kinesis-startingposition): String
  StartingPositionTimestamp: Double
  [Stream](#sam-function-kinesis-stream): String
  [TumblingWindowInSeconds](#sam-function-kinesis-tumblingwindowinseconds): Integer
```

## Eigenschaften
<a name="sam-property-function-kinesis-properties"></a>

 `BatchSize`   <a name="sam-function-kinesis-batchsize"></a>
Gibt die maximale Anzahl der Elemente an, die in einem einzigen Stapel zurückzugeben werden.  
*Typ*: Ganzzahl  
*Required*: No  
*Standard*: 100  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.  
*Minimum*: `1`  
*Maximum*: `10000`

 `BisectBatchOnFunctionError`   <a name="sam-function-kinesis-bisectbatchonfunctionerror"></a>
Wenn die Funktion einen Fehler zurückgibt, teilen Sie den Stapel in zwei Teile auf und versuchen Sie es erneut.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `DestinationConfig`   <a name="sam-function-kinesis-destinationconfig"></a>
Eine Amazon Simple Queue Service (Amazon SQS) -Warteschlange oder ein Amazon Simple Notification Service (Amazon SNS) -Themenziel für verworfene Datensätze.  
*Typ:* [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)` Eigenschaft einer Ressource übergeben. `AWS::Lambda::EventSourceMapping`

 `Enabled`   <a name="sam-function-kinesis-enabled"></a>
Deaktiviert den Ereignis-Quellzuweisung zum Anhalten und Aufrufen von Abfragen.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `FilterCriteria`   <a name="sam-function-kinesis-filtercriteria"></a>
Ein Objekt, das die Kriterien definiert, anhand derer bestimmt wird, ob Lambda ein Ereignis verarbeiten soll. Weitere Informationen finden Sie unter [AWS Lambda Ereignisfilterung](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) im *AWS Lambda Entwicklerhandbuch*.  
*Typ:* [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `FunctionResponseTypes`   <a name="sam-function-kinesis-functionresponsetypes"></a>
Eine Liste der Antworttypen, die derzeit auf die Ereignisquellenzuordnung angewendet werden. Weitere Informationen finden Sie unter [Melden von Batch-Elementen](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-batchfailurereporting) im *AWS Lambda -Leitfaden für Entwickler*.  
*Gültige Werte*: `ReportBatchItemFailures`  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `KmsKeyArn`   <a name="sam-function-kinesis-kmskeyarn"></a>
Der Amazon-Ressourcenname (ARN) des Schlüssels zur Verschlüsselung von Informationen im Zusammenhang mit diesem Ereignis.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-kinesis-maximumbatchingwindowinseconds"></a>
Die maximale Zeitspanne zur Erfassung von Datensätzen vor dem Aufruf der Funktion in Sekunden.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MaximumRecordAgeInSeconds`   <a name="sam-function-kinesis-maximumrecordageinseconds"></a>
Das maximale Alter eines Datensatzes, den Lambda zur Verarbeitung an eine Funktion sendet.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MaximumRetryAttempts`   <a name="sam-function-kinesis-maximumretryattempts"></a>
Die maximale Anzahl der Wiederholungen, wenn die Funktion einen Fehler zurückgibt.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MetricsConfig`   <a name="sam-function-kinesis-metricsconfig"></a>
Eine optionale Konfiguration, um erweiterte Metriken für Zuordnungen von Ereignisquellen zu erhalten, die jede Phase der Verarbeitung erfassen. Ein Beispiel finden Sie unter [MetricsConfig Ereignis](sam-property-function-dynamodb.md#sam-property-function-dynamodb-example-metricsconfigevent).  
*Typ:* [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)` Eigenschaft einer Ressource übergeben. `AWS::Lambda::EventSourceMapping`

 `ParallelizationFactor`   <a name="sam-function-kinesis-parallelizationfactor"></a>
Die Anzahl der Batches, die von jedem Shard gleichzeitig verarbeitet werden sollen.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ParallelizationFactor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor)` Eigenschaft einer Ressource übergeben. `AWS::Lambda::EventSourceMapping`

 `StartingPosition`   <a name="sam-function-kinesis-startingposition"></a>
Die Position im Stream, an der mit dem Lesen begonnen wird.  
+ `AT_TIMESTAMP`— Geben Sie einen Zeitpunkt an, ab dem mit dem Lesen von Datensätzen begonnen werden soll.
+ `LATEST`— Nur neue Datensätze lesen.
+ `TRIM_HORIZON`— Verarbeitet alle verfügbaren Datensätze.
*Zulässige Werte*: `AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON`  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `StartingPositionTimestamp`   <a name="sam-function-kinesis-startingpositiontimestamp"></a>
Die Zeit, ab der mit dem Lesen begonnen werden soll, in Unix-Zeitsekunden. Definiert`StartingPositionTimestamp`, wann als angegeben `StartingPosition` ist`AT_TIMESTAMP`.  
*Type*: Double  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `Stream`   <a name="sam-function-kinesis-stream"></a>
Der Amazon-Ressourcenname (ARN) des Datenstroms oder eines Stream-Verbrauchers.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `TumblingWindowInSeconds`   <a name="sam-function-kinesis-tumblingwindowinseconds"></a>
Die Dauer eines Verarbeitungsfensters in Sekunden. Der gültige Bereich liegt zwischen 1 und 900 (15 Minuten).  
Weitere Informationen finden Sie unter [Tumbling windows](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#streams-tumbling) im *AWS Lambda Entwicklerhandbuch*.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[TumblingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tumblingwindowinseconds)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

## Beispiele
<a name="sam-property-function-kinesis--examples"></a>

### MetricsConfig Ereignis
<a name="sam-property-function-kinesis-example-metricsconfigevent"></a>

Im Folgenden finden Sie ein Beispiel für eine Ressource, die die `MetricsConfig` Eigenschaft verwendet, um jede Phase der Verarbeitung ihrer Ereignisquellenzuordnungen zu erfassen.

```
Resources:
  FilteredEventsFunction:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: s3://sam-demo-bucket/metricsConfig.zip
      Handler: index.handler
      Runtime: nodejs16.x
      Events:
        KinesisStream:
          Type: Kinesis
          Properties:
            Stream: !GetAtt KinesisStream.Arn
            StartingPosition: LATEST
            MetricsConfig:
              Metrics:
              - EventCount
```

### Kinesis-Ereignisquelle
<a name="sam-property-function-kinesis--examples--kinesis-event-source"></a>

Im Folgenden finden Sie ein Beispiel für eine Kinesis-Ereignisquelle.

#### YAML
<a name="sam-property-function-kinesis--examples--kinesis-event-source--yaml"></a>

```
Events:
  KinesisEvent:
    Type: Kinesis
    Properties:
      Stream: arn:aws:kinesis:us-east-1:123456789012:stream/my-stream
      StartingPosition: TRIM_HORIZON
      BatchSize: 10
      Enabled: false
      FilterCriteria: 
        Filters: 
          - Pattern: '{"key": ["val1", "val2"]}'
```

# MQ
<a name="sam-property-function-mq"></a>

Das Objekt, das einen `MQ` Ereignisquellentyp beschreibt. Weitere Informationen finden Sie unter [Using Lambda with Amazon MQ](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html) im *AWS Lambda Developer* Guide.

AWS Serverless Application Model (AWS SAM) generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)Ressource, wenn dieser Ereignistyp festgelegt ist.

**Anmerkung**  
Um eine Amazon MQ MQ-Warteschlange in einer Virtual Private Cloud (VPC) zu haben, die eine Verbindung zu einer Lambda-Funktion in einem öffentlichen Netzwerk herstellt, muss die Ausführungsrolle Ihrer Funktion die folgenden Berechtigungen beinhalten:   
`ec2:CreateNetworkInterface`
`ec2:DeleteNetworkInterface`
`ec2:DescribeNetworkInterfaces`
`ec2:DescribeSecurityGroups`
`ec2:DescribeSubnets`
`ec2:DescribeVpcs`
*Weitere Informationen finden Sie unter [Berechtigungen für Ausführungsrollen im Entwicklerhandbuch](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#events-mq-permissions).AWS Lambda *

## Syntax
<a name="sam-property-function-mq-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS SAM Vorlage zu deklarieren.

### YAML
<a name="sam-property-function-mq-syntax.yaml"></a>

```
  [BatchSize](#sam-function-mq-batchsize): Integer
  [Broker](#sam-function-mq-broker): String
  DynamicPolicyName: Boolean
  [Enabled](#sam-function-mq-enabled): Boolean
  [FilterCriteria](#sam-function-mq-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  KmsKeyArn: String 
  [MaximumBatchingWindowInSeconds](#sam-function-mq-maximumbatchingwindowinseconds): Integer
  [Queues](#sam-function-mq-queues): List
  [SecretsManagerKmsKeyId](#sam-function-mq-secretsmanagerkmskeyid): String
  [SourceAccessConfigurations](#sam-function-mq-sourceaccessconfigurations): List
```

## Eigenschaften
<a name="sam-property-function-mq-properties"></a>

 `BatchSize`   <a name="sam-function-mq-batchsize"></a>
Gibt die maximale Anzahl der Elemente an, die in einem einzigen Stapel zurückzugeben werden.  
*Typ*: Ganzzahl  
*Required*: No  
*Standard*: 100  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.  
*Minimum*: `1`  
*Maximum*: `10000`

 `Broker`   <a name="sam-function-mq-broker"></a>
Der Amazon-Ressourcenname (ARN) des Amazon MQ-Brokers.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `DynamicPolicyName`   <a name="sam-function-mq-dynamicpolicyname"></a>
Standardmäßig dient der Richtlinienname AWS Identity and Access Management (IAM) der `SamAutoGeneratedAMQPolicy` Abwärtskompatibilität. Geben Sie `true` an, dass ein automatisch generierter Name für Ihre IAM-Richtlinie verwendet werden soll. Dieser Name beinhaltet die logische ID der Amazon MQ MQ-Ereignisquelle.  
Wenn Sie mehr als eine Amazon MQ MQ-Ereignisquelle verwenden, geben Sie dies an, `true` um doppelte IAM-Richtliniennamen zu vermeiden.
*Typ*: Boolesch  
*Required*: No  
*Standardwert*: `false`  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Enabled`   <a name="sam-function-mq-enabled"></a>
Falls`true`, ist die Zuordnung der Ereignisquelle aktiv. Um die Abfrage und den Aufruf zu unterbrechen, legen Sie den Wert auf fest. `false`  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `FilterCriteria`   <a name="sam-function-mq-filtercriteria"></a>
Ein Objekt, das die Kriterien definiert, die bestimmen, ob Lambda ein Ereignis verarbeiten soll. Weitere Informationen finden Sie unter [AWS Lambda Ereignisfilterung](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) im *AWS Lambda Entwicklerhandbuch*.  
*Typ:* [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `KmsKeyArn`   <a name="sam-function-mq-kmskeyarn"></a>
Der Amazon-Ressourcenname (ARN) des Schlüssels zur Verschlüsselung von Informationen zu diesem Ereignis.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-mq-maximumbatchingwindowinseconds"></a>
Die maximale Zeitspanne zur Erfassung von Datensätzen vor dem Aufruf der Funktion in Sekunden.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `Queues`   <a name="sam-function-mq-queues"></a>
Der Name der zu verwendenden Zielwarteschlange des Amazon-MQ-Brokers.  
*Typ*: Liste  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Queues](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-queues)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `SecretsManagerKmsKeyId`   <a name="sam-function-mq-secretsmanagerkmskeyid"></a>
Die AWS Key Management Service (AWS KMS) Schlüssel-ID eines vom Kunden verwalteten Schlüssels von AWS Secrets Manager. Erforderlich, wenn Sie einen vom Kunden verwalteten Schlüssel von Secrets Manager mit einer Lambda-Ausführungsrolle verwenden, die die `kms:Decrypt` Berechtigung nicht enthält.  
Der Wert dieser Eigenschaft ist eine UUID. Beispiel: `1abc23d4-567f-8ab9-cde0-1fab234c5d67`.  
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `SourceAccessConfigurations`   <a name="sam-function-mq-sourceaccessconfigurations"></a>
Ein Array des Authentifizierungsprotokolls oder des virtuellen Hosts. Geben Sie dies mithilfe des [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html)Datentyps an.  
Für den Typ der `MQ` Ereignisquelle sind die einzig gültigen Konfigurationstypen `BASIC_AUTH` und`VIRTUAL_HOST`.  
+ **`BASIC_AUTH`**— Das Secrets Manager Manager-Geheimnis, das Ihre Broker-Anmeldeinformationen speichert. Für diesen Typ müssen die Anmeldeinformationen das folgende Format haben:`{"username": "your-username", "password": "your-password"}`. Nur ein Objekt des Typs `BASIC_AUTH` ist zulässig.
+ **`VIRTUAL_HOST`**— Der Name des virtuellen Hosts in Ihrem RabbitMQ-Broker. Lambda verwendet den Host dieses Rabbit MQ als Ereignisquelle. Nur ein Objekt des Typs `VIRTUAL_HOST` ist zulässig.
*Typ*: Liste  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

## Beispiele
<a name="sam-property-function-mq--examples"></a>

### Amazon MQ MQ-Ereignisquelle
<a name="sam-property-function-mq--examples--amazon-mq-event-source"></a>

Im Folgenden finden Sie ein Beispiel für einen `MQ` Ereignisquellentyp für einen Amazon MQ-Broker.

#### YAML
<a name="sam-property-function-mq--examples--amazon-mq-event-source--yaml"></a>

```
Events:
  MQEvent:
    Type: MQ
    Properties:
      Broker: arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9
      Queues: List of queues
      SourceAccessConfigurations:
        - Type: BASIC_AUTH
          URI: arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName
      BatchSize: 200
      Enabled: true
```

# MSK
<a name="sam-property-function-msk"></a>

Das Objekt, das einen `MSK` Ereignisquellentyp beschreibt. Weitere Informationen finden Sie unter [Using AWS Lambda with Amazon MSK](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) im *AWS Lambda Developer Guide*.

AWS Serverless Application Model (AWS SAM) generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)Ressource, wenn dieser Ereignistyp festgelegt ist.

Um Schema Registry verwenden zu können, müssen Sie spezifische IAM-Rollenberechtigungen für Ihre Funktion definieren. Ein Beispiel für die erforderliche [Konfiguration finden Sie unter Vollständige Einrichtung mit IAM-Rollen](#sam-property-function-msk-example-complete).

## Syntax
<a name="sam-property-function-msk-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS SAM Vorlage zu deklarieren.

### YAML
<a name="sam-property-function-msk-syntax.yaml"></a>

```
  [BatchSize](#sam-function-msk-batchsize): Integer
  [BisectBatchOnFunctionError](#sam-function-msk-bisectbatchonfunctionerror): Boolean
  [ConsumerGroupId](#sam-function-msk-consumergroupid): String
  DestinationConfig: [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html)
  [Enabled](#sam-function-msk-enabled): Boolean
  [FilterCriteria](#sam-function-msk-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [FunctionResponseTypes](#sam-function-msk-functionresponsetypes): List
  KmsKeyArn: String
  [MaximumBatchingWindowInSeconds](#sam-function-msk-maximumbatchingwindowinseconds): Integer
  [MaximumRecordAgeInSeconds](#sam-function-msk-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-msk-maximumretryattempts): Integer
  [LoggingConfig](#sam-function-msk-loggingconfig): [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig.html)
  [MetricsConfig](#sam-function-msk-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig.html)
  [ProvisionedPollerConfig](#sam-function-msk-provisionedpollerconfig): [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)
  [SchemaRegistryConfig](#sam-function-msk-schemaregistryconfig): [SchemaRegistryConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig.html)
  SourceAccessConfigurations: [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)
  [StartingPosition](#sam-function-msk-startingposition): String
  StartingPositionTimestamp: Double
  [Stream](#sam-function-msk-stream): String
  [Topics](#sam-function-msk-topics): List
```

## Eigenschaften
<a name="sam-property-function-msk-properties"></a>

 `BatchSize`   <a name="sam-function-msk-batchsize"></a>
Die maximale Anzahl von Datensätzen in jedem Batch, die Lambda aus Ihrem Stream oder der Warteschlange abruft und an Ihre Funktion sendet. Lambda übergibt alle Datensätze im Batch in einem einzigen Aufruf an die Funktion, bis zur Nutzlastgrenze für den synchronen Aufruf (6 MB).  
*Standard*: 100  
*Gültiger Bereich*: Mindestwert von 1. Höchstwert von 10.000.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `BisectBatchOnFunctionError`   <a name="sam-function-msk-bisectbatchonfunctionerror"></a>
Wenn die Funktion einen Fehler zurückgibt, teilen Sie den Stapel in zwei Teile auf und versuchen Sie es erneut.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `ConsumerGroupId`   <a name="sam-function-msk-consumergroupid"></a>
Eine Zeichenfolge, die konfiguriert, wie Ereignisse aus Kafka-Themen gelesen werden.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[AmazonManagedKafkaConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `DestinationConfig`   <a name="sam-function-msk-destinationconfig"></a>
Ein Konfigurationsobjekt, das das Ziel eines Ereignisses angibt, nachdem Lambda es verarbeitet hat.  
Verwenden Sie diese Eigenschaft, um das Ziel fehlgeschlagener Aufrufe aus der Amazon MSK-Ereignisquelle anzugeben.  
*Typ:* [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html)` Eigenschaft einer Ressource übergeben. `AWS::Lambda::EventSourceMapping`

 `Enabled`   <a name="sam-function-msk-enabled"></a>
Deaktiviert den Ereignis-Quellzuweisung zum Anhalten und Aufrufen von Abfragen.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `FilterCriteria`   <a name="sam-function-msk-filtercriteria"></a>
Ein Objekt, das die Kriterien definiert, die bestimmen, ob Lambda ein Ereignis verarbeiten soll. Weitere Informationen finden Sie unter [AWS Lambda Ereignisfilterung](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) im *AWS Lambda Entwicklerhandbuch*.  
*Typ:* [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `FunctionResponseTypes`   <a name="sam-function-msk-functionresponsetypes"></a>
Eine Liste der Antworttypen, die derzeit auf die Ereignisquellenzuordnung angewendet werden. Weitere Informationen finden Sie unter [Melden von Batch-Elementen](https://docs.aws.amazon.com/lambda/latest/dg/kafka-retry-configurations.html) im *AWS Lambda -Leitfaden für Entwickler*.  
*Gültige Werte*: `ReportBatchItemFailures`  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `KmsKeyArn`   <a name="sam-function-msk-kmskeyarn"></a>
Der Amazon-Ressourcenname (ARN) des Schlüssels zur Verschlüsselung von Informationen im Zusammenhang mit diesem Ereignis.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-msk-maximumbatchingwindowinseconds"></a>
Die maximale Zeitspanne zur Erfassung von Datensätzen vor dem Aufruf der Funktion in Sekunden.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MaximumRecordAgeInSeconds`   <a name="sam-function-msk-maximumrecordageinseconds"></a>
Das maximale Alter eines Datensatzes, den Lambda zur Verarbeitung an eine Funktion sendet.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MaximumRetryAttempts`   <a name="sam-function-msk-maximumretryattempts"></a>
Die maximale Anzahl der Wiederholungen, wenn die Funktion einen Fehler zurückgibt.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `LoggingConfig`   <a name="sam-function-msk-loggingconfig"></a>
Ein Konfigurationsobjekt, das die Protokollierungskonfiguration für die Zuordnung der Ereignisquellen angibt.  
*Typ:* [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig.html)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MetricsConfig`   <a name="sam-function-msk-metricsconfig"></a>
Ein Konfigurationsobjekt, das die Metrikkonfiguration für die Zuordnung der Ereignisquellen angibt.  
*Typ:* [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig.html)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `ProvisionedPollerConfig`   <a name="sam-function-msk-provisionedpollerconfig"></a>
Konfiguration zur Erhöhung der Anzahl von Pollern, die zur Berechnung von Ereignisquellenzuordnungen verwendet werden. Diese Konfiguration ermöglicht mindestens einen Poller und ein Maximum von 2000 Pollern. Ein Beispiel finden Sie unter. [ProvisionedPollerConfig Beispiel](#sam-property-function-msk-example-provisionedpollerconfig)  
*Typ:* [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

`SchemaRegistryConfig`  <a name="sam-function-msk-schemaregistryconfig"></a>
Konfiguration für die Verwendung einer Schemaregistrierung mit der Kafka-Ereignisquelle.  
Diese Funktion `ProvisionedPollerConfig` muss konfiguriert werden.
*Typ*: SchemaRegistryConfig  
*Required*: No  
*CloudFormation Kompatibilität:* Diese Eigenschaft wird direkt an die `[AmazonManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `SourceAccessConfigurations`   <a name="sam-function-msk-sourceaccessconfigurations"></a>
Ein Array des Authentifizierungsprotokolls, der VPC-Komponenten oder des virtuellen Hosts zum Sichern und Definieren Ihrer Ereignisquelle.  
*Gültige Werte*: `CLIENT_CERTIFICATE_TLS_AUTH`  
*Typ*: Liste von [SourceAccessConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html)  
*Required*: No  
*CloudFormation Kompatibilität:* Diese Eigenschaft ist Teil der [AmazonManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig)Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource.

 `StartingPosition`   <a name="sam-function-msk-startingposition"></a>
Die Position im Stream, an der mit dem Lesen begonnen wird.  
+ `AT_TIMESTAMP`— Geben Sie einen Zeitpunkt an, ab dem mit dem Lesen von Datensätzen begonnen werden soll.
+ `LATEST`— Nur neue Datensätze lesen.
+ `TRIM_HORIZON`— Verarbeitet alle verfügbaren Datensätze.
*Zulässige Werte*: `AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `StartingPositionTimestamp`   <a name="sam-function-msk-startingpositiontimestamp"></a>
Die Zeit, ab der mit dem Lesen begonnen werden soll, in Unix-Zeitsekunden. Definiert`StartingPositionTimestamp`, wann als angegeben `StartingPosition` ist`AT_TIMESTAMP`.  
*Type*: Double  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `Stream`   <a name="sam-function-msk-stream"></a>
Der Amazon-Ressourcenname (ARN) des Datenstroms oder eines Stream-Verbrauchers.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `Topics`   <a name="sam-function-msk-topics"></a>
Der Name des Kafka-Themas.  
*Typ*: Liste  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Topics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-topics)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

## Beispiele
<a name="sam-property-function-msk--examples"></a>

### Vollständige Einrichtung mit IAM-Rollen
<a name="sam-property-function-msk-example-complete"></a>

Das folgende Beispiel zeigt ein vollständiges Setup einschließlich der erforderlichen IAM-Rollenkonfiguration für die Verwendung von Schema Registry:

```
Parameters:
  PreCreatedSubnetOne:
    Type: String
  PreCreatedSubnetTwo:
    Type: String
  MskClusterName4:
    Type: String

Resources:
  MyLambdaExecutionRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Version: '2012-10-17		 	 	 '
        Statement:
        - Action: [sts:AssumeRole]
          Effect: Allow
          Principal:
            Service: [lambda.amazonaws.com]
      Policies:
      - PolicyName: KafkaClusterPermissions
        PolicyDocument:
          Statement:
          - Action: [kafka:DescribeClusterV2, kafka:GetBootstrapBrokers]
            Effect: Allow
            Resource: 'arn:aws:kafka:us-east-1:123456789012:cluster/*'
      - PolicyName: KafkaAuthPolicy
        PolicyDocument:
          Statement:
          - Action: [secretsmanager:GetSecretValue, kms:Decrypt]
            Effect: "Allow"
            Resource: ['arn:aws:secretsmanager:us-west-2:123456789012:secret:kafkaSecret-******',
                        'arn:aws:kms:us-west-2:123456789012:key/keyId']
      - PolicyName: ENIPolicy
        PolicyDocument:
          Statement:
          - Action: [ec2:CreateNetworkInterface,
              ec2:DescribeNetworkInterfaces, ec2:DescribeVpcs, ec2:DeleteNetworkInterface,
              ec2:DescribeSubnets, ec2:DescribeSecurityGroups]
            Effect: Allow
            Resource: '*'
      - PolicyName: SchemaRegistryPolicy
        PolicyDocument:
          Statement:
          - Action: [glue:GetRegistry]
            Effect: Allow
            Resource: 'arn:aws:glue:{region}:{account-id}:registry/{registry-name}'
      - PolicyName: SchemaVersionsPolicy
        PolicyDocument:
          Statement:
          - Action: [glue:GetSchemaVersions]
            Effect: Allow
            Resource: '*'
      ManagedPolicyArns:
      - !Sub arn:${AWS::Partition}:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole
      Tags:
      - {Value: SAM, Key: lambda:createdBy}

  MyMskCluster:
    Type: AWS::MSK::Cluster
    Properties:
      BrokerNodeGroupInfo:
        ClientSubnets:
        - Ref: PreCreatedSubnetOne
        - Ref: PreCreatedSubnetTwo
        InstanceType: kafka.t3.small
        StorageInfo:
          EBSStorageInfo:
            VolumeSize: 1
      ClusterName:
        Ref: MskClusterName4
      KafkaVersion: 3.8.x
      NumberOfBrokerNodes: 2

  MyMskStreamProcessor:
    Type: AWS::Serverless::Function
    Properties:
      Runtime: nodejs18.x
      Handler: index.handler
      CodeUri: ${codeuri}
      Role:
        Fn::GetAtt: [MyLambdaExecutionRole, Arn]
      Events:
        MyMskEvent:
          Type: MSK
          Properties:
            StartingPosition: LATEST
            Stream:
              Ref: MyMskCluster
            SourceAccessConfigurations:
            - Type: SASL_SCRAM_512_AUTH
              URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
            Topics:
            - SchemaRegistryTestTopic
            ProvisionedPollerConfig:
              MinimumPollers: 1
            SchemaRegistryConfig:
              AccessConfigs:
              - Type: BASIC_AUTH
                URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
              SchemaValidationConfigs:
              - Attribute: KEY
              EventRecordFormat: JSON
              SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry
```

### ProvisionedPollerConfig Beispiel
<a name="sam-property-function-msk-example-provisionedpollerconfig"></a>

```
ProvisionedPollerConfig:
  MinimumPollers: 1
  MaximumPollers: 200
```

### Amazon MSK-Beispiel für einen vorhandenen Cluster
<a name="sam-property-function-msk--examples--amazon-msk-example-for-existing-cluster"></a>

Im Folgenden finden Sie ein Beispiel für einen `MSK` Ereignisquellentyp für einen Amazon MSK-Cluster, der bereits in einem AWS-Konto vorhanden ist.

#### YAML
<a name="sam-property-function-msk--examples--amazon-msk-example-for-existing-cluster--yaml"></a>

```
Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream: arn:aws:kafka:us-east-1:012345678012:cluster/exampleClusterName/abcdefab-1234-abcd-5678-cdef0123ab01-2
      Topics:
        - MyTopic
```

### Amazon MSK-Beispiel für Cluster, der in derselben Vorlage deklariert wurde
<a name="sam-property-function-msk--examples--amazon-msk-example-for-cluster-declared-in-same-template"></a>

Im Folgenden finden Sie ein Beispiel für einen `MSK` Ereignisquellentyp für einen Amazon MSK-Cluster, der in derselben Vorlagendatei deklariert ist.

#### YAML
<a name="sam-property-function-msk--examples--amazon-msk-example-for-cluster-declared-in-same-template--yaml"></a>

```
Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream:
        Ref: MyMskCluster   # This must be the name of an MSK cluster declared in the same template file
      Topics:
        - MyTopic
```

#### MSK-Ereignisquelle mit Schemaregistrierung
<a name="sam-property-function-msk-example-schemaregistry"></a>

Im Folgenden finden Sie ein Beispiel für einen `MSK` Ereignisquellentyp, der mit einer Schemaregistrierung konfiguriert wurde.

```
Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream:
        Ref: MyMskCluster
      Topics:
        - SchemaRegistryTestTopic
      ProvisionedPollerConfig:
        MinimumPollers: 1
      SchemaRegistryConfig:
        SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry
        EventRecordFormat: JSON
        SchemaValidationConfigs:
          - Attribute: KEY
          - Attribute: VALUE
```

#### MSK-Ereignisquelle mit Confluent Schema Registry
<a name="sam-property-function-msk-example-schemaregistry-confluent"></a>

Im Folgenden finden Sie ein Beispiel für einen `MSK` Ereignisquellentyp, der mit einer Confluent Schema Registry konfiguriert wurde.

```
Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream:
        Ref: MyMskCluster
      Topics:
        - SchemaRegistryTestTopic
      ProvisionedPollerConfig:
        MinimumPollers: 1
      SchemaRegistryConfig:
        SchemaRegistryURI: https://my-schema-registry.confluent.cloud
        AccessConfigs:
          - Type: BASIC_AUTH
            URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-secret
        EventRecordFormat: JSON
        SchemaValidationConfigs:
          - Attribute: KEY
          - Attribute: VALUE
```

# S3
<a name="sam-property-function-s3"></a>

Das Objekt, das einen `S3` Ereignisquellentyp beschreibt.

## Syntax
<a name="sam-property-function-s3-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-s3-syntax.yaml"></a>

```
  [Bucket](#sam-function-s3-bucket): String
  [Events](#sam-function-s3-events): String | List
  [Filter](#sam-function-s3-filter): [NotificationFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html)
```

## Eigenschaften
<a name="sam-property-function-s3-properties"></a>

 `Bucket`   <a name="sam-function-s3-bucket"></a>
Name des S3 Buckets. Dieser Bucket muss in derselben Vorlage vorhanden sein.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[BucketName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-name)` Eigenschaft einer `AWS::S3::Bucket` Ressource. Dies ist ein Pflichtfeld in SAM. Dieses Feld akzeptiert nur einen Verweis auf den S3-Bucket, der in dieser Vorlage erstellt wurde

 `Events`   <a name="sam-function-s3-events"></a>
Das Amazon S3 S3-Bucket-Ereignis, für das die Lambda-Funktion aufgerufen werden soll. Eine Liste der gültigen Werte finden Sie unter Von [Amazon S3 unterstützte Ereignistypen](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#supported-notification-event-types).  
*Typ*: Zeichenfolge \$1 Liste  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Event](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig-event)` Eigenschaft des `AWS::S3::Bucket` `LambdaConfiguration` Datentyps übergeben.

 `Filter`   <a name="sam-function-s3-filter"></a>
Die Filterregeln, die bestimmen, welche Amazon S3 S3-Objekte die Lambda-Funktion aufrufen. Informationen zur Amazon S3 S3-Schlüsselnamenfilterung finden Sie unter [Konfiguration von Amazon S3 S3-Ereignisbenachrichtigungen](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) im *Amazon Simple Storage Service-Benutzerhandbuch*.  
*Typ:* [NotificationFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Filter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html)` Eigenschaft des `AWS::S3::Bucket` `LambdaConfiguration` Datentyps übergeben.

## Beispiele
<a name="sam-property-function-s3--examples"></a>

### S3-Ereignis
<a name="sam-property-function-s3--examples--s3-event"></a>

Beispiel für ein S3-Event.

#### YAML
<a name="sam-property-function-s3--examples--s3-event--yaml"></a>

```
Events:
  S3Event:
    Type: S3
    Properties:
      Bucket:
        Ref: ImagesBucket     # This must be the name of an S3 bucket declared in the same template file
      Events: s3:ObjectCreated:*
      Filter:
        S3Key:
          Rules:
          - Name: prefix      # or "suffix"
            Value: value      # The value to search for in the S3 object key names
```

# Schedule
<a name="sam-property-function-schedule"></a>

Das Objekt, das einen `Schedule` Ereignisquellentyp beschreibt, der Ihre serverlose Funktion als Ziel einer EventBridge Amazon-Regel festlegt, die nach einem Zeitplan ausgelöst wird. Weitere Informationen finden Sie unter [Was ist Amazon EventBridge?](https://docs.aws.amazon.com/eventbridge/latest/userguide/what-is-amazon-eventbridge.html) im * EventBridge Amazon-Benutzerhandbuch*.

AWS Serverless Application Model (AWS SAM) generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)Ressource, wenn dieser Ereignistyp festgelegt ist.

**Anmerkung**  
EventBridge bietet jetzt eine neue Planungsfunktion, [Amazon EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/what-is-scheduler.html). Amazon EventBridge Scheduler ist ein serverloser Scheduler, mit dem Sie Aufgaben von einem zentralen, verwalteten Service aus erstellen, ausführen und verwalten können. EventBridge Schedulerist hochgradig anpassbar und bietet eine verbesserte Skalierbarkeit im EventBridge Vergleich zu geplanten Regeln mit einem breiteren Spektrum an API-Zieloperationen und. AWS-Services  
Wir empfehlen, dass Sie EventBridge Scheduler verwenden, um Ziele nach einem Zeitplan aufzurufen. Informationen zur Definition dieses Ereignisquellentyps in Ihren AWS SAM Vorlagen finden Sie unter[ScheduleV2](sam-property-function-schedulev2.md).

## Syntax
<a name="sam-property-function-schedule-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-schedule-syntax.yaml"></a>

```
  [DeadLetterConfig](#sam-function-schedule-deadletterconfig): DeadLetterConfig
  [Description](#sam-function-schedule-description): String
  [Enabled](#sam-function-schedule-enabled): Boolean
  [Input](#sam-function-schedule-input): String
  [Name](#sam-function-schedule-name): String
  [RetryPolicy](#sam-function-schedule-retrypolicy): [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)
  [Schedule](#sam-function-schedule-schedule): String
  [State](#sam-function-schedule-state): String
```

## Eigenschaften
<a name="sam-property-function-schedule-properties"></a>

 `DeadLetterConfig`   <a name="sam-function-schedule-deadletterconfig"></a>
Konfigurieren Sie die Amazon Simple Queue Service (Amazon SQS) -Warteschlange, über die Ereignisse nach einem fehlgeschlagenen Zielaufruf EventBridge gesendet werden. Der Aufruf kann beispielsweise fehlschlagen, wenn ein Ereignis an eine Lambda-Funktion gesendet wird, die nicht existiert, oder wenn EventBridge nicht genügend Berechtigungen zum Aufrufen der Lambda-Funktion vorhanden sind. *Weitere Informationen finden Sie unter [Richtlinien zur Wiederholung von Ereignissen und Verwenden von Warteschlangen mit unerlaubten Briefen im Amazon-Benutzerhandbuch](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html). EventBridge *  
Der [AWS::Serverless::Function](sam-resource-function.md) Ressourcentyp hat einen ähnlichen Datentyp`DeadLetterQueue`, der Fehler behandelt, die nach einem erfolgreichen Aufruf der Lambda-Zielfunktion auftreten. Beispiele für diese Arten von Fehlern sind Lambda-Drosselung oder Fehler, die von der Lambda-Zielfunktion zurückgegeben werden. *Weitere Informationen zur `DeadLetterQueue` Funktionseigenschaft finden Sie im Developer Guide unter Warteschlangen mit [uneingeschränktem Inhalt.](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)AWS Lambda *
*Typ:* [DeadLetterConfig](sam-property-function-scheduledeadletterconfig.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig)` Eigenschaft des Datentyps. `AWS::Events::Rule` `Target` Die AWS SAM Version dieser Eigenschaft enthält zusätzliche Untereigenschaften für den Fall, dass Sie die Warteschlange AWS SAM für unzustellbare Briefe erstellen möchten.

 `Description`   <a name="sam-function-schedule-description"></a>
Eine Beschreibung der Regel.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description)` Eigenschaft einer Ressource übergeben. `AWS::Events::Rule`

 `Enabled`   <a name="sam-function-schedule-enabled"></a>
Gibt an, ob die Regel aktiviert ist.  
Um die Regel zu deaktivieren, setzen Sie diese Eigenschaft auf`false`.  
Geben Sie entweder die `State` Eigenschaft `Enabled` oder an, aber nicht beide.
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` Eigenschaft einer `AWS::Events::Rule` Ressource. Wenn diese Eigenschaft auf `true` gesetzt ist, gilt sie AWS SAM als erfolgreich`ENABLED`, andernfalls gilt sie als erfolgreich`DISABLED`.

 `Input`   <a name="sam-function-schedule-input"></a>
Gültiger JSON-Text wurde an das Ziel übergeben. Wenn Sie diese Eigenschaft verwenden, wird nichts aus dem Ereignistext selbst an das Ziel weitergeleitet.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` Eigenschaft einer `AWS::Events::Rule Target` Ressource übergeben.

 `Name`   <a name="sam-function-schedule-name"></a>
Der Name der Regel. Wenn Sie keinen Namen angeben, CloudFormation generiert es eine eindeutige physische ID und verwendet diese ID als Regelnamen.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name)` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

 `RetryPolicy`   <a name="sam-function-schedule-retrypolicy"></a>
Ein `RetryPolicy`-Objekt, das Informationen zu den Richtlinieneinstellungen für Wiederholungsversuche enthält. *Weitere Informationen finden Sie unter [Richtlinien zur Wiederholung von Ereignissen und Verwenden von Warteschlangen mit unerlaubten Briefen im Amazon-Benutzerhandbuch](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html). EventBridge *  
*Typ:* [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)` Eigenschaft des Datentyps übergeben. `AWS::Events::Rule` `Target`

 `Schedule`   <a name="sam-function-schedule-schedule"></a>
Der Planungsausdruck, der bestimmt, wann und wie oft die Regel ausgeführt wird. Weitere Informationen finden Sie unter [Planen von Ausdrücken für Regeln](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html).  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ScheduleExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression)` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

 `State`   <a name="sam-function-schedule-state"></a>
Der Status der Regel.  
*Zulässige Werte:* `DISABLED | ENABLED`  
Geben Sie entweder die `State` Eigenschaft `Enabled` oder an, aber nicht beide.
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

## Beispiele
<a name="sam-property-function-schedule--examples"></a>

### CloudWatch Veranstaltung planen
<a name="sam-property-function-schedule--examples--cloudwatch-schedule-event"></a>

CloudWatch Beispiel für einen Termin planen

#### YAML
<a name="sam-property-function-schedule--examples--cloudwatch-schedule-event--yaml"></a>

```
CWSchedule:
  Type: Schedule
  Properties:
    Schedule: 'rate(1 minute)'
    Name: TestSchedule
    Description: test schedule
    Enabled: false
```

# DeadLetterConfig
<a name="sam-property-function-scheduledeadletterconfig"></a>

Das Objekt, das zur Angabe der Amazon Simple Queue Service (Amazon SQS) -Warteschlange verwendet wird, über die Ereignisse nach einem fehlgeschlagenen Zielaufruf EventBridge gesendet werden. Der Aufruf kann beispielsweise fehlschlagen, wenn ein Ereignis an eine Lambda-Funktion gesendet wird, die nicht existiert, oder wenn die Berechtigungen zum Aufrufen der Lambda-Funktion nicht ausreichen. *Weitere Informationen finden Sie unter [Richtlinien zur Wiederholung von Ereignissen und Verwenden von Warteschlangen mit unerlaubten Briefen im Amazon-Benutzerhandbuch](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html). EventBridge *

**Anmerkung**  
Der [AWS::Serverless::Function](sam-resource-function.md) Ressourcentyp hat einen ähnlichen Datentyp, `DeadLetterQueue` der Fehler behandelt, die nach einem erfolgreichen Aufruf der Lambda-Zielfunktion auftreten. Beispiele für diese Art von Fehler sind Lambda-Drosselung oder Fehler, die von der Lambda-Zielfunktion zurückgegeben werden. *Weitere Informationen zur `DeadLetterQueue` Funktionseigenschaft finden Sie im Entwicklerhandbuch unter Warteschlangen mit [uneingeschränktem Inhalt.](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)AWS Lambda *

## Syntax
<a name="sam-property-function-scheduledeadletterconfig-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS Serverless Application Model (AWS SAM) -Vorlage zu deklarieren.

### YAML
<a name="sam-property-function-scheduledeadletterconfig-syntax.yaml"></a>

```
  [Arn](#sam-function-scheduledeadletterconfig-arn): String
  [QueueLogicalId](#sam-function-scheduledeadletterconfig-queuelogicalid): String
  [Type](#sam-function-scheduledeadletterconfig-type): String
```

## Eigenschaften
<a name="sam-property-function-scheduledeadletterconfig-properties"></a>

 `Arn`   <a name="sam-function-scheduledeadletterconfig-arn"></a>
Der Amazon-Ressourcenname (ARN) der Amazon SQS-Warteschlange, der als Ziel für die Warteschlange mit unzustellbaren Briefen angegeben wurde.  
Geben Sie entweder die `Type` Eigenschaft oder `Arn` die Eigenschaft an, aber nicht beide.
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Arn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn)` Eigenschaft des `AWS::Events::Rule` `DeadLetterConfig` Datentyps übergeben.

 `QueueLogicalId`   <a name="sam-function-scheduledeadletterconfig-queuelogicalid"></a>
Der benutzerdefinierte Name der Warteschlange mit unerlaubten Briefen, die sie AWS SAM erstellt, `Type` ist angegeben.  
Wenn die `Type` Eigenschaft nicht festgelegt ist, wird diese Eigenschaft ignoriert.
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Type`   <a name="sam-function-scheduledeadletterconfig-type"></a>
Der Typ der Warteschlange. Wenn diese Eigenschaft festgelegt ist, wird AWS SAM automatisch eine Warteschlange für unzustellbare Nachrichten erstellt und die erforderliche [ressourcenbasierte Richtlinie](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-perms) angehängt, um der Regelressource die Erlaubnis zu erteilen, Ereignisse an die Warteschlange zu senden.  
Geben Sie entweder die `Type` Eigenschaft oder die Eigenschaft an, aber nicht beide`Arn`.
*Gültige Werte*: `SQS`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-function-scheduledeadletterconfig--examples"></a>

### DeadLetterConfig
<a name="sam-property-function-scheduledeadletterconfig--examples--deadletterconfig"></a>

DeadLetterConfig

#### YAML
<a name="sam-property-function-scheduledeadletterconfig--examples--deadletterconfig--yaml"></a>

```
DeadLetterConfig:
  Type: SQS
  QueueLogicalId: MyDLQ
```

# ScheduleV2
<a name="sam-property-function-schedulev2"></a>

Das Objekt, das einen `ScheduleV2` Ereignisquellentyp beschreibt, der Ihre serverlose Funktion als Ziel eines Amazon EventBridge Scheduler-Ereignisses festlegt, das nach einem Zeitplan ausgelöst wird. Weitere Informationen finden Sie unter [Was ist Amazon EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/what-is-scheduler.html)? im *EventBridge Scheduler-Benutzerhandbuch*.

AWS Serverless Application Model (AWS SAM) generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html)Ressource, wenn dieser Ereignistyp festgelegt ist.

## Syntax
<a name="sam-property-function-schedulev2-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-schedulev2-syntax.yaml"></a>

```
[DeadLetterConfig](#sam-function-schedulev2-deadletterconfig): DeadLetterConfig
[Description](#sam-function-schedulev2-description): String
[EndDate](#sam-function-schedulev2-enddate): String
[FlexibleTimeWindow](#sam-function-schedulev2-flexibletimewindow): FlexibleTimeWindow
[GroupName](#sam-function-schedulev2-groupname): String
[Input](#sam-function-schedulev2-input): String
[KmsKeyArn](#sam-function-schedulev2-kmskeyarn): String
[Name](#sam-function-schedulev2-name): String
OmitName: Boolean
[PermissionsBoundary](#sam-function-schedulev2-permissionsboundary): String
[RetryPolicy](#sam-function-schedulev2-retrypolicy): RetryPolicy
[RoleArn](#sam-function-schedulev2-rolearn): String
[ScheduleExpression](#sam-function-schedulev2-schedule): String
[ScheduleExpressionTimezone](#sam-function-schedulev2-scheduleexpressiontimezone): String
[StartDate](#sam-function-schedulev2-startdate): String
[State](#sam-function-schedulev2-state): String
```

## Eigenschaften
<a name="sam-property-function-schedulev2-properties"></a>

 `DeadLetterConfig`   <a name="sam-function-schedulev2-deadletterconfig"></a>
Konfigurieren Sie die Amazon Simple Queue Service (Amazon SQS) -Warteschlange, über die Ereignisse nach einem fehlgeschlagenen Zielaufruf EventBridge gesendet werden. Der Aufruf kann beispielsweise fehlschlagen, wenn ein Ereignis an eine Lambda-Funktion gesendet wird, die nicht existiert, oder wenn EventBridge nicht genügend Berechtigungen zum Aufrufen der Lambda-Funktion vorhanden sind. *Weitere Informationen finden Sie im Scheduler-Benutzerhandbuch unter [Konfiguration einer Warteschlange mit unerlaubten Briefen für den EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/configuring-schedule-dlq.html). EventBridge *  
Der [AWS::Serverless::Function](sam-resource-function.md) Ressourcentyp hat einen ähnlichen Datentyp`DeadLetterQueue`, der Fehler behandelt, die nach einem erfolgreichen Aufruf der Lambda-Zielfunktion auftreten. Beispiele für diese Arten von Fehlern sind Lambda-Drosselung oder Fehler, die von der Lambda-Zielfunktion zurückgegeben werden. *Weitere Informationen zur `DeadLetterQueue` Funktionseigenschaft finden Sie im Developer Guide unter Warteschlangen mit [uneingeschränktem Inhalt.](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)AWS Lambda *
*Typ:* [DeadLetterConfig](sam-property-function-scheduledeadletterconfig.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-deadletterconfig)` Eigenschaft des Datentyps. `AWS::Scheduler::Schedule` `Target` Die AWS SAM Version dieser Eigenschaft enthält zusätzliche Untereigenschaften für den Fall, dass Sie die Warteschlange AWS SAM für unzustellbare Briefe erstellen möchten.

 `Description`   <a name="sam-function-schedulev2-description"></a>
Eine Beschreibung des Zeitplans.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-description)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

 `EndDate`   <a name="sam-function-schedulev2-enddate"></a>
Das Datum in UTC, bevor der Zeitplan sein Ziel aufrufen kann. Abhängig vom Wiederholungsausdruck des Zeitplans können Aufrufe an oder vor dem von Ihnen angegebenen **EndDate** anhalten.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[EndDate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-enddate)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

 `FlexibleTimeWindow`   <a name="sam-function-schedulev2-flexibletimewindow"></a>
Ermöglicht die Konfiguration eines Fensters, in dem ein Zeitplan aufgerufen werden kann.  
*Typ:* [FlexibleTimeWindow](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-flexibletimewindow)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FlexibleTimeWindow](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-flexibletimewindow)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

 `GroupName`   <a name="sam-function-schedulev2-groupname"></a>
Der Name der Zeitplangruppe, die diesem Zeitplan zugeordnet werden soll. Wenn nicht definiert, wird die Standardgruppe verwendet.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[GroupName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-groupname)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

 `Input`   <a name="sam-function-schedulev2-input"></a>
Gültiger JSON-Text wurde an das Ziel übergeben. Wenn Sie diese Eigenschaft verwenden, wird nichts aus dem Ereignistext selbst an das Ziel weitergeleitet.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-input)` Eigenschaft einer `AWS::Scheduler::Schedule Target` Ressource übergeben.

 `KmsKeyArn`   <a name="sam-function-schedulev2-kmskeyarn"></a>
Der ARN für einen KMS-Schlüssel, der zur Verschlüsselung von Kundendaten verwendet wird.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-kmskeyarn)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

 `Name`   <a name="sam-function-schedulev2-name"></a>
Der Name des Plans. Wenn Sie keinen Namen angeben, AWS SAM generiert es einen Namen im Format `Function-Logical-IDEvent-Source-Name` und verwendet diese ID als Namen des Zeitplans.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-name)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

`OmitName`  <a name="sam-function-schedulev2-omitname"></a>
 AWS SAM Generiert und verwendet standardmäßig einen Zeitplannamen im Format von*<Function-logical-ID><event-source-name>*. Stellen Sie diese Eigenschaft so ein`true`, dass eine eindeutige physische ID CloudFormation generiert und diese stattdessen für den Zeitplannamen verwendet wird.  
*Typ*: Boolesch  
*Required*: No  
*Standardwert*: `false`  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `PermissionsBoundary`   <a name="sam-function-schedulev2-permissionsboundary"></a>
Der ARN der Richtlinie, mit der die Berechtigungsgrenze für die Rolle festgelegt wurde.  
Wenn sie definiert `PermissionsBoundary` ist, AWS SAM werden dieselben Grenzen auf die IAM-Zielrolle des Scheduler-Zeitplans angewendet.
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[PermissionsBoundary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary)` Eigenschaft einer `AWS::IAM::Role` Ressource übergeben.

 `RetryPolicy`   <a name="sam-function-schedulev2-retrypolicy"></a>
Ein **RetryPolicy**-Objekt, das Informationen zu den Richtlinieneinstellungen für Wiederholungsversuche enthält.  
*Typ:* [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy)` Eigenschaft des `AWS::Scheduler::Schedule` `Target` Datentyps übergeben.

 `RoleArn`   <a name="sam-function-schedulev2-rolearn"></a>
Der ARN der IAM-Rolle, die der EventBridge Scheduler für das Ziel verwendet, wenn der Zeitplan aufgerufen wird.  
*Typ:* [RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)` Eigenschaft des Datentyps übergeben. `AWS::Scheduler::Schedule` `Target`

 `ScheduleExpression`   <a name="sam-function-schedulev2-scheduleexpression"></a>
Der Scheduling-Ausdruck, der bestimmt, wann und wie oft das Scheduler-Zeitplanereignis ausgeführt wird.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ScheduleExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpression)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

 `ScheduleExpressionTimezone`   <a name="sam-function-schedulev2-scheduleexpressiontimezone"></a>
Die Zeitzone, in der der Planungsausdruck ausgewertet wird.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ScheduleExpressionTimezone](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpressiontimezone)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

 `StartDate`   <a name="sam-function-schedulev2-startdate"></a>
Das Datum in UTC, nach dem der Zeitplan mit dem Aufrufen eines Ziels beginnen kann. Abhängig vom Wiederholungsausdruck des Zeitplans können Aufrufe an oder nach dem von Ihnen angegebenen **StartDate** erfolgen.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[StartDate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-startdate)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

 `State`   <a name="sam-function-schedulev2-state"></a>
Der Status des Scheduler-Zeitplans.  
*Zulässige Werte:* `DISABLED | ENABLED`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-state)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

## Beispiele
<a name="sam-property-function-schedulev2--examples"></a>

### Einfaches Beispiel für die Definition einer ScheduleV2-Ressource
<a name="sam-property-function-schedulev2--examples--example1"></a>

```
Resources:
  Function:
    Properties:
      ...
      Events:
        ScheduleEvent:
          Type: ScheduleV2
          Properties:
            ScheduleExpression: "rate(1 minute)"
        ComplexScheduleEvent:
          Type: ScheduleV2
          Properties:
            ScheduleExpression: rate(1 minute)
            FlexibleTimeWindow:
              Mode: FLEXIBLE
              MaximumWindowInMinutes: 5
            StartDate: '2022-12-28T12:00:00.000Z'
            EndDate: '2023-01-28T12:00:00.000Z'
            ScheduleExpressionTimezone: UTC
            RetryPolicy:
              MaximumRetryAttempts: 5
              MaximumEventAgeInSeconds: 300
            DeadLetterConfig:
              Type: SQS
```

**Anmerkung**  
Die generierte physische ID von ScheduleV2 enthält keinen Stacknamen.

# SelfManagedKafka
<a name="sam-property-function-selfmanagedkafka"></a>

Das Objekt, das einen `SelfManagedKafka` Ereignisquellentyp beschreibt. Weitere Informationen finden Sie unter [Verwendung AWS Lambda mit selbstverwaltetem Apache Kafka](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html) im *AWS Lambda Entwicklerhandbuch*.

AWS Serverless Application Model (AWS SAM) generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)Ressource, wenn dieser Ereignistyp gesetzt ist.

Um Schema Registry verwenden zu können, müssen Sie spezifische IAM-Rollenberechtigungen für Ihre Funktion definieren. Ein Beispiel für die erforderliche [Konfiguration finden Sie unter Vollständige Einrichtung mit IAM-Rollen](sam-property-function-msk.md#sam-property-function-msk-example-complete).

## Syntax
<a name="sam-property-function-selfmanagedkafka-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS SAM Vorlage zu deklarieren.

### YAML
<a name="sam-property-function-selfmanagedkafka-syntax.yaml"></a>

```
  [BatchSize](#sam-function-selfmanagedkafka-batchsize): Integer
  [BisectBatchOnFunctionError](#sam-function-selfmanagedkafka-bisectbatchonfunctionerror): Boolean
  [ConsumerGroupId](#sam-function-selfmanagedkafka-consumergroupid): String
  DestinationConfig: [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html)
  [Enabled](#sam-function-selfmanagedkafka-enabled): Boolean
  [FilterCriteria](#sam-function-selfmanagedkafka-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [KafkaBootstrapServers](#sam-function-selfmanagedkafka-kafkabootstrapservers): List
  [FunctionResponseTypes](#sam-function-selfmanagedkafka-functionresponsetypes): List
  KmsKeyArn: String
  [LoggingConfig](#sam-function-selfmanagedkafka-loggingconfig): LoggingConfig
  [MaximumRecordAgeInSeconds](#sam-function-selfmanagedkafka-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#sam-function-selfmanagedkafka-maximumretryattempts): Integer
  [MetricsConfig](#sam-function-selfmanagedkafka-metricsconfig): MetricsConfig
  [ProvisionedPollerConfig](#sam-function-selfmanagedkafka-provisionedpollerconfig): [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)
  [SchemaRegistryConfig](#sam-function-selfmanagedkafka-schemaregistryconfig): [SchemaRegistryConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig.html)
  [SourceAccessConfigurations](#sam-function-selfmanagedkafka-sourceaccessconfigurations): [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)
  StartingPosition: String
  StartingPositionTimestamp: Double
  [Topics](#sam-function-selfmanagedkafka-topics): List
```

## Eigenschaften
<a name="sam-property-function-selfmanagedkafka-properties"></a>

 `BatchSize`   <a name="sam-function-selfmanagedkafka-batchsize"></a>
Die maximale Anzahl von Datensätzen in jedem Batch, die Lambda aus Ihrem Stream abruft und an Ihre Funktion sendet.  
*Typ*: Ganzzahl  
*Required*: No  
*Standard*: 100  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.  
*Minimum*: `1`  
*Maximum*: `10000`

 `BisectBatchOnFunctionError`   <a name="sam-function-selfmanagedkafka-bisectbatchonfunctionerror"></a>
Wenn die Funktion einen Fehler zurückgibt, teilen Sie den Stapel in zwei Teile auf und versuchen Sie es erneut.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `ConsumerGroupId`   <a name="sam-function-selfmanagedkafka-consumergroupid"></a>
Eine Zeichenfolge, die konfiguriert, wie Ereignisse aus Kafka-Themen gelesen werden.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[SelfManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `DestinationConfig`   <a name="sam-function-selfmanagedkafka-destinationconfig"></a>
Ein Konfigurationsobjekt, das das Ziel eines Ereignisses angibt, nachdem Lambda es verarbeitet hat.  
Verwenden Sie diese Eigenschaft, um das Ziel fehlgeschlagener Aufrufe aus der selbstverwalteten Kafka-Ereignisquelle anzugeben.  
*Typ:* [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)` Eigenschaft einer Ressource übergeben. `AWS::Lambda::EventSourceMapping`

 `Enabled`   <a name="sam-function-selfmanagedkafka-enabled"></a>
Deaktiviert den Ereignis-Quellzuweisung zum Anhalten und Aufrufen von Abfragen.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `FilterCriteria`   <a name="sam-function-selfmanagedkafka-filtercriteria"></a>
Ein Objekt, das die Kriterien definiert, anhand derer bestimmt wird, ob Lambda ein Ereignis verarbeiten soll. Weitere Informationen finden Sie unter [AWS Lambda Ereignisfilterung](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) im *AWS Lambda Entwicklerhandbuch*.  
*Typ:* [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-filtercriteria)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `KafkaBootstrapServers`   <a name="sam-function-selfmanagedkafka-kafkabootstrapservers"></a>
Die Liste der Bootstrap-Server für Ihre Kafka-Broker. Geben Sie zum Beispiel den Port an `broker.example.com:xxxx`  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `FunctionResponseTypes`   <a name="sam-function-selfmanagedkafka-functionresponsetypes"></a>
Eine Liste der Antworttypen, die derzeit auf die Ereignisquellenzuordnung angewendet werden. Weitere Informationen finden Sie unter [Melden von Batch-Elementen](https://docs.aws.amazon.com/lambda/latest/dg/kafka-retry-configurations.html) im *AWS Lambda -Leitfaden für Entwickler*.  
*Gültige Werte*: `ReportBatchItemFailures`  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `KmsKeyArn`   <a name="sam-function-selfmanagedkafka-kmskeyarn"></a>
Der Amazon-Ressourcenname (ARN) des Schlüssels zur Verschlüsselung von Informationen im Zusammenhang mit diesem Ereignis.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `LoggingConfig`   <a name="sam-function-selfmanagedkafka-loggingconfig"></a>
Die Protokollierungskonfiguration für Ihre Ereignisquelle.  
*Typ:* [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-loggingconfig)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MaximumRecordAgeInSeconds`   <a name="sam-function-selfmanagedkafka-maximumrecordageinseconds"></a>
Das maximale Alter eines Datensatzes, den Lambda zur Verarbeitung an eine Funktion sendet.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MetricsConfig`   <a name="sam-function-selfmanagedkafka-metricsconfig"></a>
Die Metrikkonfiguration für Ihre Ereignisquelle.  
*Typ:* [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-metricsconfig)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MaximumRetryAttempts`   <a name="sam-function-selfmanagedkafka-maximumretryattempts"></a>
Die maximale Anzahl der Wiederholungen, wenn die Funktion einen Fehler zurückgibt.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `ProvisionedPollerConfig`   <a name="sam-function-selfmanagedkafka-provisionedpollerconfig"></a>
Konfiguration zur Erhöhung der Anzahl von Pollern, die zur Berechnung von Ereignisquellenzuordnungen verwendet werden. Diese Konfiguration ermöglicht mindestens einen Poller und ein Maximum von 2000 Pollern. Ein Beispiel finden Sie unter [ProvisionedPollerConfig Beispiel](#sam-property-function-selfmanagedkafka-example-provisionedpollerconfig)  
*Typ:* [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-provisionedpollerconfig)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

`SchemaRegistryConfig`  <a name="sam-function-selfmanagedkafka-schemaregistryconfig"></a>
Konfiguration für die Verwendung einer Schemaregistrierung mit der selbstverwalteten Kafka-Ereignisquelle.  
Diese Funktion muss konfiguriert `ProvisionedPollerConfig` werden.
*Typ:* [SchemaRegistryConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig)  
*Required*: No  
*CloudFormation Kompatibilität:* Diese Eigenschaft wird direkt an die `[SelfManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `SourceAccessConfigurations`   <a name="sam-function-selfmanagedkafka-sourceaccessconfigurations"></a>
Ein Array des Authentifizierungsprotokolls, der VPC-Komponenten oder des virtuellen Hosts zum Sichern und Definieren Ihrer Ereignisquelle.  
*Gültige Werte*: `BASIC_AUTH | CLIENT_CERTIFICATE_TLS_AUTH | SASL_SCRAM_256_AUTH | SASL_SCRAM_512_AUTH | SERVER_ROOT_CA_CERTIFICATE`  
*Typ*: Liste von [SourceAccessConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration)  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität:* Diese Eigenschaft ist Teil der `[SelfManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource.

 `StartingPosition`   <a name="sam-function-selfmanagedkafka-startingposition"></a>
Die Position im Stream, an der mit dem Lesen begonnen wird.  
+ `AT_TIMESTAMP`— Geben Sie einen Zeitpunkt an, ab dem mit dem Lesen von Datensätzen begonnen werden soll.
+ `LATEST`— Nur neue Datensätze lesen.
+ `TRIM_HORIZON`— Verarbeitet alle verfügbaren Datensätze.
*Zulässige Werte*: `AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `StartingPositionTimestamp`   <a name="sam-function-selfmanagedkafka-startingpositiontimestamp"></a>
Die Zeit, ab der mit dem Lesen begonnen werden soll, in Unix-Zeitsekunden. Definiert`StartingPositionTimestamp`, wann als angegeben `StartingPosition` ist`AT_TIMESTAMP`.  
*Type*: Double  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `Topics`   <a name="sam-function-selfmanagedkafka-topics"></a>
Der Name des Kafka-Themas.  
*Typ*: Liste  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Topics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-topics)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

## Beispiele
<a name="sam-property-function-selfmanagedkafka--examples"></a>

### Vollständige Einrichtung mit IAM-Rollen
<a name="sam-property-function-selfmanagedkafka-example-complete"></a>

Das folgende Beispiel zeigt ein vollständiges Setup einschließlich der erforderlichen IAM-Rollenkonfiguration für die Verwendung von Schema Registry:

```
Parameters:
  PreCreatedSubnetOne:
    Type: String
  PreCreatedSubnetTwo:
    Type: String

Resources:
  MyLambdaExecutionRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Version: '2012-10-17		 	 	 '
        Statement:
        - Action: [sts:AssumeRole]
          Effect: Allow
          Principal:
            Service: [lambda.amazonaws.com]
      Policies:
      - PolicyName: KafkaAuthPolicy
        PolicyDocument:
          Statement:
          - Action: [secretsmanager:GetSecretValue, kms:Decrypt]
            Effect: "Allow"
            Resource: ['arn:aws:secretsmanager:us-west-2:123456789012:secret:kafkaSecret-******',
                        'arn:aws:kms:us-west-2:123456789012:key/keyId']
      - PolicyName: ENIPolicy
        PolicyDocument:
          Statement:
          - Action: [ec2:CreateNetworkInterface,
              ec2:DescribeNetworkInterfaces, ec2:DescribeVpcs, ec2:DeleteNetworkInterface,
              ec2:DescribeSubnets, ec2:DescribeSecurityGroups]
            Effect: Allow
            Resource: '*'
      - PolicyName: SchemaRegistryPolicy
        PolicyDocument:
          Statement:
          - Action: [glue:GetRegistry]
            Effect: Allow
            Resource: 'arn:aws:glue:{region}:{account-id}:registry/{registry-name}'
      - PolicyName: SchemaVersionsPolicy
        PolicyDocument:
          Statement:
          - Action: [glue:GetSchemaVersions]
            Effect: Allow
            Resource: '*'
      ManagedPolicyArns:
      - !Sub arn:${AWS::Partition}:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole
      Tags:
      - {Value: SAM, Key: lambda:createdBy}

  MyKafkaProcessor:
    Type: AWS::Serverless::Function
    Properties:
      Runtime: nodejs18.x
      Handler: index.handler
      CodeUri: ${codeuri}
      Role:
        Fn::GetAtt: [MyLambdaExecutionRole, Arn]
      Events:
        SelfManagedKafkaEvent:
          Type: SelfManagedKafka
          Properties:
            KafkaBootstrapServers:
              - my-kafka-broker-1:9092
              - my-kafka-broker-2:9092
            Topics:
              - SchemaRegistryTestTopic
            StartingPosition: LATEST
            SourceAccessConfigurations:
              - Type: VPC_SUBNET
                URI: subnet:subnet-12345678
              - Type: VPC_SECURITY_GROUP
                URI: security_group:sg-12345678
              - Type: BASIC_AUTH
                URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
            ProvisionedPollerConfig:
              MinimumPollers: 1
            SchemaRegistryConfig:
              AccessConfigs:
              - Type: BASIC_AUTH
                URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
              SchemaValidationConfigs:
              - Attribute: KEY
              EventRecordFormat: JSON
              SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry
```

### ProvisionedPollerConfig Beispiel
<a name="sam-property-function-selfmanagedkafka-example-provisionedpollerconfig"></a>

```
ProvisionedPollerConfig:
  MinimumPollers: 1
  MaximumPollers: 200
```

### Selbstverwaltete Kafka-Eventquelle
<a name="sam-property-function-selfmanagedkafka--examples--self-managed-kafka-event-source"></a>

Im Folgenden finden Sie ein Beispiel für einen `SelfManagedKafka` Ereignisquellentyp.

#### YAML
<a name="sam-property-function-selfmanagedkafka--examples--self-managed-kafka-event-source--yaml"></a>

```
Events:
  SelfManagedKafkaEvent:
    Type: SelfManagedKafka
    Properties:
      BatchSize: 1000
      Enabled: true
      KafkaBootstrapServers:
        - abc.xyz.com:xxxx
      SourceAccessConfigurations:
        -  Type: BASIC_AUTH
           URI: arn:aws:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c
      Topics:
        - MyKafkaTopic
```

### Selbstverwaltete Kafka-Ereignisquelle mit AWS Glue Schemaregistrierung
<a name="sam-property-function-selfmanagedkafka-example-schemaregistry"></a>

Im Folgenden finden Sie ein Beispiel für einen mit AWS Glue Schema Registry konfigurierten `SelfManagedKafka` Ereignisquellentyp.

```
Events:
  SelfManagedKafkaEvent:
    Type: SelfManagedKafka
    Properties:
      KafkaBootstrapServers:
        - abc.xyz.com:9092
      Topics:
        - SchemaRegistryTestTopic
      StartingPosition: LATEST
      ProvisionedPollerConfig:
        MinimumPollers: 1
      SchemaRegistryConfig:
        SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry
        EventRecordFormat: JSON
        SchemaValidationConfigs:
          - Attribute: KEY
          - Attribute: VALUE
      SourceAccessConfigurations:
        - Type: VPC_SUBNET
          URI: subnet:subnet-12345678
        - Type: VPC_SECURITY_GROUP
          URI: security_group:sg-12345678
```

### Selbstverwaltete Kafka-Ereignisquelle mit Confluent Schema Registry
<a name="sam-property-function-selfmanagedkafka-example-schemaregistry-confluent"></a>

Im Folgenden finden Sie ein Beispiel für einen `SelfManagedKafka` Ereignisquellentyp, der mit Confluent Schema Registry konfiguriert wurde.

```
Events:
  SelfManagedKafkaEvent:
    Type: SelfManagedKafka
    Properties:
      KafkaBootstrapServers:
        - abc.xyz.com:9092
      Topics:
        - SchemaRegistryTestTopic
      StartingPosition: LATEST
      ProvisionedPollerConfig:
        MinimumPollers: 1
      SchemaRegistryConfig:
        SchemaRegistryURI: https://my-schema-registry.confluent.cloud
        AccessConfigs:
          - Type: BASIC_AUTH
            URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-secret
        EventRecordFormat: JSON
        SchemaValidationConfigs:
          - Attribute: KEY
          - Attribute: VALUE
      SourceAccessConfigurations:
        - Type: VPC_SUBNET
          URI: subnet:subnet-12345678
        - Type: VPC_SECURITY_GROUP
          URI: security_group:sg-12345678
        - Type: BASIC_AUTH
          URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:kafka-secret
```

# SNS
<a name="sam-property-function-sns"></a>

Das Objekt, das einen `SNS` Ereignisquellentyp beschreibt.

SAM generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html)Ressource, wenn dieser Ereignistyp festgelegt ist

## Syntax
<a name="sam-property-function-sns-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-sns-syntax.yaml"></a>

```
  [FilterPolicy](#sam-function-sns-filterpolicy): [SnsFilterPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy)
  FilterPolicyScope: String
  RedrivePolicy: Json
  [Region](#sam-function-sns-region): String
  [SqsSubscription](#sam-function-sns-sqssubscription): Boolean | SqsSubscriptionObject
  [Topic](#sam-function-sns-topic): String
```

## Eigenschaften
<a name="sam-property-function-sns-properties"></a>

 `FilterPolicy`   <a name="sam-function-sns-filterpolicy"></a>
Das Filterrichtlinien-JSON, das dem Abonnement zugeordnet ist. Weitere Informationen finden Sie [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)in der Amazon Simple Notification Service API-Referenz.  
*Typ:* [SnsFilterPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FilterPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy)` Eigenschaft einer `AWS::SNS::Subscription` Ressource übergeben.

 `FilterPolicyScope`   <a name="sam-function-sns-filterpolicyscope"></a>
Mit diesem Attribut können Sie den Filterbereich mithilfe eines der folgenden Zeichenfolgenwerttypen auswählen:  
+ `MessageAttributes`— Der Filter wird auf die Nachrichtenattribute angewendet.
+ `MessageBody`— Der Filter wird auf den Nachrichtentext angewendet.
*Typ:* Zeichenfolge  
*Required*: No  
*Standardwert*: `MessageAttributes`  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die ` [ FilterPolicyScope](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicyscope)` Eigenschaft einer `AWS::SNS::Subscription` Ressource übergeben.

 `RedrivePolicy`   <a name="sam-function-sns-redrivepolicy"></a>
Wenn angegeben, werden unzustellbare Nachrichten an die angegebene Amazon SQS-Warteschlange für unzustellbare Nachrichten gesendet. Nachrichten, die aufgrund von Clientfehlern (z. B. wenn der abonnierte Endpunkt nicht erreichbar ist) oder Serverfehlern (z. B. wenn der Service, der den abonnierten Endpunkt betreibt, nicht verfügbar ist) nicht zugestellt werden können, werden in der Warteschlange für unzustellbare Nachrichten zur weiteren Analyse oder erneuten Verarbeitung gespeichert.  
*Weitere Informationen zur Redrive-Richtlinie und zu Warteschlangen für unzustellbare Briefe finden Sie unter [Amazon SQS Dead-Letter-Warteschlangen im Amazon Simple](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) Queue Service Developer Guide.*  
*Type*: Json  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die Eigenschaft einer Ressource übergeben. `[ RedrivePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-redrivepolicy)` `AWS::SNS::Subscription`

 `Region`   <a name="sam-function-sns-region"></a>
Für regionsübergreifende Abonnements, die Region, in der das Thema gespeichert ist.  
Wenn keine Region angegeben ist, wird standardmäßig die Region des Anrufers CloudFormation verwendet.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Region](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-region)` Eigenschaft einer `AWS::SNS::Subscription` Ressource übergeben.

 `SqsSubscription`   <a name="sam-function-sns-sqssubscription"></a>
Setzen Sie diese Eigenschaft auf true oder geben Sie `SqsSubscriptionObject` an, dass SNS-Themenbenachrichtigungen in einer SQS-Warteschlange gebündelt werden sollen. Wenn Sie diese Eigenschaft auf festlegen, `true` wird eine neue SQS-Warteschlange erstellt, wohingegen die Angabe von a eine vorhandene SQS-Warteschlange `SqsSubscriptionObject` verwendet.  
*Typ: Boolean* \$1 [SqsSubscriptionObject](sam-property-function-sqssubscriptionobject.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Topic`   <a name="sam-function-sns-topic"></a>
Der ARN des zu abonnierenden Themas.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[TopicArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#topicarn)` Eigenschaft einer `AWS::SNS::Subscription` Ressource übergeben.

## Beispiele
<a name="sam-property-function-sns--examples"></a>

### Beispiel für eine SNS-Ereignisquelle
<a name="sam-property-function-sns--examples--sns-event-source-example"></a>

Beispiel für eine SNS-Ereignisquelle

#### YAML
<a name="sam-property-function-sns--examples--sns-event-source-example--yaml"></a>

```
Events:
  SNSEvent:
    Type: SNS
    Properties:
      Topic: arn:aws:sns:us-east-1:123456789012:my_topic
      SqsSubscription: true
      FilterPolicy:
        store:
          - example_corp
        price_usd:
          - numeric:
              - ">="
              - 100
```

# SqsSubscriptionObject
<a name="sam-property-function-sqssubscriptionobject"></a>

Geben Sie eine bestehende SQS-Warteschlangenoption für das SNS-Ereignis an

## Syntax
<a name="sam-property-function-sqssubscriptionobject-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-sqssubscriptionobject-syntax.yaml"></a>

```
  [BatchSize](#sam-function-sqssubscriptionobject-batchsize): String
  [Enabled](#sam-function-sqssubscriptionobject-enabled): Boolean
  [QueueArn](#sam-function-sqssubscriptionobject-queuearn): String
  [QueuePolicyLogicalId](#sam-function-sqssubscriptionobject-queuepolicylogicalid): String
  [QueueUrl](#sam-function-sqssubscriptionobject-queueurl): String
```

## Eigenschaften
<a name="sam-property-function-sqssubscriptionobject-properties"></a>

 `BatchSize`   <a name="sam-function-sqssubscriptionobject-batchsize"></a>
Die maximale Anzahl von Elementen, die in einem einzigen Batch für die SQS-Warteschlange abgerufen werden können.  
*Typ:* Zeichenfolge  
*Required*: No  
*Standard*: 10  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Enabled`   <a name="sam-function-sqssubscriptionobject-enabled"></a>
Deaktiviert die Zuordnung der SQS-Ereignisquellen, um die Abfrage und den Aufruf zu unterbrechen.  
*Typ*: Boolesch  
*Required*: No  
*Standard: Wahr*  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `QueueArn`   <a name="sam-function-sqssubscriptionobject-queuearn"></a>
Geben Sie einen vorhandenen SQS-Warteschlangen-ARN an.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `QueuePolicyLogicalId`   <a name="sam-function-sqssubscriptionobject-queuepolicylogicalid"></a>
Geben Sie einen benutzerdefinierten LogicalID-Namen für die Ressource ein. [AWS::SQS::QueuePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html)  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. CloudFormation 

 `QueueUrl`   <a name="sam-function-sqssubscriptionobject-queueurl"></a>
Geben Sie die Warteschlangen-URL an, die der `QueueArn` Eigenschaft zugeordnet ist.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-function-sqssubscriptionobject--examples"></a>

### Existierendes Ereignis SQS für SNS
<a name="sam-property-function-sqssubscriptionobject--examples--existing-sqs-for-sns-event"></a>

Beispiel für das Hinzufügen einer vorhandenen SQS-Warteschlange zum Abonnieren eines SNS-Themas.

#### YAML
<a name="sam-property-function-sqssubscriptionobject--examples--existing-sqs-for-sns-event--yaml"></a>

```
QueuePolicyLogicalId: CustomQueuePolicyLogicalId
QueueArn:
  Fn::GetAtt: MyCustomQueue.Arn
QueueUrl:
  Ref: MyCustomQueue
BatchSize: 5
```

# SQS
<a name="sam-property-function-sqs"></a>

Das Objekt, das einen `SQS` Ereignisquellentyp beschreibt. Weitere Informationen finden Sie unter [Using AWS Lambda with Amazon SQS](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html) im *AWS Lambda Developer Guide*.

SAM generiert [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)Ressourcen, wenn dieser Ereignistyp festgelegt ist

## Syntax
<a name="sam-property-function-sqs-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-sqs-syntax.yaml"></a>

```
  [BatchSize](#sam-function-sqs-batchsize): Integer
  [Enabled](#sam-function-sqs-enabled): Boolean
  [FilterCriteria](#sam-function-sqs-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [FunctionResponseTypes](#sam-function-sqs-functionresponsetypes): List
  KmsKeyArn: String
  [MaximumBatchingWindowInSeconds](#sam-function-sqs-maximumbatchingwindowinseconds): Integer
  [MetricsConfig](#sam-function-sqs-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)
  [ProvisionedPollerConfig](#sam-function-sqs-provisionedpollerconfig): [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)
  [Queue](#sam-function-sqs-queue): String
  ScalingConfig: [ScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html)
```

## Eigenschaften
<a name="sam-property-function-sqs-properties"></a>

 `BatchSize`   <a name="sam-function-sqs-batchsize"></a>
Gibt die maximale Anzahl der Elemente an, die in einem einzigen Stapel zurückzugeben werden.  
*Typ*: Ganzzahl  
*Required*: No  
*Standard*: 10  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.  
*Minimum*: `1`  
*Maximum*: `10000`

 `Enabled`   <a name="sam-function-sqs-enabled"></a>
Deaktiviert den Ereignis-Quellzuweisung zum Anhalten und Aufrufen von Abfragen.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `FilterCriteria`   <a name="sam-function-sqs-filtercriteria"></a>
Ein Objekt, das die Kriterien definiert, anhand derer bestimmt wird, ob Lambda ein Ereignis verarbeiten soll. Weitere Informationen finden Sie unter [AWS Lambda Ereignisfilterung](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) im *AWS Lambda Entwicklerhandbuch*.  
*Typ:* [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `FunctionResponseTypes`   <a name="sam-function-sqs-functionresponsetypes"></a>
 Eine Liste der Antworttypen, die derzeit auf die Ereignisquellenzuordnung angewendet werden. Weitere Informationen finden Sie im *AWS Lambda Entwicklerhandbuch* unter [Melden von Fehlern bei Batch-Elementen](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-batchfailurereporting).   
 *Gültige Werte*: `ReportBatchItemFailures`   
 *Typ*: Liste   
 *Required*: No   
 *CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben. 

 `KmsKeyArn`   <a name="sam-function-sqs-kmskeyarn"></a>
Der Amazon-Ressourcenname (ARN) des Schlüssels zur Verschlüsselung von Informationen zu diesem Ereignis.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-sqs-maximumbatchingwindowinseconds"></a>
Die maximale Zeit in Sekunden für das Sammeln von Datensätzen vor dem Aufrufen der Funktion.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `MetricsConfig`   <a name="sam-function-sqs-metricsconfig"></a>
Eine optionale Konfiguration, um erweiterte Metriken für Zuordnungen von Ereignisquellen zu erhalten, die jede Phase der Verarbeitung erfassen. Ein Beispiel finden Sie unter [MetricsConfig Ereignis](sam-property-function-dynamodb.md#sam-property-function-dynamodb-example-metricsconfigevent).  
*Typ:* [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)` Eigenschaft einer Ressource übergeben. `AWS::Lambda::EventSourceMapping`

 `ProvisionedPollerConfig`   <a name="sam-function-sqs-provisionedpollerconfig"></a>
Konfiguration zur Erhöhung der Anzahl von Pollern, die zur Berechnung von Ereignisquellenzuordnungen verwendet werden. Diese Konfiguration ermöglicht ein Minimum von 2 Pollern und ein Maximum von 2000 Pollern. Ein Beispiel finden Sie unter. [ProvisionedPollerConfig Beispiel](#sam-property-function-sqs-example-provisionedpollerconfig)  
*Typ:* [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `Queue`   <a name="sam-function-sqs-queue"></a>
Der ARN der Warteschlange.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` Eigenschaft einer `AWS::Lambda::EventSourceMapping` Ressource übergeben.

 `ScalingConfig`   <a name="sam-function-sqs-scalingconfig"></a>
Skalierung der Konfiguration von SQS-Pollern zur Steuerung der Aufrufrate und zur Festlegung der maximalen Anzahl gleichzeitiger Aufrufe.  
*Typ:* `[ScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html)`  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ ScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html)` Eigenschaft einer Ressource übergeben. `AWS::Lambda::EventSourceMapping`

## Beispiele
<a name="sam-property-function-sqs--examples"></a>

### MetricsConfig Ereignis
<a name="sam-property-function-sqs-example-metricsconfigevent"></a>

Im Folgenden finden Sie ein Beispiel für eine Ressource, die die `MetricsConfig` Eigenschaft verwendet, um jede Phase der Verarbeitung ihrer Ereignisquellenzuordnungen zu erfassen.

```
Resources:
  FilteredEventsFunction:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: s3://sam-demo-bucket/metricsConfig.zip
      Handler: index.handler
      Runtime: nodejs16.x
      Events:
        KinesisStream:
          Type: Kinesis
          Properties:
            Stream: !GetAtt KinesisStream.Arn
            StartingPosition: LATEST
            MetricsConfig:
              Metrics:
              - EventCount
```

### Einfaches SQS-Ereignis
<a name="sam-property-function-sqs--examples--sqs-event"></a>

```
Events:
  SQSEvent:
    Type: SQS
    Properties:
      Queue: arn:aws:sqs:us-west-2:012345678901:my-queue
      BatchSize: 10
      Enabled: false
      FilterCriteria:
        Filters:
          - Pattern: '{"key": ["val1", "val2"]}'
```

### Konfigurieren Sie die teilweise Batch-Berichterstattung für Ihre SQS-Warteschlange
<a name="sam-property-function-sqs--examples--sqs-partial-batch"></a>

```
Events:
  SQSEvent:
    Type: SQS
    Properties:
      Enabled: true
      FunctionResponseTypes:
        - ReportBatchItemFailures
      Queue: !GetAtt MySqsQueue.Arn
      BatchSize: 10
```

### Lambda-Funktion mit einem SQS-Ereignis, für das die Skalierung konfiguriert ist
<a name="sam-property-function-sqs--examples--sqs-event-scaling"></a>

```
MyFunction:
  Type: AWS::Serverless::Function
  Properties:
    ...
    Events:
      MySQSEvent:
        Type: SQS
        Properties:
          ...
          ScalingConfig:
            MaximumConcurrency: 10
```

### ProvisionedPollerConfig Beispiel
<a name="sam-property-function-sqs-example-provisionedpollerconfig"></a>

```
MyFunction:
  Type: AWS::Serverless::Function
  Properties:
    Handler: index.handler
    Runtime: nodejs18.x
    Timeout: 30
    Events:
      SQSEvent:
        Type: SQS
        Properties:
          Queue: !GetAtt MyQueue.Arn
          BatchSize: 10
          Enabled: True
          ProvisionedPollerConfig:
            MaximumPollers: 300
            MinimumPollers: 10
```

# FunctionCode
<a name="sam-property-function-functioncode"></a>

Das [Bereitstellungspaket](https://docs.aws.amazon.com/lambda/latest/dg/deployment-package-v2.html) für eine Lambda-Funktion.

## Syntax
<a name="sam-property-function-functioncode-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS Serverless Application Model (AWS SAM) -Vorlage zu deklarieren.

### YAML
<a name="sam-property-function-functioncode-syntax.yaml"></a>

```
  [Bucket](#sam-function-functioncode-bucket): String
  [Key](#sam-function-functioncode-key): String
  [Version](#sam-function-functioncode-version): String
```

## Eigenschaften
<a name="sam-property-function-functioncode-properties"></a>

 `Bucket`   <a name="sam-function-functioncode-bucket"></a>
Ein Amazon S3 S3-Bucket in derselben AWS Region wie Ihre Funktion.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[S3Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3bucket)` Eigenschaft des `AWS::Lambda::Function` `Code` Datentyps übergeben.

 `Key`   <a name="sam-function-functioncode-key"></a>
Der Amazon S3-Schlüssel des Bereitstellungspakets.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[S3Key](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3key)` Eigenschaft des `AWS::Lambda::Function` `Code` Datentyps übergeben.

 `Version`   <a name="sam-function-functioncode-version"></a>
Für versionierte Objekte, die Version des zu verwendenden Bereitstellungspaketobjekts.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[S3ObjectVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3objectversion)` Eigenschaft des `AWS::Lambda::Function` `Code` Datentyps übergeben.

## Beispiele
<a name="sam-property-function-functioncode--examples"></a>

### FunctionCode
<a name="sam-property-function-functioncode--examples--functioncode"></a>

`CodeUri`: Beispiel für einen Funktionscode

#### YAML
<a name="sam-property-function-functioncode--examples--functioncode--yaml"></a>

```
CodeUri:
  Bucket: sam-s3-demo-bucket-name
  Key: mykey-name
  Version: 121212
```

# FunctionUrlConfig
<a name="sam-property-function-functionurlconfig"></a>

Erzeugt eine AWS Lambda Funktions-URL mit den angegebenen Konfigurationsparametern. Eine Lambda-Funktions-URL ist ein HTTPS-Endpunkt, mit dem Sie Ihre Funktion aufrufen können.

Standardmäßig verwendet die von Ihnen erstellte Funktions-URL die `$LATEST` Version Ihrer Lambda-Funktion. Wenn Sie `AutoPublishAlias` für Ihre Lambda-Funktion eine angeben, stellt der Endpunkt eine Verbindung zum angegebenen Funktionsalias her.

Weitere Informationen finden Sie unter [Lambda-Funktion URLs](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html) im *AWS Lambda Entwicklerhandbuch*.

## Syntax
<a name="sam-property-function-functionurlconfig-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-functionurlconfig-syntax.yaml"></a>

```
[AuthType](#sam-function-functionurlconfig-authtype): String
[Cors](#sam-function-functionurlconfig-cors): [Cors](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html)
[InvokeMode](#sam-function-functionurlconfig-invokemode): String
```

## Eigenschaften
<a name="sam-property-function-functionurlconfig-properties"></a>

 `AuthType`   <a name="sam-function-functionurlconfig-authtype"></a>
Die Art der Autorisierung für Ihre Funktions-URL. Um AWS Identity and Access Management (IAM) zur Autorisierung von Anfragen zu verwenden, stellen Sie auf ein. `AWS_IAM` Stellen Sie für Open Access auf ein. `NONE`  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[AuthType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-authtype)` Eigenschaft einer `AWS::Lambda::Url` Ressource übergeben.

 `Cors`   <a name="sam-function-functionurlconfig-cors"></a>
Die Cross-Origin Resource Sharing (CORS)-Einstellungen für Ihre Funktions-URL.  
*Type*: [Cors](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Cors](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html)` Eigenschaft einer `AWS::Lambda::Url` Ressource übergeben.

 `InvokeMode`  <a name="sam-function-functionurlconfig-invokemode"></a>
Der Modus, in dem Ihre Funktions-URL aufgerufen wird. Damit Ihre Funktion die Antwort nach Abschluss des Aufrufs zurückgibt, setzen Sie die Einstellung auf. `BUFFERED` Damit Ihre Funktion die Antwort streamt, setzen Sie den Wert auf`RESPONSE_STREAM`. Der Standardwert ist `BUFFERED`.  
*Zulässige Werte*: `BUFFERED` oder `RESPONSE_STREAM`.  
*Typ:* Zeichenfolge  
*Required*: No  
*AWS CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-invokemode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-invokemode)Eigenschaft einer `AWS::Lambda::Url` Ressource übergeben.

## Beispiele
<a name="sam-property-function-functionurlconfig--examples"></a>

### URL der Funktion
<a name="sam-property-function-functionurlconfig--examples--function-url"></a>

Das folgende Beispiel erstellt eine Lambda-Funktion mit einer Funktions-URL. Die Funktions-URL verwendet die IAM-Autorisierung.

#### YAML
<a name="sam-property-function-functionurlconfig--examples--function-url--yaml"></a>

```
HelloWorldFunction:
  Type: AWS::Serverless::Function
  Properties:
    CodeUri: hello_world/
    Handler: index.handler
    Runtime: nodejs20.x
    FunctionUrlConfig:
      AuthType: AWS_IAM
      InvokeMode: RESPONSE_STREAM

Outputs:
  MyFunctionUrlEndpoint:
      Description: "My Lambda Function URL Endpoint"
      Value:
        Fn::GetAtt: HelloWorldFunctionUrl.FunctionUrl
```

# CapacityProviderConfig
<a name="sam-property-function-capacityproviderconfig"></a>

Konfiguriert den Kapazitätsanbieter, an den veröffentlichte Versionen der Funktion angehängt werden. Dadurch kann die Funktion auf kundeneigenen EC2 Instanzen ausgeführt werden, die von Lambda verwaltet werden.

**Anmerkung**  
Diese Konfiguration bestimmt den Rechentyp einer Funktion und muss bei der ersten Funktionsbereitstellung angegeben werden. Sie kann nicht hinzugefügt oder entfernt werden, nachdem die Funktionsressource erstellt wurde.

## Syntax
<a name="sam-property-function-capacityproviderconfig-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-function-capacityproviderconfig-syntax.yaml"></a>

```
[Arn](#sam-function-capacityproviderconfig-arn): String
[ExecutionEnvironmentMemoryGiBPerVCpu](#sam-function-capacityproviderconfig-executionenvironmentmemorygibpervcpu): Float
[PerExecutionEnvironmentMaxConcurrency](#sam-function-capacityproviderconfig-perexecutionenvironmentmaxconcurrency): Integer
```

## Eigenschaften
<a name="sam-property-function-capacityproviderconfig-properties"></a>

 `Arn`   <a name="sam-function-capacityproviderconfig-arn"></a>
Der ARN des Kapazitätsanbieters, der für diese Funktion verwendet werden soll.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft gibt es nur bei SAM.

 `ExecutionEnvironmentMemoryGiBPerVCpu`   <a name="sam-function-capacityproviderconfig-executionenvironmentmemorygibpervcpu"></a>
Das Verhältnis von Arbeitsspeicher (in GiB) zu vCPU für jede Ausführungsumgebung.  
Das Speicherverhältnis pro CPU darf den Gesamtspeicher der Funktion von 2048 MB nicht überschreiten. Die unterstützten memory-to-CPU Verhältnisse sind 2 GB, 4 GB oder 8 GB pro CPU.
*Typ: Float*  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ExecutionEnvironmentMemoryGiBPerVCpu](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-lambdamanagedinstancescapacityproviderconfig)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `PerExecutionEnvironmentMaxConcurrency`   <a name="sam-function-capacityproviderconfig-perexecutionenvironmentmaxconcurrency"></a>
Die maximale Anzahl gleichzeitiger Ausführungen pro Ausführungsumgebung (Sandbox).  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[PerExecutionEnvironmentMaxConcurrency](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-lambdamanagedinstancescapacityproviderconfig)` Eigenschaft einer Ressource übergeben. `AWS::Lambda::Function`

## Beispiele
<a name="sam-property-function-capacityproviderconfig-examples"></a>

### Kapazitätsanbieter-Konfiguration
<a name="sam-property-function-capacityproviderconfig-examples-basic"></a>

Das folgende Beispiel zeigt eine Kapazitätsanbieterkonfiguration, die auf eine Kapazitätsanbieterressource verweist.

```
CapacityProviderConfig:
  Arn: !GetAtt MyCapacityProvider.Arn
  ExecutionEnvironmentMemoryGiBPerVCpu: 4.0
  PerExecutionEnvironmentMaxConcurrency: 100
```

# FunctionScalingConfig
<a name="sam-property-function-functionscalingconfig"></a>

Konfiguriert das Skalierungsverhalten für Lambda-Funktionsversionen und steuert die Anzahl der Ausführungsumgebungen (Sandboxen), die erstellt werden können. Diese Konfiguration gilt sowohl für \$1LATEST.PUBLISHED als auch für numerische Funktionsversionen.

## Syntax
<a name="sam-property-function-functionscalingconfig-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS Serverless Application Model (AWS SAM) -Vorlage zu deklarieren.

### YAML
<a name="sam-property-function-functionscalingconfig-syntax.yaml"></a>

```
[MinExecutionEnvironments](#sam-function-functionscalingconfig-minexecutionenvironments): Integer
[MaxExecutionEnvironments](#sam-function-functionscalingconfig-maxexecutionenvironments): Integer
```

## Eigenschaften
<a name="sam-property-function-functionscalingconfig-properties"></a>

 `MinExecutionEnvironments`   <a name="sam-function-functionscalingconfig-minexecutionenvironments"></a>
Die Mindestanzahl von Ausführungsumgebungen, die für die Funktionsversion verwaltet werden müssen.  
*Typ*: Ganzzahl  
*Required*: No  
*Standardwert*: `3`  
*Minimum*: `0`  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MinExecutionEnvironments](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionscalingconfig-minexecutionenvironments)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

 `MaxExecutionEnvironments`   <a name="sam-function-functionscalingconfig-maxexecutionenvironments"></a>
Die maximale Anzahl von Ausführungsumgebungen, die für die Funktionsversion erstellt werden können.  
*Typ*: Ganzzahl  
*Required*: No  
*Standardwert*: `3`  
*Minimum*: `0`  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MaxExecutionEnvironments](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionscalingconfig-maxexecutionenvironments)` Eigenschaft einer `AWS::Lambda::Function` Ressource übergeben.

## Beispiele
<a name="sam-property-function-functionscalingconfig-examples"></a>

### Konfiguration der Funktionsskalierung
<a name="sam-property-function-functionscalingconfig-examples-basic"></a>

Das folgende Beispiel zeigt eine Konfiguration zur Funktionsskalierung mit minimalen und maximalen Ausführungsumgebungen.

```
FunctionScalingConfig:
  MinExecutionEnvironments: 5
  MaxExecutionEnvironments: 100
```

# AWS::Serverless::GraphQLApi
<a name="sam-resource-graphqlapi"></a>

Verwenden Sie den `AWS::Serverless::GraphQLApi` Ressourcentyp AWS Serverless Application Model (AWS SAM), um eine AWS AppSync GraphQL API für Ihre serverlose Anwendung zu erstellen und zu konfigurieren.

Weitere Informationen dazu finden Sie AWS AppSync unter [Was ist AWS AppSync?](https://docs.aws.amazon.com/appsync/latest/devguide/what-is-appsync.html) im *AWS AppSync Entwicklerhandbuch*.

## Syntax
<a name="sam-resource-graphqlapi-syntax"></a>

### YAML
<a name="sam-resource-graphqlapi-syntax-yaml"></a>

```
LogicalId:
  Type: AWS::Serverless::GraphQLApi
  Properties:
    ApiKeys: ApiKeys
    Auth: Auth
    Cache: [AWS::AppSync::ApiCache](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html)
    DataSources: DataSource
    DomainName: [AWS::AppSync::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html)
    Functions: Function
    Logging: [LogConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-logconfig.html)
    Name: String
    Resolvers: Resolver
    SchemaInline: String
    SchemaUri: String
    Tags:
    - [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
    XrayEnabled: Boolean
```

## Eigenschaften
<a name="sam-resource-graphqlapi-properties"></a>

`ApiKeys`  <a name="sam-graphqlapi-apikeys"></a>
Erstellen Sie einen eindeutigen Schlüssel, der verwendet werden kann, um GraphQL Operationen auszuführen, für die ein API-Schlüssel erforderlich ist.  
*Typ:* [ApiKeys](sam-property-graphqlapi-apikeys.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

`Auth`  <a name="sam-graphqlapi-auth"></a>
Konfigurieren Sie die Authentifizierung für Ihre GraphQL API.  
*Typ*: [Auth](sam-property-graphqlapi-auth.md)  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

`Cache`  <a name="sam-graphqlapi-cache"></a>
Die Eingabe einer `CreateApiCache` Operation.  
*Typ:* [AWS::AppSync::ApiCache](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die [AWS::AppSync::ApiCache](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apicache.html)Ressource übergeben.

`DataSources`  <a name="sam-graphqlapi-datasources"></a>
Erstellen Sie Datenquellen für Funktionen, mit denen AWS AppSync Sie eine Verbindung herstellen möchten. AWS SAM unterstützt Amazon DynamoDB und AWS Lambda Datenquellen.  
*Typ:* [DataSource](sam-property-graphqlapi-datasource.md)  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

`DomainName`  <a name="sam-graphqlapi-domainname"></a>
Benutzerdefinierter Domainname für Ihre GraphQL API.  
*Typ:* [AWS::AppSync::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die [AWS::AppSync::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html)Ressource übergeben. AWS SAM generiert die [AWS::AppSync::DomainNameApiAssociation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainnameapiassociation.html)Ressource automatisch.

`Functions`  <a name="sam-graphqlapi-functions"></a>
Konfigurieren Sie Funktionen GraphQL APIs , um bestimmte Operationen auszuführen.  
*Typ*: [Funktion](sam-property-graphqlapi-function.md)  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

`Logging`  <a name="sam-graphqlapi-logging"></a>
Konfiguriert die CloudWatch Amazon-Protokollierung für Ihre GraphQL API.  
Wenn Sie diese Eigenschaft nicht angeben, AWS SAM werden die folgenden Werte generiert `CloudWatchLogsRoleArn` und festgelegt:  
+ `ExcludeVerboseContent: true`
+ `FieldLogLevel: ALL`
Um die Protokollierung zu deaktivieren, geben Sie Folgendes an:  

```
Logging: false
```
*Typ:* [LogConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-logconfig.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[LogConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-logconfig)` Eigenschaft einer `AWS::AppSync::GraphQLApi` Ressource übergeben.

`LogicalId`  <a name="sam-graphqlapi-logicalid"></a>
Der eindeutige Name Ihrer GraphQL API.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-name)` Eigenschaft einer `AWS::AppSync::GraphQLApi` Ressource übergeben.

`Name`  <a name="sam-graphqlapi-name"></a>
Der Name Ihrer GraphQL API. Geben Sie diese Eigenschaft an, um den `LogicalId` Wert zu überschreiben.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-name)` Eigenschaft einer `AWS::AppSync::GraphQLApi` Ressource übergeben.

`Resolvers`  <a name="sam-graphqlapi-resolvers"></a>
Konfigurieren Sie Resolver für die Felder Ihrer GraphQL API. AWS SAM unterstützt [JavaScriptPipeline-Resolver](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-reference-overview-js.html#anatomy-of-a-pipeline-resolver-js).  
*[Typ: Resolver](sam-property-graphqlapi-resolver.md)*  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig AWS SAM und hat kein CloudFormation Äquivalent.

`SchemaInline`  <a name="sam-graphqlapi-schemainline"></a>
Die Textdarstellung eines GraphQL Schemas im SDL Format.  
*Typ:* Zeichenfolge  
*Erforderlich:* Bedingt. Sie müssen `SchemaInline` oder angeben`SchemaUri`.  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Definition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-definition)` Eigenschaft einer `AWS::AppSync::GraphQLSchema` Ressource übergeben.

`SchemaUri`  <a name="sam-graphqlapi-schemauri"></a>
Die Amazon Simple Storage Service (Amazon S3) -Bucket-URI oder der Pfad zu einem lokalen Ordner des Schemas.  
Wenn Sie einen Pfad zu einem lokalen Ordner angeben, CloudFormation muss die Datei vor der Bereitstellung zuerst auf Amazon S3 hochgeladen werden. Sie können den verwenden AWS SAMCLI, um diesen Vorgang zu vereinfachen. Weitere Informationen finden Sie unter [So werden lokale Dateien bei der Bereitstellung AWS SAM hochgeladen](deploy-upload-local-files.md).  
*Typ:* Zeichenfolge  
*Erforderlich:* Bedingt. Sie müssen `SchemaInline` oder angeben`SchemaUri`.  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[DefinitionS3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlschema.html#cfn-appsync-graphqlschema-definitions3location)` Eigenschaft einer `AWS::AppSync::GraphQLSchema` Ressource übergeben.

`Tags`  <a name="sam-graphqlapi-tags"></a>
Tags (Schlüssel-Wert-Paare) für diese GraphQL API. Verwenden Sie Tags, um Ressourcen zu identifizieren und zu kategorisieren.  
*Typ:* Liste von [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-tags)` Eigenschaft einer `AWS::AppSync::GraphQLApi` Ressource übergeben.

`XrayEnabled`  <a name="sam-graphqlapi-xrayenabled"></a>
Geben Sie an, ob [AWS X-Ray Tracing](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html) für diese Ressource verwendet werden soll.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[XrayEnabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-xrayenabled)` Eigenschaft einer `AWS::AppSync::GraphQLApi` Ressource übergeben.

## Rückgabewerte
<a name="sam-resource-graphqlapi-return-values"></a>

Eine Liste der Rückgabewerte finden Sie [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#aws-resource-appsync-graphqlapi-return-values.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#aws-resource-appsync-graphqlapi-return-values.html)im [CloudFormation Benutzerhandbuch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

## Beispiele
<a name="sam-resource-graphqlapi-examples"></a>

### GraphQL APImit DynamoDB-Datenquelle
<a name="sam-resource-graphqlapi-examples-example1"></a>

In diesem Beispiel erstellen wir eine GraphQL API, die eine DynamoDB-Tabelle als Datenquelle verwendet.

**schema.graphql**

```
schema {
  query: Query
  mutation: Mutation
}

type Query {
  getPost(id: String!): Post
}

type Mutation {
  addPost(author: String!, title: String!, content: String!): Post!
}

type Post {
  id: String!
  author: String
  title: String
  content: String
  ups: Int!
  downs: Int!
  version: Int!
}
```

**Vorlage.yaml**

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  DynamoDBPostsTable:
    Type: AWS::Serverless::SimpleTable

  MyGraphQLAPI:
    Type: AWS::Serverless::GraphQLApi
    Properties:
      SchemaUri: ./sam_graphql_api/schema.graphql
      Auth:
        Type: AWS_IAM
      DataSources:
        DynamoDb:
          PostsDataSource:
            TableName: !Ref DynamoDBPostsTable
            TableArn: !GetAtt DynamoDBPostsTable.Arn
      Functions:
        preprocessPostItem:
          Runtime:
            Name: APPSYNC_JS
            Version: 1.0.0
          DataSource: NONE
          CodeUri: ./sam_graphql_api/preprocessPostItem.js
        createPostItem:
          Runtime:
            Name: APPSYNC_JS
            Version: "1.0.0"
          DataSource: PostsDataSource
          CodeUri: ./sam_graphql_api/createPostItem.js
        getPostFromTable:
          Runtime:
            Name: APPSYNC_JS
            Version: "1.0.0"
          DataSource: PostsDataSource
          CodeUri: ./sam_graphql_api/getPostFromTable.js
      Resolvers:
        Mutation:
          addPost:
            Runtime:
              Name: APPSYNC_JS
              Version: "1.0.0"
            Pipeline:
            - preprocessPostItem
            - createPostItem
        Query:
          getPost:
            CodeUri: ./sam_graphql_api/getPost.js
            Runtime:
              Name: APPSYNC_JS
              Version: "1.0.0"
            Pipeline:
            - getPostFromTable
```

**createPostItem.js**

```
import { util } from "@aws-appsync/utils";

export function request(ctx) {
  const { key, values } = ctx.prev.result;
  return {
    operation: "PutItem",
    key: util.dynamodb.toMapValues(key),
    attributeValues: util.dynamodb.toMapValues(values),
  };
}

export function response(ctx) {
  return ctx.result;
}
```

**getPostFromTable.js**

```
import { util } from "@aws-appsync/utils";

export function request(ctx) {
  return dynamoDBGetItemRequest({ id: ctx.args.id });
}

export function response(ctx) {
  return ctx.result;
}

/**
 * A helper function to get a DynamoDB item
 */
function dynamoDBGetItemRequest(key) {
  return {
    operation: "GetItem",
    key: util.dynamodb.toMapValues(key),
  };
}
```

**preprocessPostItem.js**

```
import { util } from "@aws-appsync/utils";

export function request(ctx) {
  const id = util.autoId();
  const { ...values } = ctx.args;
  values.ups = 1;
  values.downs = 0;
  values.version = 1;
  return { payload: { key: { id }, values: values } };
}

export function response(ctx) {
  return ctx.result;
}
```

Hier ist unser Resolver-Code:

**getPost.js**

```
export function request(ctx) {
  return {};
}

export function response(ctx) {
  return ctx.prev.result;
}
```

### GraphQLAPI mit einer Lambda-Funktion als Datenquelle
<a name="sam-resource-graphqlapi-examples-example2"></a>

In diesem Beispiel erstellen wir eine GraphQL API, die eine Lambda-Funktion als Datenquelle verwendet.

**template.yaml**

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyLambdaFunction:
    Type: AWS::Serverless::Function
    Properties:
      Handler: index.handler
      Runtime: nodejs20.x
      CodeUri: ./lambda

  MyGraphQLAPI:
    Type: AWS::Serverless::GraphQLApi
    Properties:
      Name: MyApi
      SchemaUri: ./gql/schema.gql
      Auth:
        Type: API_KEY
      ApiKeys:
        MyApiKey:
          Description: my api key
      DataSources:
        Lambda:
          MyLambdaDataSource:
            FunctionArn: !GetAtt MyLambdaFunction.Arn
      Functions:
        lambdaInvoker:
          Runtime:
            Name: APPSYNC_JS
            Version: 1.0.0
          DataSource: MyLambdaDataSource
          CodeUri: ./gql/invoker.js
      Resolvers:
        Mutation:
          addPost:
            Runtime:
              Name: APPSYNC_JS
              Version: 1.0.0
            Pipeline:
            - lambdaInvoker
        Query:
          getPost:
            Runtime:
              Name: APPSYNC_JS
              Version: 1.0.0
            Pipeline:
            - lambdaInvoker

Outputs:
  MyGraphQLAPI:
    Description: AppSync API
    Value: !GetAtt MyGraphQLAPI.GraphQLUrl
  MyGraphQLAPIMyApiKey:
    Description: API Key for authentication
    Value: !GetAtt MyGraphQLAPIMyApiKey.ApiKey
```

**schema.graphql**

```
schema {
  query: Query
  mutation: Mutation
}
type Query {
  getPost(id: ID!): Post
}
type Mutation {
  addPost(id: ID!, author: String!, title: String, content: String): Post!
}
type Post {
  id: ID!
  author: String!
  title: String
  content: String
  ups: Int
  downs: Int
}
```

Hier sind unsere Funktionen:

**lambda/index.js**

```
exports.handler = async (event) => {
  console.log("Received event {}", JSON.stringify(event, 3));

  const posts = {
    1: {
      id: "1",
      title: "First book",
      author: "Author1",
      content: "Book 1 has this content",
      ups: "100",
      downs: "10",
    },
  };

  console.log("Got an Invoke Request.");
  let result;
  switch (event.field) {
    case "getPost":
      return posts[event.arguments.id];
    case "addPost":
      // return the arguments back
      return event.arguments;
    default:
      throw new Error("Unknown field, unable to resolve " + event.field);
  }
};
```

**invoker.js**

```
import { util } from "@aws-appsync/utils";

export function request(ctx) {
  const { source, args } = ctx;
  return {
    operation: "Invoke",
    payload: { field: ctx.info.fieldName, arguments: args, source },
  };
}

export function response(ctx) {
  return ctx.result;
}
```

# ApiKeys
<a name="sam-property-graphqlapi-apikeys"></a>

Erstellen Sie einen eindeutigen Schlüssel, mit dem GraphQL Operationen ausgeführt werden können, für die ein API-Schlüssel erforderlich ist.

## Syntax
<a name="sam-property-graphqlapi-apikeys-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-graphqlapi-apikeys-syntax-yaml"></a>

```
LogicalId:
  ApiKeyId: String
  Description: String
  ExpiresOn: Double
```

## Eigenschaften
<a name="sam-property-graphqlapi-apikeys-properties"></a>

`ApiKeyId`  <a name="sam-graphqlapi-apikeys-apikeyid"></a>
Der eindeutige Name Ihres API-Schlüssels. Geben Sie an, dass der `LogicalId` Wert überschrieben werden soll.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ApiKeyId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-apikeyid)` Eigenschaft einer `AWS::AppSync::ApiKey` Ressource übergeben.

`Description`  <a name="sam-graphqlapi-apikeys-description"></a>
Beschreibung Ihres API-Schlüssels.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-description)` Eigenschaft einer `AWS::AppSync::ApiKey` Ressource übergeben.

`ExpiresOn`  <a name="sam-graphqlapi-apikeys-expireson"></a>
Die Zeit, nach der der API-Schlüssel abläuft. Das Datum wird als Sekunden seit der Epoche dargestellt, abgerundet auf die nächste Stunde.  
*Type*: Double  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Expires](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-expires)` Eigenschaft einer `AWS::AppSync::ApiKey` Ressource übergeben.

`LogicalId`  <a name="sam-graphqlapi-apikeys-logicalid"></a>
Der eindeutige Name Ihres API-Schlüssels.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ApiKeyId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-apikeyid)` Eigenschaft einer `AWS::AppSync::ApiKey` Ressource übergeben.

# Auth
<a name="sam-property-graphqlapi-auth"></a>

Konfigurieren Sie die Autorisierung für Ihre GraphQL API.

## Syntax
<a name="sam-property-graphqlapi-auth-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-graphqlapi-auth-syntax-yaml"></a>

```
Additional:
- AuthProvider
LambdaAuthorizer: [LambdaAuthorizerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-lambdaauthorizerconfig.html)
OpenIDConnect: [OpenIDConnectConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html)
Type: String
UserPool: [UserPoolConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html)
```

## Eigenschaften
<a name="sam-property-graphqlapi-auth-properties"></a>

`Additional`  <a name="sam-graphqlapi-auth-additional"></a>
Eine Liste zusätzlicher Autorisierungstypen für Ihre GraphQL API.  
*Typ*: Liste von [AuthProvider](sam-property-graphqlapi-auth-authprovider.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

`LambdaAuthorizer`  <a name="sam-graphqlapi-auth-lambdaauthorizer"></a>
Geben Sie die optionale Autorisierungskonfiguration für Ihren Lambda-Funktionsautorisierer an. Sie können diese optionale Eigenschaft konfigurieren, wenn sie als angegeben `Type` ist. `AWS_LAMBDA`  
*Typ*: [LambdaAuthorizerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-lambdaauthorizerconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ LambdaAuthorizerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-lambdaauthorizerconfig.html)` Eigenschaft einer `AWS::AppSync::GraphQLApi` Ressource übergeben.

`OpenIDConnect`  <a name="sam-graphqlapi-auth-openidconnect"></a>
Geben Sie die optionale Autorisierungskonfiguration für Ihren OpenID Connect konformen Dienst an. Sie können diese optionale Eigenschaft konfigurieren, wenn sie als angegeben `Type` ist`OPENID_CONNECT`.  
*Typ*: [Open IDConnect Config](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-openidconnectconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ OpenIDConnectConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html)` Eigenschaft einer `AWS::AppSync::GraphQLApi` Ressource übergeben.

`Type`  <a name="sam-graphqlapi-auth-type"></a>
Der Standardautorisierungstyp zwischen Anwendungen und Ihrer AWS AppSync GraphQL API.  
Eine Liste und Beschreibung der zulässigen Werte finden Sie unter [Autorisierung und Authentifizierung](https://docs.aws.amazon.com/appsync/latest/devguide/security-authz.html) im *AWS AppSync Entwicklerhandbuch*.  
Wenn Sie einen Lambda-Autorisierer (`AWS_LAMBDA`) angeben, AWS SAM wird eine AWS Identity and Access Management (IAM-) Richtlinie erstellt, um Berechtigungen zwischen Ihrer GraphQL API und der Lambda-Funktion bereitzustellen.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[AuthenticationType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-authenticationtype)` Eigenschaft einer Ressource übergeben. `AWS::AppSync::GraphQLApi`

`UserPool`  <a name="sam-graphqlapi-auth-userpool"></a>
Geben Sie die optionale Autorisierungskonfiguration für die Verwendung von Amazon Cognito Cognito-Benutzerpools an. Sie können diese optionale Eigenschaft konfigurieren, wenn sie als `AMAZON_COGNITO_USER_POOLS` angegeben `Type` ist.  
*Typ*: [UserPoolConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-userpoolconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ UserPoolConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html)` Eigenschaft einer `AWS::AppSync::GraphQLApi` Ressource übergeben.

## Beispiele
<a name="sam-property-graphqlapi-auth-examples"></a>

### Konfigurieren Sie einen Standard- und einen zusätzlichen Autorisierungstyp
<a name="sam-property-graphqlapi-auth-examples-example1"></a>

In diesem Beispiel konfigurieren wir zunächst einen Lambda-Autorisierungstyp als Standardautorisierungstyp für unsere GraphQL API.

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyGraphQLAPI:
    Type: AWS::Serverless::GraphQLApi
    Properties:
      Auth:
        Type: AWS_LAMBDA
        LambdaAuthorizer:
          AuthorizerUri: !GetAtt Authorizer1.Arn
          AuthorizerResultTtlInSeconds: 10
          IdentityValidationExpression: hello
```

Als Nächstes konfigurieren wir zusätzliche Autorisierungstypen für unsere GraphQL API, indem wir unserer AWS SAM Vorlage Folgendes hinzufügen:

```
        Additional:
        - Type: AWS_IAM
        - Type: API_KEY
        - Type: OPENID_CONNECT
          OpenIDConnect:
            AuthTTL: 10
            ClientId: myId
            IatTTL: 10
            Issuer: prod
```

Dies führt zu der folgenden AWS SAM Vorlage:

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyGraphQLAPI:
    Type: AWS::Serverless::GraphQLApi
    Properties:
      Auth:
        Type: AWS_LAMBDA
        LambdaAuthorizer:
          AuthorizerUri: !GetAtt Authorizer1.Arn
          AuthorizerResultTtlInSeconds: 10
          IdentityValidationExpression: hello
        Additional:
        - Type: AWS_IAM
        - Type: API_KEY
        - Type: OPENID_CONNECT
          OpenIDConnect:
            AuthTTL: 10
            ClientId: myId
            IatTTL: 10
            Issuer: prod
```

# AuthProvider
<a name="sam-property-graphqlapi-auth-authprovider"></a>

Optionale Autorisierungskonfiguration für Ihre zusätzlichen GraphQL API-Autorisierungstypen.

## Syntax
<a name="sam-property-graphqlapi-auth-authprovider-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-graphqlapi-auth-authprovider-syntax-yaml"></a>

```
LambdaAuthorizer: [LambdaAuthorizerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-lambdaauthorizerconfig.html)
OpenIDConnect: [OpenIDConnectConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html)
Type: String
UserPool: [UserPoolConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html)
```

## Eigenschaften
<a name="sam-property-graphqlapi-auth-authprovider-properties"></a>

`LambdaAuthorizer`  <a name="sam-graphqlapi-auth-authprovider-lambdaauthorizer"></a>
Geben Sie die optionale Autorisierungskonfiguration für Ihren AWS Lambda Funktionsautorisierer an. Sie können diese optionale Eigenschaft konfigurieren, wenn sie als `AWS_LAMBDA` angegeben `Type` ist.  
*Typ*: [ LambdaAuthorizerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-lambdaauthorizerconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ LambdaAuthorizerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-lambdaauthorizerconfig.html)` Eigenschaft eines `AWS::AppSync::GraphQLApi` `[ AdditionalAuthenticationProvider](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-additionalauthenticationprovider.html)` Objekts übergeben.

`OpenIDConnect`  <a name="sam-graphqlapi-auth-authprovider-openidconnect"></a>
Geben Sie die optionale Autorisierungskonfiguration für Ihren OpenID Connect konformen Dienst an. Sie können diese optionale Eigenschaft konfigurieren, wenn sie als angegeben `Type` ist`OPENID_CONNECT`.  
*Typ*: [Open IDConnect Config](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-openidconnectconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ OpenIDConnectConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-openidconnectconfig.html)` Eigenschaft eines `AWS::AppSync::GraphQLApi` `[ AdditionalAuthenticationProvider](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-additionalauthenticationprovider.html)` Objekts übergeben.

`Type`  <a name="sam-graphqlapi-auth-authprovider-type"></a>
Der Standardautorisierungstyp zwischen Anwendungen und Ihrer AWS AppSync GraphQL API.  
Eine Liste und Beschreibung der zulässigen Werte finden Sie unter [Autorisierung und Authentifizierung](https://docs.aws.amazon.com/appsync/latest/devguide/security-authz.html) im *AWS AppSync Entwicklerhandbuch*.  
Wenn Sie einen Lambda-Autorisierer (`AWS_LAMBDA`) angeben, AWS SAM wird eine AWS Identity and Access Management (IAM-) Richtlinie erstellt, um Berechtigungen zwischen Ihrer GraphQL API und der Lambda-Funktion bereitzustellen.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ AuthenticationType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-additionalauthenticationprovider.html#cfn-appsync-graphqlapi-additionalauthenticationprovider-authenticationtype)` Eigenschaft eines Objekts übergeben. `AWS::AppSync::GraphQLApi` `[ AdditionalAuthenticationProvider](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-additionalauthenticationprovider.html)`

`UserPool`  <a name="sam-graphqlapi-auth-authprovider-userpool"></a>
Geben Sie die optionale Autorisierungskonfiguration für die Verwendung von Amazon Cognito Cognito-Benutzerpools an. Sie können diese optionale Eigenschaft konfigurieren, wenn sie als `AMAZON_COGNITO_USER_POOLS` angegeben `Type` ist.  
*Typ*: [ UserPoolConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-userpoolconfig)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ UserPoolConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-userpoolconfig.html)` Eigenschaft eines `AWS::AppSync::GraphQLApi` `[ AdditionalAuthenticationProvider](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-additionalauthenticationprovider.html)` Objekts übergeben.

# DataSource
<a name="sam-property-graphqlapi-datasource"></a>

Konfigurieren Sie eine Datenquelle, mit der Ihr GraphQL API-Resolver eine Verbindung herstellen kann. Sie können Vorlagen AWS Serverless Application Model (AWS SAM) verwenden, um Verbindungen zu den folgenden Datenquellen zu konfigurieren:
+ Amazon DynamoDB
+ AWS Lambda

Weitere Informationen zu Datenquellen finden Sie unter [Anhängen einer Datenquelle](https://docs.aws.amazon.com/appsync/latest/devguide/attaching-a-data-source.html) im *AWS AppSync Entwicklerhandbuch*.

## Syntax
<a name="sam-property-graphqlapi-datasource-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-graphqlapi-datasource-syntax-yaml"></a>

```
DynamoDb: DynamoDb
Lambda: Lambda
```

## Eigenschaften
<a name="sam-property-graphqlapi-datasource-properties"></a>

`DynamoDb`  <a name="sam-graphqlapi-datasource-dynamodb"></a>
Konfigurieren Sie eine DynamoDB-Tabelle als Datenquelle für Ihren GraphQL API-Resolver.  
*Typ:* [DynamoDb](sam-property-graphqlapi-datasource-dynamodb.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. CloudFormation 

`Lambda`  <a name="sam-graphqlapi-datasource-lambda"></a>
Konfigurieren Sie eine Lambda-Funktion als Datenquelle für Ihren GraphQL API-Resolver.  
*Type*: [Lambda](sam-property-graphqlapi-datasource-lambda.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

# DynamoDb
<a name="sam-property-graphqlapi-datasource-dynamodb"></a>

Konfigurieren Sie eine Amazon DynamoDB-Tabelle als Datenquelle für Ihren GraphQL API-Resolver.

## Syntax
<a name="sam-property-graphqlapi-datasource-dynamodb-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-graphqlapi-datasource-dynamodb-syntax-yaml"></a>

```
LogicalId:
  DeltaSync: [DeltaSyncConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-deltasyncconfig.html)
  Description: String
  Name: String
  Permissions: List
  Region: String
  ServiceRoleArn: String
  TableArn: String
  TableName: String
  UseCallerCredentials: Boolean
  Versioned: Boolean
```

## Eigenschaften
<a name="sam-property-graphqlapi-datasource-dynamodb-properties"></a>

`DeltaSync`  <a name="sam-graphqlapi-datasource-dynamodb-deltasync"></a>
Beschreibt eine Delta Sync-Konfiguration.  
*Typ:* [DeltaSyncConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-deltasyncconfig.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[DeltaSyncConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-deltasyncconfig)` Eigenschaft eines `AWS::AppSync::DataSource DynamoDBConfig` Objekts übergeben.

`Description`  <a name="sam-graphqlapi-datasource-dynamodb-description"></a>
Die Beschreibung Ihrer Datenquelle.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-description)` Eigenschaft einer `AWS::AppSync::DataSource` Ressource übergeben.

`LogicalId`  <a name="sam-graphqlapi-datasource-dynamodb-logicalid"></a>
Der eindeutige Name Ihrer Datenquelle.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-name)` Eigenschaft einer `AWS::AppSync::DataSource` Ressource übergeben.

`Name`  <a name="sam-graphqlapi-datasource-dynamodb-name"></a>
Der Name Ihrer Datenquelle. Geben Sie diese Eigenschaft an, um den `LogicalId` Wert zu überschreiben.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-name)` Eigenschaft einer `AWS::AppSync::DataSource` Ressource übergeben.

`Permissions`  <a name="sam-graphqlapi-datasource-dynamodb-permissions"></a>
Erteilen Sie Berechtigungen für Ihre Datenquelle mithilfe von[AWS SAM Konnektoren](managing-permissions-connectors.md). Sie können jeden der folgenden Werte in einer Liste angeben:  
+ `Read`— Erlauben Sie Ihrem Resolver, Ihre Datenquelle zu lesen.
+ `Write`— Erlauben Sie Ihrem Resolver, in Ihre Datenquelle zu schreiben.
AWS SAM verwendet eine `AWS::Serverless::Connector` Ressource, die bei der Bereitstellung transformiert wird, um Ihre Berechtigungen bereitzustellen. Weitere Informationen zu generierten Ressourcen finden Sie unter[CloudFormation Ressourcen, die generiert werden, wenn Sie angeben AWS::Serverless::Connector](sam-specification-generated-resources-connector.md).  
Sie können `Permissions` oder `ServiceRoleArn` angeben, aber nicht beides. Wenn keines der beiden angegeben ist, AWS SAM werden Standardwerte von `Read` und generiert`Write`. Um den Zugriff auf Ihre Datenquelle zu widerrufen, entfernen Sie das DynamoDB-Objekt aus Ihrer AWS SAM Vorlage.
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent. Sie ähnelt der `Permissions` Eigenschaft einer `AWS::Serverless::Connector` Ressource.

`Region`  <a name="sam-graphqlapi-datasource-dynamodb-region"></a>
Die AWS-Region Ihrer DynamoDB-Tabelle. Wenn Sie es nicht angeben, AWS SAM verwendet. `[AWS::Region](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-region)`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[AwsRegion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-awsregion)` Eigenschaft eines `AWS::AppSync::DataSource DynamoDBConfig` Objekts übergeben.

`ServiceRoleArn`  <a name="sam-graphqlapi-datasource-dynamodb-servicerolearn"></a>
Die AWS Identity and Access Management (IAM-) Dienstrolle ARN für die Datenquelle. Das System übernimmt diese Rolle beim Zugriff auf die Datenquelle.  
Sie können `Permissions` oder `ServiceRoleArn` angeben, aber nicht beides.  
*Typ:* Zeichenfolge  
*Erforderlich*: Nein. Wenn nicht angegeben, wird der Standardwert für AWS SAM angewendet`Permissions`.  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ServiceRoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-servicerolearn)` Eigenschaft einer `AWS::AppSync::DataSource` Ressource übergeben.

`TableArn`  <a name="sam-graphqlapi-datasource-dynamodb-tablearn"></a>
Der ARN für die DynamoDB-Tabelle.  
*Typ:* Zeichenfolge  
*Erforderlich:* Bedingt. Wenn Sie es nicht angeben`ServiceRoleArn`, `TableArn` ist es erforderlich.  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

`TableName`  <a name="sam-graphqlapi-datasource-dynamodb-tablename"></a>
Der Name der Tabelle.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[TableName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-tablename)` Eigenschaft eines `AWS::AppSync::DataSource DynamoDBConfig` Objekts übergeben.

`UseCallerCredentials`  <a name="sam-graphqlapi-datasource-dynamodb-usecallercredentials"></a>
Legt fest`true`, dass IAM mit dieser Datenquelle verwendet wird.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[UseCallerCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-usecallercredentials)` Eigenschaft eines `AWS::AppSync::DataSource DynamoDBConfig` Objekts übergeben.

`Versioned`  <a name="sam-graphqlapi-datasource-dynamodb-versioned"></a>
Auf [Konflikterkennung, Konfliktlösung und Synchronisation](https://docs.aws.amazon.com/appsync/latest/devguide/conflict-detection-and-sync.html) mit dieser Datenquelle eingestellt. `true`  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Versioned](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-dynamodbconfig.html#cfn-appsync-datasource-dynamodbconfig-versioned)` Eigenschaft eines `AWS::AppSync::DataSource DynamoDBConfig` Objekts übergeben.

# Lambda
<a name="sam-property-graphqlapi-datasource-lambda"></a>

Konfigurieren Sie eine AWS Lambda Funktion als Datenquelle für Ihren GraphQL API-Resolver.

## Syntax
<a name="sam-property-graphqlapi-datasource-lambda-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-graphqlapi-datasource-lambda-syntax-yaml"></a>

```
LogicalId:
  Description: String
  FunctionArn: String
  Name: String
  ServiceRoleArn: String
```

## Eigenschaften
<a name="sam-property-graphqlapi-datasource-lambda-properties"></a>

`Description`  <a name="sam-graphqlapi-datasource-lambda-description"></a>
Die Beschreibung Ihrer Datenquelle.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-description)` Eigenschaft einer `AWS::AppSync::DataSource` Ressource übergeben.

`FunctionArn`  <a name="sam-graphqlapi-datasource-lambda-functionarn"></a>
Der ARN für die Lambda-Funktion  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[LambdaFunctionArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-datasource-lambdaconfig.html#cfn-appsync-datasource-lambdaconfig-lambdafunctionarn)` Eigenschaft eines `AWS::AppSync::DataSource LambdaConfig` Objekts übergeben.

`LogicalId`  <a name="sam-graphqlapi-datasource-lambda-logicalid"></a>
Der eindeutige Name Ihrer Datenquelle.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-name)` Eigenschaft einer `AWS::AppSync::DataSource` Ressource übergeben.

`Name`  <a name="sam-graphqlapi-datasource-lambda-name"></a>
Der Name Ihrer Datenquelle. Geben Sie diese Eigenschaft an, um den `LogicalId` Wert zu überschreiben.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-name)` Eigenschaft einer `AWS::AppSync::DataSource` Ressource übergeben.

`ServiceRoleArn`  <a name="sam-graphqlapi-datasource-lambda-servicerolearn"></a>
Die AWS Identity and Access Management (IAM-) Dienstrolle ARN für die Datenquelle. Das System übernimmt diese Rolle beim Zugriff auf die Datenquelle.  
Um den Zugriff auf Ihre Datenquelle zu widerrufen, entfernen Sie das Lambda-Objekt aus Ihrer AWS SAM Vorlage.
*Typ:* Zeichenfolge  
*Erforderlich*: Nein. Wenn nicht angegeben, AWS SAM werden `Write` Berechtigungen mithilfe von bereitgestellt[AWS SAM Konnektoren](managing-permissions-connectors.md).  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ServiceRoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-servicerolearn)` Eigenschaft einer `AWS::AppSync::DataSource` Ressource übergeben.

# Funktion
<a name="sam-property-graphqlapi-function"></a>

Konfigurieren Sie Funktionen GraphQL APIs , um bestimmte Operationen auszuführen.

## Syntax
<a name="sam-property-graphqlapi-function-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-graphqlapi-function-syntax-yaml"></a>

```
LogicalId:
  CodeUri: String
  DataSource: String
  Description: String
  Id: String
  InlineCode: String
  MaxBatchSize: Integer
  Name: String
  Runtime: Runtime
  Sync: [SyncConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-functionconfiguration-syncconfig.html)
```

## Eigenschaften
<a name="sam-property-graphqlapi-function-properties"></a>

`CodeUri`  <a name="sam-graphqlapi-function-codeuri"></a>
Die Amazon Simple Storage Service (Amazon S3) -URI oder der Pfad zum lokalen Ordner des Funktionscodes.  
Wenn Sie einen Pfad zu einem lokalen Ordner angeben, CloudFormation muss die Datei vor der Bereitstellung zuerst auf Amazon S3 hochgeladen werden. Sie können den verwenden AWS SAMCLI, um diesen Vorgang zu vereinfachen. Weitere Informationen finden Sie unter [So werden lokale Dateien bei der Bereitstellung AWS SAM hochgeladen](deploy-upload-local-files.md).  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[CodeS3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-codes3location)` Eigenschaft einer `AWS::AppSync::FunctionConfiguration` Ressource übergeben.

`DataSource`  <a name="sam-graphqlapi-function-datasource"></a>
Der Name der Datenquelle, an die diese Funktion angehängt wird.  
+ Um auf eine Datenquelle innerhalb der `AWS::Serverless::GraphQLApi` Ressource zu verweisen, geben Sie deren logische ID an.
+ Um auf eine Datenquelle außerhalb der `AWS::Serverless::GraphQLApi` Ressource zu verweisen, geben Sie ihr `Name` Attribut mithilfe der `Fn::GetAtt` systeminternen Funktion an. Beispiel, `!GetAtt MyLambdaDataSource.Name`.
+ Um auf eine Datenquelle aus einem anderen Stapel zu verweisen, verwenden Sie. `[Fn::ImportValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html)`
Wenn eine Variante von angegeben `[NONE | None | none]` ist, AWS SAM wird ein `None` Wert für das `AWS::AppSync::DataSource` `[Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-type)` Objekt generiert.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[DataSourceName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-datasourcename)` Eigenschaft einer `AWS::AppSync::FunctionConfiguration` Ressource übergeben.

`Description`  <a name="sam-graphqlapi-function-description"></a>
Die Beschreibung Ihrer Funktion.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-description)` Eigenschaft einer `AWS::AppSync::FunctionConfiguration` Ressource übergeben.

`Id`  <a name="sam-graphqlapi-function-id"></a>
Die Funktions-ID für eine Funktion, die sich außerhalb der `AWS::Serverless::GraphQLApi` Ressource befindet.  
+ Um auf eine Funktion innerhalb derselben AWS SAM Vorlage zu verweisen, verwenden Sie die `Fn::GetAtt` systeminterne Funktion. Zum Beispiel `Id: !GetAtt createPostItemFunc.FunctionId`.
+ Um auf eine Funktion aus einem anderen Stack zu verweisen, verwenden Sie. `[Fn::ImportValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html)`
Bei der Verwendung `Id` sind alle anderen Eigenschaften nicht zulässig. AWS SAM übergibt automatisch die Funktions-ID Ihrer referenzierten Funktion.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

`InlineCode`  <a name="sam-graphqlapi-function-inlinecode"></a>
Der Funktionscode, der die Anforderungs- und Antwortfunktionen enthält.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Code](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-code)` Eigenschaft einer `AWS::AppSync::FunctionConfiguration` Ressource übergeben.

`LogicalId`  <a name="sam-graphqlapi-function-logicalid"></a>
Der eindeutige Name Ihrer Funktion.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-name)` Eigenschaft einer `AWS::AppSync::FunctionConfiguration` Ressource übergeben.

`MaxBatchSize`  <a name="sam-graphqlapi-function-maxbatchsize"></a>
Die maximale Anzahl der Resolver-Anforderungs-Eingaben, die an eine einzelne AWS Lambda -Funktion in einem `BatchInvoke`-Vorgang gesendet werden.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die [MaxBatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-maxbatchsize)Eigenschaft einer `AWS::AppSync::FunctionConfiguration` Ressource übergeben.

`Name`  <a name="sam-graphqlapi-function-name"></a>
Der Name der Funktion. Geben Sie an, dass der `LogicalId` Wert überschrieben werden soll.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-name)` Eigenschaft einer `AWS::AppSync::FunctionConfiguration` Ressource übergeben.

`Runtime`  <a name="sam-graphqlapi-function-runtime"></a>
Beschreibt eine Laufzeit, die von einem AWS AppSync Pipeline-Resolver oder einer AWS AppSync Pipeline-Funktion verwendet wird. Gibt den Namen und die Version der zu verwendenden Laufzeit an.  
*[Typ: Runtime](sam-property-graphqlapi-function-runtime.md)*  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent. Sie ähnelt der `[Runtime](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-runtime)` Eigenschaft einer `AWS::AppSync::FunctionConfiguration` Ressource.

`Sync`  <a name="sam-graphqlapi-function-sync"></a>
Beschreibt eine Sync-Konfiguration für eine Funktion.  
Gibt an, welche Konflikterkennungs- und Lösungsstrategie verwendet werden soll, wenn die Funktion aufgerufen wird.  
*Typ:* [SyncConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-functionconfiguration-syncconfig.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[SyncConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-syncconfig)` Eigenschaft einer `AWS::AppSync::FunctionConfiguration` Ressource übergeben.

# Laufzeit
<a name="sam-property-graphqlapi-function-runtime"></a>

Die Laufzeit Ihres Pipeline-Resolvers oder Ihrer Pipeline-Funktion. Gibt den Namen und die Version an, die verwendet werden sollen.

## Syntax
<a name="sam-property-graphqlapi-function-runtime-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-graphqlapi-function-runtime-syntax-yaml"></a>

```
Name: String
Version: String
```

## Eigenschaften
<a name="sam-property-graphqlapi-function-runtime-properties"></a>

`Name`  <a name="sam-graphqlapi-function-runtime-name"></a>
Der Name der zu verwendenden Laufzeit. Der einzige zulässige Wert ist derzeit `APPSYNC_JS`.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-functionconfiguration-appsyncruntime.html#cfn-appsync-functionconfiguration-appsyncruntime-name)` Eigenschaft eines `AWS::AppSync::FunctionConfiguration AppSyncRuntime` Objekts übergeben.

`Version`  <a name="sam-graphqlapi-function-runtime-version"></a>
Die Version der zu verwendenden Runtime. Die einzige zulässige Version ist derzeit `1.0.0`.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[RuntimeVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-functionconfiguration-appsyncruntime.html#cfn-appsync-functionconfiguration-appsyncruntime-runtimeversion)` Eigenschaft eines `AWS::AppSync::FunctionConfiguration AppSyncRuntime` Objekts übergeben.

# Resolver
<a name="sam-property-graphqlapi-resolver"></a>

Konfigurieren Sie Resolver für die Felder Ihrer GraphQL API. AWS Serverless Application Model (AWS SAM) unterstützt [JavaScript Pipeline-Resolver](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-reference-overview-js.html).

## Syntax
<a name="sam-property-graphqlapi-resolver-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-graphqlapi-resolver-syntax-yaml"></a>

```
OperationType:
  LogicalId:
    Caching: [CachingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-cachingconfig.html)
    CodeUri: String
    FieldName: String
    InlineCode: String 
    MaxBatchSize: Integer
    Pipeline: List
    Runtime: Runtime
    Sync: [SyncConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-syncconfig.html)
```

## Eigenschaften
<a name="sam-property-graphqlapi-resolver-properties"></a>

`Caching`  <a name="sam-graphqlapi-resolver-caching"></a>
Die Caching-Konfiguration für den Resolver, für den das Caching aktiviert ist.  
*Typ:* [CachingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-cachingconfig.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[CachingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-cachingconfig)` Eigenschaft einer Ressource übergeben. `AWS::AppSync::Resolver`

`CodeUri`  <a name="sam-graphqlapi-resolver-codeuri"></a>
Die Amazon Simple Storage Service (Amazon S3) -URI oder der Pfad zu einem lokalen Ordner des Resolver-Funktionscodes.  
Wenn Sie einen Pfad zu einem lokalen Ordner angeben, CloudFormation muss die Datei vor der Bereitstellung zuerst auf Amazon S3 hochgeladen werden. Sie können den verwenden AWS SAMCLI, um diesen Vorgang zu vereinfachen. Weitere Informationen finden Sie unter [So werden lokale Dateien bei der Bereitstellung AWS SAM hochgeladen](deploy-upload-local-files.md).  
Falls keines `CodeUri` von beiden angegeben AWS SAM wird, wird generiert, `InlineCode` dass die Anfrage an die erste Pipeline-Funktion weitergeleitet wird und die Antwort von der letzten Pipeline-Funktion empfangen wird. `InlineCode`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[CodeS3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-codes3location)` Eigenschaft einer `AWS::AppSync::Resolver` Ressource übergeben.

`FieldName`  <a name="sam-graphqlapi-resolver-fieldname"></a>
Der Name Ihres Resolvers. Geben Sie diese Eigenschaft an, um den `LogicalId` Wert zu überschreiben.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FieldName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-fieldname)` Eigenschaft einer `AWS::AppSync::Resolver` Ressource übergeben.

`InlineCode`  <a name="sam-graphqlapi-resolver-inlinecode"></a>
Der Resolver-Code, der die Anforderungs- und Antwortfunktionen enthält.  
Wenn keiner `CodeUri` von beiden angegeben AWS SAM wird, wird generiert, `InlineCode` dass die Anfrage an die erste Pipeline-Funktion umgeleitet wird und die Antwort von der letzten Pipeline-Funktion empfangen wird. `InlineCode`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Code](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-code)` Eigenschaft einer `AWS::AppSync::Resolver` Ressource übergeben.

`LogicalId`  <a name="sam-graphqlapi-resolver-logicalid"></a>
Der eindeutige Name für Ihren Resolver. In einem GraphQL Schema sollte Ihr Resolvername mit dem Feldnamen übereinstimmen, für den er verwendet wird. Verwenden Sie denselben Feldnamen für`LogicalId`.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

`MaxBatchSize`  <a name="sam-graphqlapi-resolver-maxbatchsize"></a>
Die maximale Anzahl der Resolver-Anforderungs-Eingaben, die an eine einzelne AWS Lambda -Funktion in einem `BatchInvoke`-Vorgang gesendet werden.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MaxBatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-maxbatchsize)` Eigenschaft einer `AWS::AppSync::Resolver` Ressource übergeben.

`OperationType`  <a name="sam-graphqlapi-resolver-operationtype"></a>
Der GraphQL Vorgangstyp, der Ihrem Resolver zugeordnet ist. Beispiel: `Query`, `Mutation` oder `Subscription`. Sie können mehrere Resolver in einem `LogicalId` einzigen ineinander verschachteln. `OperationType`  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[TypeName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-typename)` Eigenschaft einer `AWS::AppSync::Resolver` Ressource übergeben.

`Pipeline`  <a name="sam-graphqlapi-resolver-pipeline"></a>
Funktionen im Zusammenhang mit dem Pipeline-Resolver. Geben Sie Funktionen anhand der logischen ID in einer Liste an.  
*Typ*: Liste  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent. Sie ähnelt der `[PipelineConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-pipelineconfig)` Eigenschaft einer `AWS::AppSync::Resolver` Ressource.

`Runtime`  <a name="sam-graphqlapi-resolver-runtime"></a>
Die Laufzeit Ihres Pipeline-Resolvers oder Ihrer Pipeline-Funktion. Gibt den Namen und die Version an, die verwendet werden sollen.  
*Typ*: [Runtime](sam-property-graphqlapi-resolver-runtime.md)  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent. Sie ähnelt der `[Runtime](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-runtime)` Eigenschaft einer `AWS::AppSync::Resolver` Ressource.

`Sync`  <a name="sam-graphqlapi-resolver-sync"></a>
Beschreibt eine Sync-Konfiguration für einen Resolver.  
Gibt an, welche Konflikterkennungs- und Lösungsstrategie verwendet werden soll, wenn der Resolver aufgerufen wird.  
*Typ:* [SyncConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-syncconfig.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[SyncConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-syncconfig)` Eigenschaft einer `AWS::AppSync::Resolver` Ressource übergeben.

## Beispiele
<a name="sam-property-graphqlapi-resolver-examples"></a>

### Verwenden Sie den AWS SAM generierten Resolver-Funktionscode und speichern Sie Felder als Variablen
<a name="sam-property-graphqlapi-resolver-examples-example1"></a>

Hier ist das GraphQL Schema für unser Beispiel:

```
schema {
  query: Query
  mutation: Mutation
}

type Query {
  getPost(id: ID!): Post
}

type Mutation {
  addPost(author: String!, title: String!, content: String!): Post!
}

type Post {
  id: ID!
  author: String
  title: String
  content: String
}
```

Hier ist ein Ausschnitt aus unserer AWS SAM Vorlage:

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyGraphQLApi:
    Type: AWS::Serverless::GraphQLApi
    Properties:
      ...
      Functions:
        preprocessPostItem:
          ...
        createPostItem:
          ...
      Resolvers:
        Mutation:
          addPost:
            Runtime:
              Name: APPSYNC_JS
              Version: 1.0.0
            Pipeline:
            - preprocessPostItem
            - createPostItem
```

In unserer AWS SAM Vorlage geben wir oder nicht an`CodeUri`. `InlineCode` Generiert bei der Bereitstellung AWS SAM automatisch den folgenden Inline-Code für unseren Resolver:

```
export function request(ctx) {
  return {};
}

export function response(ctx) {
  return ctx.prev.result;
}
```

Dieser Standard-Resolver-Code leitet die Anfrage an die erste Pipeline-Funktion weiter und empfängt die Antwort von der letzten Pipeline-Funktion.

In unserer ersten Pipeline-Funktion können wir das bereitgestellte `args` Feld verwenden, um das Anforderungsobjekt zu analysieren und unsere Variablen zu erstellen. Wir können diese Variablen dann in unserer Funktion verwenden. Hier ist ein Beispiel für unsere `preprocessPostItem` Funktion:

```
import { util } from "@aws-appsync/utils";

export function request(ctx) {
  const author = ctx.args.author;
  const title = ctx.args.title;
  const content = ctx.args.content;
  
  // Use variables to process data
  
}

export function response(ctx) {
  return ctx.result;
}
```

# Laufzeit
<a name="sam-property-graphqlapi-resolver-runtime"></a>

Die Laufzeit Ihres Pipeline-Resolvers oder Ihrer Pipeline-Funktion. Gibt den Namen und die Version an, die verwendet werden sollen.

## Syntax
<a name="sam-property-graphqlapi-resolver-runtime-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-graphqlapi-resolver-runtime-syntax-yaml"></a>

```
Name: String
Version: String
```

## Eigenschaften
<a name="sam-property-graphqlapi-resolver-runtime-properties"></a>

`Name`  <a name="sam-graphqlapi-resolver-runtime-name"></a>
Der Name der zu verwendenden Laufzeit. Der einzige zulässige Wert ist derzeit `APPSYNC_JS`.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-appsyncruntime.html#cfn-appsync-resolver-appsyncruntime-name)` Eigenschaft eines `AWS::AppSync::Resolver AppSyncRuntime` Objekts übergeben.

`Version`  <a name="sam-graphqlapi-resolver-runtime-version"></a>
Die Version der zu verwendenden Runtime. Die einzige zulässige Version ist derzeit `1.0.0`.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[RuntimeVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-appsyncruntime.html#cfn-appsync-resolver-appsyncruntime-runtimeversion)` Eigenschaft eines `AWS::AppSync::Resolver AppSyncRuntime` Objekts übergeben.

# AWS::Serverless::HttpApi
<a name="sam-resource-httpapi"></a>

Erstellt eine Amazon API Gateway Gateway-HTTP-API, mit der Sie RESTful APIs mit geringerer Latenz und geringeren Kosten als REST erstellen können APIs. Weitere Informationen finden Sie unter [Working with HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) im *API Gateway Developer Guide*.

Wir empfehlen, CloudFormation Hooks oder IAM-Richtlinien zu verwenden, um zu überprüfen, ob an API-Gateway-Ressourcen Autorisatoren angehängt sind, um den Zugriff darauf zu kontrollieren.

Weitere Informationen zur Verwendung von CloudFormation Hooks finden Sie unter [Hooks registrieren](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/registering-hook-python.html) im *CloudFormation CLI-Benutzerhandbuch* und im [apigw-enforce-authorizer](https://github.com/aws-cloudformation/aws-cloudformation-samples/tree/main/hooks/python-hooks/apigw-enforce-authorizer/) GitHub Repository.

Weitere Informationen zur Verwendung von IAM-Richtlinien finden Sie unter [Erfordern, dass API-Routen autorisiert sind](https://docs.aws.amazon.com/apigateway/latest/developerguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-require-authorization) im *API Gateway Developer Guide*.

**Anmerkung**  
Bei der Bereitstellung auf werden AWS CloudFormation Ihre AWS SAM Ressourcen in Ressourcen umgewandelt CloudFormation . AWS SAM Weitere Informationen finden Sie unter [Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md).

## Syntax
<a name="sam-resource-httpapi-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-resource-httpapi-syntax.yaml"></a>

```
Type: AWS::Serverless::HttpApi
Properties:
  [AccessLogSettings](#sam-httpapi-accesslogsettings): [AccessLogSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings)
  [Auth](#sam-httpapi-auth): HttpApiAuth
  [CorsConfiguration](#sam-httpapi-corsconfiguration): String | HttpApiCorsConfiguration
  [DefaultRouteSettings](#sam-httpapi-defaultroutesettings): [RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)
  [DefinitionBody](#sam-httpapi-definitionbody): JSON
  [DefinitionUri](#sam-httpapi-definitionuri): String | HttpApiDefinition
  [Description](#sam-httpapi-description): String
  [DisableExecuteApiEndpoint](#sam-httpapi-disableexecuteapiendpoint): Boolean
  [Domain](#sam-httpapi-domain): HttpApiDomainConfiguration
  [FailOnWarnings](#sam-httpapi-failonwarnings): Boolean
  Name: String
  PropagateTags: Boolean
  [RouteSettings](#sam-httpapi-routesettings): [RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)
  [StageName](#sam-httpapi-stagename): String
  [StageVariables](#sam-httpapi-stagevariables): [Json](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables)
  [Tags](#sam-httpapi-tags): Map
```

## Eigenschaften
<a name="sam-resource-httpapi-properties"></a>

 `AccessLogSettings`   <a name="sam-httpapi-accesslogsettings"></a>
Die Einstellungen für die Zugriffsprotokollierung in einer Phase.  
*Typ:* [AccessLogSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[AccessLogSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings)` Eigenschaft einer `AWS::ApiGatewayV2::Stage` Ressource übergeben.

 `Auth`   <a name="sam-httpapi-auth"></a>
Konfiguriert die Autorisierung für die Steuerung des Zugriffs auf Ihre API Gateway Gateway-HTTP-API.  
Weitere Informationen finden Sie unter [Steuern des Zugriffs auf HTTP APIs mit JWT-Autorisierern](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html) im *API Gateway* Developer Guide.  
*Typ:* [HttpApiAuth](sam-property-httpapi-httpapiauth.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. CloudFormation 

 `CorsConfiguration`   <a name="sam-httpapi-corsconfiguration"></a>
Verwaltet Cross-Origin Resource Sharing (CORS) für Ihr gesamtes API-Gateway-HTTP. APIs Geben Sie die Domäne, die zugelassen werden soll, als Zeichenfolge an, oder geben Sie ein Objekt an`HttpApiCorsConfiguration`. Beachten Sie, dass CORS Ihre OpenAPI-Definition ändern muss AWS SAM , sodass CORS nur funktioniert, wenn die `DefinitionBody` Eigenschaft angegeben ist.  
Weitere Informationen finden Sie unter [Konfiguration von CORS für eine HTTP-API im API](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) *Gateway Developer Guide*.  
Wenn sowohl in einer OpenAPI-Definition als auch auf Eigenschaftsebene festgelegt `CorsConfiguration` ist, werden beide Konfigurationsquellen AWS SAM zusammengeführt, wobei die Eigenschaften Vorrang haben. Wenn diese Eigenschaft auf gesetzt ist`true`, sind alle Ursprünge zulässig.
*Typ*: Zeichenfolge \$1 [HttpApiCorsConfiguration](sam-property-httpapi-httpapicorsconfiguration.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `DefaultRouteSettings`   <a name="sam-httpapi-defaultroutesettings"></a>
Die Standardrouteneinstellungen für diese HTTP-API. Diese Einstellungen gelten für alle Routen, sofern sie nicht durch die `RouteSettings` Eigenschaft für bestimmte Routen außer Kraft gesetzt werden.  
*Typ:* [RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)` Eigenschaft einer `AWS::ApiGatewayV2::Stage` Ressource übergeben.

 `DefinitionBody`   <a name="sam-httpapi-definitionbody"></a>
Die OpenAPI-Definition, die Ihre HTTP-API beschreibt. Wenn Sie a `DefinitionUri` oder a nicht angeben`DefinitionBody`, AWS SAM generiert es auf der Grundlage Ihrer Vorlagenkonfiguration eine `DefinitionBody` für Sie.  
*Type*: JSON  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body)` Eigenschaft einer `AWS::ApiGatewayV2::Api` Ressource. Wenn bestimmte Eigenschaften angegeben sind, AWS SAM kann Inhalt in die Datei eingefügt oder geändert werden, `DefinitionBody` bevor sie an sie übergeben CloudFormation werden. Zu den Eigenschaften gehören ein `EventSource` Typ `Auth` und ein Typ HttpApi für eine entsprechende `AWS::Serverless::Function` Ressource.

 `DefinitionUri`   <a name="sam-httpapi-definitionuri"></a>
Der Amazon Simple Storage Service (Amazon S3) -URI, der lokale Dateipfad oder das Speicherortobjekt der OpenAPI-Definition, die die HTTP-API definiert. Das Amazon S3 S3-Objekt, auf das diese Eigenschaft verweist, muss eine gültige OpenAPI-Definitionsdatei sein. Wenn Sie a nicht angeben `DefinitionUri` oder a angegeben `DefinitionBody` sind, AWS SAM generiert es eine `DefinitionBody` für Sie auf der Grundlage Ihrer Vorlagenkonfiguration.  
Wenn Sie einen lokalen Dateipfad angeben, muss die Vorlage den Workflow durchlaufen, der den `sam package` Befehl `sam deploy` oder enthält, damit die Definition ordnungsgemäß transformiert wird.  
Systeminterne Funktionen werden in externen OpenApi Definitionsdateien, auf die Sie verweisen, nicht unterstützt. `DefinitionUri` [Um eine OpenApi Definition in die Vorlage zu importieren, verwenden Sie die `DefinitionBody` Eigenschaft zusammen mit der Include-Transformation.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html)  
*Typ*: Zeichenfolge \$1 [HttpApiDefinition](sam-property-httpapi-httpapidefinition.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[BodyS3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location)` Eigenschaft einer `AWS::ApiGatewayV2::Api` Ressource. Die verschachtelten Amazon S3 S3-Eigenschaften sind unterschiedlich benannt.

 `Description`   <a name="sam-httpapi-description"></a>
Die Beschreibung der HTTP-API-Ressource.  
Wenn Sie angeben`Description`, AWS SAM wird die OpenApi Definition der HTTP-API-Ressource geändert, indem das `description` Feld festgelegt wird. Die folgenden Szenarien führen zu einem Fehler:  
+ Die `DefinitionBody` Eigenschaft wird mit dem in der Open API-Definition festgelegten `description` Feld angegeben. Dies führt zu einem Konflikt im `description` Feld, der AWS SAM nicht gelöst werden kann.
+ Die `DefinitionUri` Eigenschaft ist angegeben — ändert AWS SAM keine Open-API-Definition, die von Amazon S3 abgerufen wird.
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `DisableExecuteApiEndpoint`   <a name="sam-httpapi-disableexecuteapiendpoint"></a>
Gibt an, ob Clients Ihre HTTP-API mithilfe des `execute-api` Standardendpunkts `https://{api_id}.execute-api.{region}.amazonaws.com` aufrufen können. Standardmäßig können Kunden Ihre API mit dem standardmäßigen -Endpunkt aufrufen. Um zu verlangen, dass Clients nur einen benutzerdefinierten Domainnamen verwenden, um Ihre API aufzurufen, deaktivieren Sie den Standardendpunkt.  
Um diese Eigenschaft zu verwenden, müssen Sie `disableExecuteApiEndpoint` in Ihrer OpenAPI-Definition die `DefinitionBody` `DefinitionUri` Eigenschaft anstelle der Eigenschaft angeben oder `x-amazon-apigateway-endpoint-configuration` mit definieren.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[ DisableExecuteApiEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableexecuteapiendpoint)` Eigenschaft einer `AWS::ApiGatewayV2::Api` Ressource. Sie wird direkt an die `disableExecuteApiEndpoint` Eigenschaft einer `[ x-amazon-apigateway-endpoint-configuration](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-endpoint-configuration.html)` Erweiterung übergeben, die der ` [ Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body)` Eigenschaft einer `AWS::ApiGatewayV2::Api` Ressource hinzugefügt wird.

 `Domain`   <a name="sam-httpapi-domain"></a>
Konfiguriert eine benutzerdefinierte Domain für diese API Gateway Gateway-HTTP-API.  
*Typ:* [HttpApiDomainConfiguration](sam-property-httpapi-httpapidomainconfiguration.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `FailOnWarnings`   <a name="sam-httpapi-failonwarnings"></a>
Gibt an, ob die HTTP-API-Erstellung rückgängig gemacht werden soll (`true`) oder nicht (`false`), wenn eine Warnung auftritt. Der Standardwert ist `false`.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FailOnWarnings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings)` Eigenschaft einer `AWS::ApiGatewayV2::Api` Ressource übergeben.

`Name`  <a name="sam-httpapi-name"></a>
Der Name der HTTP-API-Ressource.  
Wenn Sie angeben`Name`, AWS SAM wird die OpenAPI-Definition der HTTP-API-Ressource geändert, indem das `title` Feld festgelegt wird. Die folgenden Szenarien führen zu einem Fehler:  
+ Die `DefinitionBody` Eigenschaft wird mit dem in der Open API-Definition festgelegten `title` Feld angegeben. Dies führt zu einem Konflikt im `title` Feld, der AWS SAM nicht gelöst werden kann.
+ Die `DefinitionUri` Eigenschaft ist angegeben — ändert AWS SAM keine Open-API-Definition, die von Amazon S3 abgerufen wird.
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

`PropagateTags`  <a name="sam-httpapi-propagatetags"></a>
Geben Sie an, ob Tags von der `Tags` Eigenschaft an Ihre [AWS::Serverless::HttpApi](sam-specification-generated-resources-httpapi.md) generierten Ressourcen weitergegeben werden sollen oder nicht. Geben Sie `True` an, dass Tags in Ihren generierten Ressourcen verbreitet werden sollen.  
*Typ*: Boolesch  
*Required*: No  
*Standardwert*: `False`  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `RouteSettings`   <a name="sam-httpapi-routesettings"></a>
Die Routeneinstellungen pro Route für diese HTTP-API. Weitere Informationen finden Sie unter [Working with routes for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html) im *API Gateway Developer Guide*.  
*Typ:* [RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)` Eigenschaft einer `AWS::ApiGatewayV2::Stage` Ressource übergeben.

 `StageName`   <a name="sam-httpapi-stagename"></a>
Der Name der API-Stufe. Wenn kein Name angegeben ist, wird der `$default` Stagingbereich von API Gateway AWS SAM verwendet.  
*Typ:* Zeichenfolge  
*Required*: No  
*Standard*: \$1default  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[StageName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagename)` Eigenschaft einer `AWS::ApiGatewayV2::Stage` Ressource übergeben.

 `StageVariables`   <a name="sam-httpapi-stagevariables"></a>
Eine Zuweisung, welche die Stufenvariablen definiert. Variablennamen können alphanumerische Zeichen und Unterstriche enthalten. Die Werte müssen mit [a-Za-Z0-9-.\$1\$1:/? \$1&=,] \$1.  
*Type*: [Json](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[StageVariables](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables)` Eigenschaft einer `AWS::ApiGatewayV2::Stage` Ressource übergeben.

 `Tags`   <a name="sam-httpapi-tags"></a>
Eine Zuordnung (Zeichenfolge zu Zeichenfolge), die die Tags angibt, die zu diesem API-Gateway-Schritt hinzugefügt werden sollen. Schlüssel können 1 bis 128 Unicode-Zeichen lang sein und dürfen das Präfix nicht enthalten`aws:`. Sie können eines der folgenden Zeichen verwenden: Unicode-Zeichen, Ziffern, Leerraum, `_`, `.`, `/`, `=`, `+` und `-`. Werte können 1 bis 256 Unicode-Zeichen lang sein.  
*Typ*: Karte  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.  
*Zusätzliche Hinweise*: Die `Tags` Eigenschaft erfordert eine AWS SAM Änderung Ihrer OpenAPI-Definition, sodass Tags nur hinzugefügt werden, wenn die `DefinitionBody` Eigenschaft angegeben ist — es werden keine Tags hinzugefügt, wenn die Eigenschaft angegeben ist. `DefinitionUri` AWS SAM fügt automatisch ein Tag hinzu. `httpapi:createdBy:SAM` Der `AWS::ApiGatewayV2::Stage` Ressource und der `AWS::ApiGatewayV2::DomainName` Ressource (falls `DomainName` angegeben) werden auch Tags hinzugefügt.

## Rückgabewerte
<a name="sam-resource-httpapi-return-values"></a>

### Punkt
<a name="sam-resource-httpapi-return-values-ref"></a>

Wenn Sie die logische ID dieser Ressource an die systeminterne `Ref` Funktion übergeben, wird die API-ID der zugrunde liegenden `AWS::ApiGatewayV2::Api` Ressource `Ref` zurückgegeben, zum Beispiel. `a1bcdef2gh`

Weitere Informationen zur Verwendung der `Ref` Funktion finden Sie [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)im *AWS CloudFormation Benutzerhandbuch*. 

## Beispiele
<a name="sam-resource-httpapi--examples"></a>

### Einfach HttpApi
<a name="sam-resource-httpapi--examples--simple-httpapi"></a>

Das folgende Beispiel zeigt das Minimum, das für die Einrichtung eines HTTP-API-Endpunkts erforderlich ist, der von einer Lambda-Funktion unterstützt wird. In diesem Beispiel wird die standardmäßige HTTP-API verwendet, die AWS SAM erstellt.

#### YAML
<a name="sam-resource-httpapi--examples--simple-httpapi--yaml"></a>

```
AWSTemplateFormatVersion: '2010-09-09'
Description: AWS SAM template with a simple API definition
Resources:
  ApiFunction:
    Type: AWS::Serverless::Function
    Properties:
      Events:
        ApiEvent:
          Type: HttpApi
      Handler: index.handler
      InlineCode: |
        def handler(event, context):
            return {'body': 'Hello World!', 'statusCode': 200}
      Runtime: python3.7
Transform: AWS::Serverless-2016-10-31
```

### HttpApi mit Auth
<a name="sam-resource-httpapi--examples--httpapi-with-auth"></a>

Das folgende Beispiel zeigt, wie die Autorisierung auf HTTP-API-Endpunkten eingerichtet wird.

#### YAML
<a name="sam-resource-httpapi--examples--httpapi-with-auth--yaml"></a>

```
Properties:
  FailOnWarnings: true
  Auth:
    DefaultAuthorizer: OAuth2
    Authorizers:
      OAuth2:
        AuthorizationScopes:
          - scope4
        JwtConfiguration:
          issuer: "https://www.example.com/v1/connect/oauth2"
          audience:
            - MyApi
        IdentitySource: "$request.querystring.param"
```

### HttpApi mit OpenAPI-Definition
<a name="sam-resource-httpapi--examples--httpapi-with-openapi-definition"></a>

Das folgende Beispiel zeigt, wie Sie der Vorlage eine OpenAPI-Definition hinzufügen.

Beachten Sie, dass alle fehlenden Lambda-Integrationen für HttpApi Ereignisse, die auf diese HTTP-API verweisen, AWS SAM ausgefüllt werden. AWS SAM fügt auch alle fehlenden Pfade hinzu, auf die HttpApi Ereignisse verweisen.

#### YAML
<a name="sam-resource-httpapi--examples--httpapi-with-openapi-definition--yaml"></a>

```
Properties:
  FailOnWarnings: true
  DefinitionBody:
    info:
      version: '1.0'
      title:
        Ref: AWS::StackName
    paths:
      "/":
        get:
          security:
          - OpenIdAuth:
            - scope1
            - scope2
          responses: {}
    openapi: 3.0.1
    securitySchemes:
      OpenIdAuth:
        type: openIdConnect
        x-amazon-apigateway-authorizer:
          identitySource: "$request.querystring.param"
          type: jwt
          jwtConfiguration:
            audience:
            - MyApi
            issuer: https://www.example.com/v1/connect/oidc
          openIdConnectUrl: https://www.example.com/v1/connect/oidc/.well-known/openid-configuration
```

### HttpApi mit Konfigurationseinstellungen
<a name="sam-resource-httpapi--examples--httpapi-with-configuration-settings"></a>

Das folgende Beispiel zeigt, wie HTTP-API- und Staging-Konfigurationen zur Vorlage hinzugefügt werden.

#### YAML
<a name="sam-resource-httpapi--examples--httpapi-with-configuration-settings--yaml"></a>

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Parameters:
  StageName:
    Type: String
    Default: Prod
    
Resources:
  HttpApiFunction:
    Type: AWS::Serverless::Function
    Properties:
      InlineCode: |
          def handler(event, context):
              import json
              return {
                  "statusCode": 200,
                  "body": json.dumps(event),
              }
      Handler: index.handler
      Runtime: python3.7
      Events:
        ExplicitApi: # warning: creates a public endpoint
          Type: HttpApi
          Properties:
            ApiId: !Ref HttpApi
            Method: GET
            Path: /path
            TimeoutInMillis: 15000
            PayloadFormatVersion: "2.0"
            RouteSettings:
              ThrottlingBurstLimit: 600

  HttpApi:
    Type: AWS::Serverless::HttpApi
    Properties:
      StageName: !Ref StageName
      Tags:
        Tag: Value
      AccessLogSettings:
        DestinationArn: !GetAtt AccessLogs.Arn
        Format: $context.requestId
      DefaultRouteSettings:
        ThrottlingBurstLimit: 200
      RouteSettings:
        "GET /path":
          ThrottlingBurstLimit: 500 # overridden in HttpApi Event
      StageVariables:
        StageVar: Value
      FailOnWarnings: true

  AccessLogs:
    Type: AWS::Logs::LogGroup

Outputs:
  HttpApiUrl:
    Description: URL of your API endpoint
    Value:
      Fn::Sub: 'https://${HttpApi}.execute-api.${AWS::Region}.${AWS::URLSuffix}/${StageName}/'
  HttpApiId:
    Description: Api id of HttpApi
    Value:
      Ref: HttpApi
```

# HttpApiAuth
<a name="sam-property-httpapi-httpapiauth"></a>

Konfigurieren Sie die Autorisierung, um den Zugriff auf Ihre Amazon API Gateway Gateway-HTTP-API zu kontrollieren.

Weitere Informationen zur Konfiguration des Zugriffs auf HTTP APIs finden Sie unter [Steuern und Verwalten des Zugriffs auf eine HTTP-API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control.html) im *API Gateway Developer Guide*.

## Syntax
<a name="sam-property-httpapi-httpapiauth-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-httpapi-httpapiauth-syntax.yaml"></a>

```
  [Authorizers](#sam-httpapi-httpapiauth-authorizers): OAuth2Authorizer | LambdaAuthorizer
  [DefaultAuthorizer](#sam-httpapi-httpapiauth-defaultauthorizer): String
  [EnableIamAuthorizer](#sam-httpapi-httpapiauth-enableiamauthorizer): Boolean
```

## Eigenschaften
<a name="sam-property-httpapi-httpapiauth-properties"></a>

 `Authorizers`   <a name="sam-httpapi-httpapiauth-authorizers"></a>
Der Autorisierer, der zur Steuerung des Zugriffs auf Ihre API-Gateway-API verwendet wird.  
*Typ*: [OAuth2Authorizer \$1 [LambdaAuthorizer](sam-property-httpapi-lambdaauthorizer.md)](sam-property-httpapi-oauth2authorizer.md)  
*Required*: No  
*Standard*: Keiner  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.  
*Zusätzliche Hinweise*: AWS SAM Fügt die Autorisierer zur OpenAPI-Definition hinzu.

 `DefaultAuthorizer`   <a name="sam-httpapi-httpapiauth-defaultauthorizer"></a>
Geben Sie den Standard-Authorizer an, der für die Autorisierung von API-Aufrufen an Ihre API-Gateway-API verwendet werden soll. Sie können ihn `AWS_IAM` als Standardautorisierer angeben, wenn er auf gesetzt `EnableIamAuthorizer` ist. `true` Geben Sie andernfalls einen Autorisierer an, den Sie in definiert haben. `Authorizers`  
*Typ:* Zeichenfolge  
*Required*: No  
*Standard*: Keiner  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `EnableIamAuthorizer`   <a name="sam-httpapi-httpapiauth-enableiamauthorizer"></a>
Geben Sie an, ob die IAM-Autorisierung für die API-Route verwendet werden soll.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-httpapi-httpapiauth--examples"></a>

### OAuth 2.0 Autorisierer
<a name="sam-property-httpapi-httpapiauth--examples--oauth-2.0-authorizer"></a>

OAuth Beispiel für einen 2.0-Authorizer

#### YAML
<a name="sam-property-httpapi-httpapiauth--examples--oauth-2.0-authorizer--yaml"></a>

```
Auth:
  Authorizers:
    OAuth2Authorizer:
      AuthorizationScopes:
        - scope1
        - scope2
      JwtConfiguration:
        issuer: "https://www.example.com/v1/connect/oauth2"
        audience:
          - MyApi
      IdentitySource: "$request.querystring.param"
  DefaultAuthorizer: OAuth2Authorizer
```

### Ein IAM-Autorisierer
<a name="sam-property-httpapi-httpapiauth--examples--iam-authorizer"></a>

Beispiel für einen IAM-Autorisierer

#### YAML
<a name="sam-property-httpapi-httpapiauth--examples--iam-authorizer--yaml"></a>

```
Auth:
  EnableIamAuthorizer: true
  DefaultAuthorizer: AWS_IAM
```

# LambdaAuthorizer
<a name="sam-property-httpapi-lambdaauthorizer"></a>

Konfigurieren Sie einen Lambda-Authorizer, um den Zugriff auf Ihre Amazon API Gateway Gateway-HTTP-API mit einer AWS Lambda Funktion zu kontrollieren.

Weitere Informationen und Beispiele finden Sie unter [Arbeiten mit AWS Lambda Autorisierern für HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html) im *API Gateway Developer Guide*.

## Syntax
<a name="sam-property-httpapi-lambdaauthorizer-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-httpapi-lambdaauthorizer-syntax.yaml"></a>

```
  [AuthorizerPayloadFormatVersion](#sam-httpapi-lambdaauthorizer-authorizerpayloadformatversion): String
  EnableFunctionDefaultPermissions: Boolean
  [EnableSimpleResponses](#sam-httpapi-lambdaauthorizer-enablesimpleresponses): Boolean
  [FunctionArn](#sam-httpapi-lambdaauthorizer-functionarn): String
  [FunctionInvokeRole](#sam-httpapi-lambdaauthorizer-functioninvokerole): String
  [Identity](#sam-httpapi-lambdaauthorizer-identity): LambdaAuthorizationIdentity
```

## Eigenschaften
<a name="sam-property-httpapi-lambdaauthorizer-properties"></a>

 `AuthorizerPayloadFormatVersion`   <a name="sam-httpapi-lambdaauthorizer-authorizerpayloadformatversion"></a>
Gibt das Format der Nutzlast an, die an einen HTTP-API-Lambda-Genehmiger gesendet wird. Für HTTP-API-Lambda-Genehmiger erforderlich.  
Dies wird an den `authorizerPayloadFormatVersion` Abschnitt von und `x-amazon-apigateway-authorizer` im `securitySchemes` Abschnitt einer OpenAPI-Definition weitergegeben.  
*Zulässige Werte*: `1.0` oder `2.0`.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `EnableFunctionDefaultPermissions`   <a name="sam-httpapi-lambdaauthorizer-enablefunctiondefaultpermissions"></a>
Standardmäßig wird der HTTP-API-Ressource keine Berechtigung zum Aufrufen des Lambda-Autorisierers erteilt. Geben Sie diese Eigenschaft an`true`, um automatisch Berechtigungen zwischen Ihrer HTTP-API-Ressource und Ihrem Lambda-Authorizer zu erstellen.  
*Typ*: Boolesch  
*Required*: No  
*Standardwert*: `false`  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `EnableSimpleResponses`   <a name="sam-httpapi-lambdaauthorizer-enablesimpleresponses"></a>
Gibt an, ob ein Lambda-Genehmiger eine Antwort in einem einfachen Format zurückgibt. Standardmäßig muss ein Lambda-Autorisierer eine AWS Identity and Access Management (IAM-) Richtlinie zurückgeben. Wenn diese Option aktiviert ist, kann der Lambda-Genehmiger anstelle einer IAM-Richtlinie einen booleschen Wert zurückgeben.  
Dies wird an den `enableSimpleResponses` Abschnitt von und `x-amazon-apigateway-authorizer` im `securitySchemes` Abschnitt einer OpenAPI-Definition weitergegeben.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `FunctionArn`   <a name="sam-httpapi-lambdaauthorizer-functionarn"></a>
Der Amazon-Ressourcenname (ARN) der Lambda-Funktion, die die Autorisierung für die API bereitstellt.  
Dies wird an den `authorizerUri` Abschnitt von und `x-amazon-apigateway-authorizer` im `securitySchemes` Abschnitt einer OpenAPI-Definition weitergegeben.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `FunctionInvokeRole`   <a name="sam-httpapi-lambdaauthorizer-functioninvokerole"></a>
Der ARN der IAM-Rolle, die über die Anmeldeinformationen verfügt, die API Gateway benötigt, um die Autorisierungsfunktion aufzurufen. Geben Sie diesen Parameter an, wenn die ressourcenbasierte Richtlinie Ihrer Funktion keine `lambda:InvokeFunction` API-Gateway-Berechtigung gewährt.  
Dies wird an den `authorizerCredentials` Abschnitt von und `x-amazon-apigateway-authorizer` im `securitySchemes` Abschnitt einer OpenAPI-Definition weitergegeben.  
Weitere Informationen finden Sie unter [Create a Lambda Authorizer](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html#http-api-lambda-authorizer.example-create) im *API Gateway Developer Guide*.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Identity`   <a name="sam-httpapi-lambdaauthorizer-identity"></a>
Gibt `IdentitySource` in einer eingehenden Anfrage nach einem Autorisierer ein an.  
Dies wird an den `identitySource` Abschnitt von und `x-amazon-apigateway-authorizer` im `securitySchemes` Abschnitt einer OpenAPI-Definition weitergegeben.  
*Typ:* [LambdaAuthorizationIdentity](sam-property-httpapi-lambdaauthorizationidentity.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-httpapi-lambdaauthorizer--examples"></a>

### LambdaAuthorizer
<a name="sam-property-httpapi-lambdaauthorizer--examples--lambdaauthorizer"></a>

LambdaAuthorizer Beispiel

#### YAML
<a name="sam-property-httpapi-lambdaauthorizer--examples--lambdaauthorizer--yaml"></a>

```
Auth:
  Authorizers:
    MyLambdaAuthorizer:
      AuthorizerPayloadFormatVersion: 2.0
      FunctionArn:
        Fn::GetAtt:
          - MyAuthFunction
          - Arn
      FunctionInvokeRole:
        Fn::GetAtt:
          - LambdaAuthInvokeRole
          - Arn
      Identity:
        Headers:
          - Authorization
```

# LambdaAuthorizationIdentity
<a name="sam-property-httpapi-lambdaauthorizationidentity"></a>

Die Use-Eigenschaft kann verwendet werden, um IdentitySource in einer eingehenden Anfrage für einen Lambda-Autorisierer einen anzugeben. Weitere Informationen zu Identitätsquellen finden Sie unter [Identitätsquellen](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html#http-api-lambda-authorizer.identity-sources) im *API Gateway Developer Guide*.

## Syntax
<a name="sam-property-httpapi-lambdaauthorizationidentity-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-httpapi-lambdaauthorizationidentity-syntax.yaml"></a>

```
  [Context](#sam-httpapi-lambdaauthorizationidentity-context): List
  [Headers](#sam-httpapi-lambdaauthorizationidentity-headers): List
  [QueryStrings](#sam-httpapi-lambdaauthorizationidentity-querystrings): List
  [ReauthorizeEvery](#sam-httpapi-lambdaauthorizationidentity-reauthorizeevery): Integer
  [StageVariables](#sam-httpapi-lambdaauthorizationidentity-stagevariables): List
```

## Eigenschaften
<a name="sam-property-httpapi-lambdaauthorizationidentity-properties"></a>

 `Context`   <a name="sam-httpapi-lambdaauthorizationidentity-context"></a>
Konvertiert die angegebenen Kontextzeichenfolgen in eine Liste von Mapping-Ausdrücken im Format`$context.contextString`.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Headers`   <a name="sam-httpapi-lambdaauthorizationidentity-headers"></a>
Konvertiert die Header in eine Liste von Zuordnungsausdrücken im Format`$request.header.name`.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `QueryStrings`   <a name="sam-httpapi-lambdaauthorizationidentity-querystrings"></a>
Konvertiert die angegebenen Abfragezeichenfolgen in eine Liste von Zuordnungsausdrücken im Format`$request.querystring.queryString`.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `ReauthorizeEvery`   <a name="sam-httpapi-lambdaauthorizationidentity-reauthorizeevery"></a>
Der Zeitraum time-to-live (TTL) in Sekunden, der angibt, wie lange API Gateway Autorisierungsergebnisse zwischenspeichert. Wenn Sie einen Wert größer als 0 festlegen, speichert API Gateway die Genehmigerantworten im Cache. Der maximale Wert ist 3600, oder 1 Stunde.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. CloudFormation 

 `StageVariables`   <a name="sam-httpapi-lambdaauthorizationidentity-stagevariables"></a>
Konvertiert die angegebenen Stufenvariablen in eine Liste von Mapping-Ausdrücken im Format`$stageVariables.stageVariable`.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-httpapi-lambdaauthorizationidentity--examples"></a>

### LambdaRequestIdentity
<a name="sam-property-httpapi-lambdaauthorizationidentity--examples--lambdarequestidentity"></a>

Beispiel für eine Lambda-Anfrage

#### YAML
<a name="sam-property-httpapi-lambdaauthorizationidentity--examples--lambdarequestidentity--yaml"></a>

```
Identity:
  QueryStrings:
    - auth
  Headers:
    - Authorization
  StageVariables:
    - VARIABLE
  Context:
    - authcontext
  ReauthorizeEvery: 100
```

# OAuth2Authorizer
<a name="sam-property-httpapi-oauth2authorizer"></a>

Definition für einen OAuth 2.0-Authorizer, auch bekannt als JSON Web Token (JWT) -Authorizer.

Weitere Informationen finden Sie unter [Steuern des Zugriffs auf HTTP APIs mit JWT-Autorisierern](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html) im *API Gateway* Developer Guide.

## Syntax
<a name="sam-property-httpapi-oauth2authorizer-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-httpapi-oauth2authorizer-syntax.yaml"></a>

```
  [AuthorizationScopes](#sam-httpapi-oauth2authorizer-authorizationscopes): List
  [IdentitySource](#sam-httpapi-oauth2authorizer-identitysource): String
  [JwtConfiguration](#sam-httpapi-oauth2authorizer-jwtconfiguration): Map
```

## Eigenschaften
<a name="sam-property-httpapi-oauth2authorizer-properties"></a>

 `AuthorizationScopes`   <a name="sam-httpapi-oauth2authorizer-authorizationscopes"></a>
Liste der Autorisierungsbereiche für diesen Autorisierer.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `IdentitySource`   <a name="sam-httpapi-oauth2authorizer-identitysource"></a>
Ausdruck der Identitätsquelle für diesen Autorisierer.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `JwtConfiguration`   <a name="sam-httpapi-oauth2authorizer-jwtconfiguration"></a>
JWT-Konfiguration für diesen Autorisierer.  
Dies wird an den `jwtConfiguration` Abschnitt von und `x-amazon-apigateway-authorizer` im `securitySchemes` Abschnitt einer OpenAPI-Definition weitergegeben.  
Eigenschaften `issuer` und `audience` unterscheiden nicht zwischen Groß- und Kleinschreibung und können entweder in Kleinbuchstaben wie in OpenAPI oder in Großbuchstaben `Issuer` und wie in verwendet werden. `Audience` [AWS::ApiGatewayV2::Authorizer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-authorizer-jwtconfiguration.html) 
*Typ: Karte*  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-httpapi-oauth2authorizer--examples"></a>

### OAuth 2.0-Autorisierer
<a name="sam-property-httpapi-oauth2authorizer--examples--oauth-2.0-authorizer"></a>

OAuth Beispiel für einen 2.0-Authorizer

#### YAML
<a name="sam-property-httpapi-oauth2authorizer--examples--oauth-2.0-authorizer--yaml"></a>

```
Auth:
  Authorizers:
    OAuth2Authorizer:
      AuthorizationScopes:
        - scope1
      JwtConfiguration:
        issuer: "https://www.example.com/v1/connect/oauth2"
        audience:
          - MyApi
      IdentitySource: "$request.querystring.param"
  DefaultAuthorizer: OAuth2Authorizer
```

# HttpApiCorsConfiguration
<a name="sam-property-httpapi-httpapicorsconfiguration"></a>

Verwalte Cross-Origin Resource Sharing (CORS) für dein HTTP. APIs Geben Sie die Domain, die zugelassen werden soll, als Zeichenfolge an oder geben Sie ein Wörterbuch mit zusätzlicher Cors-Konfiguration an. HINWEIS: Cors benötigt SAM, um Ihre OpenAPI-Definition zu ändern, sodass es nur mit Inline funktioniert, die in der OpenApi `DefinitionBody` Eigenschaft definiert ist.

Weitere Informationen zu CORS finden Sie unter [Konfiguration von CORS für eine HTTP-API im API](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) *Gateway Developer Guide*.

Hinweis: Wenn sowohl in OpenAPI als auch auf Eigenschaftenebene gesetzt HttpApiCorsConfiguration ist, werden sie mit den AWS SAM Eigenschaften zusammengeführt, die Vorrang haben.

## Syntax
<a name="sam-property-httpapi-httpapicorsconfiguration-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-httpapi-httpapicorsconfiguration-syntax.yaml"></a>

```
  [AllowCredentials](#sam-httpapi-httpapicorsconfiguration-allowcredentials): Boolean
  [AllowHeaders](#sam-httpapi-httpapicorsconfiguration-allowheaders): List
  [AllowMethods](#sam-httpapi-httpapicorsconfiguration-allowmethods): List
  [AllowOrigins](#sam-httpapi-httpapicorsconfiguration-alloworigins): List
  [ExposeHeaders](#sam-httpapi-httpapicorsconfiguration-exposeheaders): List
  [MaxAge](#sam-httpapi-httpapicorsconfiguration-maxage): Integer
```

## Eigenschaften
<a name="sam-property-httpapi-httpapicorsconfiguration-properties"></a>

 `AllowCredentials`   <a name="sam-httpapi-httpapicorsconfiguration-allowcredentials"></a>
Gibt an, ob Anmeldeinformationen in der CORS-Anforderung enthalten sind.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `AllowHeaders`   <a name="sam-httpapi-httpapicorsconfiguration-allowheaders"></a>
Stellt eine Sammlung zulässiger Header dar.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `AllowMethods`   <a name="sam-httpapi-httpapicorsconfiguration-allowmethods"></a>
Stellt eine Sammlung zulässiger HTTP-Methoden dar.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `AllowOrigins`   <a name="sam-httpapi-httpapicorsconfiguration-alloworigins"></a>
Stellt eine Sammlung zulässiger Ursprünge dar.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `ExposeHeaders`   <a name="sam-httpapi-httpapicorsconfiguration-exposeheaders"></a>
Stellt eine Sammlung exponierter Header dar.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `MaxAge`   <a name="sam-httpapi-httpapicorsconfiguration-maxage"></a>
Die Anzahl der Sekunden, während der der Browser Preflight-Anforderungsergebnisse zwischenspeichern soll.  
*Typ*: Ganzzahl  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-httpapi-httpapicorsconfiguration--examples"></a>

### HttpApiCorsConfiguration
<a name="sam-property-httpapi-httpapicorsconfiguration--examples--httpapicorsconfiguration"></a>

Beispiel für eine HTTP-API-Cors-Konfiguration.

#### YAML
<a name="sam-property-httpapi-httpapicorsconfiguration--examples--httpapicorsconfiguration--yaml"></a>

```
CorsConfiguration:
  AllowOrigins:
    - "https://example.com"
  AllowHeaders:
    - x-apigateway-header
  AllowMethods:
    - GET
  MaxAge: 600
  AllowCredentials: true
```

# HttpApiDefinition
<a name="sam-property-httpapi-httpapidefinition"></a>

Ein OpenAPI-Dokument, das die API definiert.

## Syntax
<a name="sam-property-httpapi-httpapidefinition-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-httpapi-httpapidefinition-syntax.yaml"></a>

```
  [Bucket](#sam-httpapi-httpapidefinition-bucket): String
  [Key](#sam-httpapi-httpapidefinition-key): String
  [Version](#sam-httpapi-httpapidefinition-version): String
```

## Eigenschaften
<a name="sam-property-httpapi-httpapidefinition-properties"></a>

 `Bucket`   <a name="sam-httpapi-httpapidefinition-bucket"></a>
Der Name des Amazon S3 S3-Buckets, in dem die OpenAPI-Datei gespeichert ist.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-bucket)` Eigenschaft des `AWS::ApiGatewayV2::Api` `BodyS3Location` Datentyps übergeben.

 `Key`   <a name="sam-httpapi-httpapidefinition-key"></a>
Der Amazon S3 S3-Schlüssel der OpenAPI-Datei.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Key](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-key)` Eigenschaft des `AWS::ApiGatewayV2::Api` `BodyS3Location` Datentyps übergeben.

 `Version`   <a name="sam-httpapi-httpapidefinition-version"></a>
Für versionierte Objekte die Version der OpenAPI-Datei.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Version](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-version)` Eigenschaft des `AWS::ApiGatewayV2::Api` `BodyS3Location` Datentyps übergeben.

## Beispiele
<a name="sam-property-httpapi-httpapidefinition--examples"></a>

### Definition: Uri, Beispiel
<a name="sam-property-httpapi-httpapidefinition--examples--definition-uri-example"></a>

Beispiel für eine API-Definition

#### YAML
<a name="sam-property-httpapi-httpapidefinition--examples--definition-uri-example--yaml"></a>

```
DefinitionUri:
  Bucket: sam-s3-demo-bucket-name
  Key: mykey-name
  Version: 121212
```

# HttpApiDomainConfiguration
<a name="sam-property-httpapi-httpapidomainconfiguration"></a>

Konfiguriert eine benutzerdefinierte Domain für eine API.

## Syntax
<a name="sam-property-httpapi-httpapidomainconfiguration-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-httpapi-httpapidomainconfiguration-syntax.yaml"></a>

```
  [BasePath](#sam-httpapi-httpapidomainconfiguration-basepath): List
  [CertificateArn](#sam-httpapi-httpapidomainconfiguration-certificatearn): String
  [DomainName](#sam-httpapi-httpapidomainconfiguration-domainname): String
  [EndpointConfiguration](#sam-httpapi-httpapidomainconfiguration-endpointconfiguration): String
  [MutualTlsAuthentication](#sam-httpapi-httpapidomainconfiguration-mutualtlsauthentication): [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-mutualtlsauthentication)
  [OwnershipVerificationCertificateArn](#sam-httpapi-httpapidomainconfiguration-ownershipverificationcertificatearn): String
  [Route53](#sam-httpapi-httpapidomainconfiguration-route53): Route53Configuration
  [SecurityPolicy](#sam-httpapi-httpapidomainconfiguration-securitypolicy): String
```

## Eigenschaften
<a name="sam-property-httpapi-httpapidomainconfiguration-properties"></a>

 `BasePath`   <a name="sam-httpapi-httpapidomainconfiguration-basepath"></a>
Eine Liste der Basepfade, die mit dem Amazon API Gateway Gateway-Domänennamen konfiguriert werden sollen.  
*Typ*: Liste  
*Required*: No  
*Standard:/*  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[ApiMappingKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apimappingkey)` Eigenschaft einer `AWS::ApiGatewayV2::ApiMapping` Ressource. AWS SAM erstellt mehrere `AWS::ApiGatewayV2::ApiMapping` Ressourcen, eine pro Wert, der in dieser Eigenschaft angegeben ist.

 `CertificateArn`   <a name="sam-httpapi-httpapidomainconfiguration-certificatearn"></a>
Der Amazon-Ressourcenname (ARN) eines AWS verwalteten Zertifikats für den Endpunkt dieses Domainnamens. AWS Certificate Manager ist die einzige unterstützte Quelle.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[CertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-certificatearn)` Eigenschaft einer `AWS::ApiGateway2::DomainName DomainNameConfiguration` Ressource übergeben.

 `DomainName`   <a name="sam-httpapi-httpapidomainconfiguration-domainname"></a>
Der benutzerdefinierte Domainname für Ihre API-Gateway-API. Großbuchstaben werden nicht unterstützt.  
AWS SAM generiert eine `AWS::ApiGatewayV2::DomainName` Ressource, wenn diese Eigenschaft festgelegt ist. Hinweise zu diesem Szenario finden Sie unter[DomainName Eigenschaft ist spezifiziert](sam-specification-generated-resources-httpapi.md#sam-specification-generated-resources-httpapi-domain-name). Hinweise zu generierten CloudFormation Ressourcen finden Sie unter[Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md).  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainname)` Eigenschaft einer `AWS::ApiGateway2::DomainName` Ressource übergeben.

 `EndpointConfiguration`   <a name="sam-httpapi-httpapidomainconfiguration-endpointconfiguration"></a>
Definiert den Typ des API-Gateway-Endpunkts, der der benutzerdefinierten Domain zugeordnet werden soll. Der Wert dieser Eigenschaft bestimmt, wie die `CertificateArn` Eigenschaft zugeordnet wird. CloudFormation  
Der einzig gültige Wert für HTTP APIs ist`REGIONAL`.  
*Typ:* Zeichenfolge  
*Required*: No  
*Standardwert*: `REGIONAL`  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `MutualTlsAuthentication`   <a name="sam-httpapi-httpapidomainconfiguration-mutualtlsauthentication"></a>
Die TLS-Authentifizierungskonfiguration (Mutual Transport Layer Security) für einen benutzerdefinierten Domainnamen.  
*Typ:* [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-mutualtlsauthentication)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-mutualtlsauthentication)` Eigenschaft einer `AWS::ApiGatewayV2::DomainName` Ressource übergeben.

 `OwnershipVerificationCertificateArn`   <a name="sam-httpapi-httpapidomainconfiguration-ownershipverificationcertificatearn"></a>
Die ARN des öffentlichen Zertifikats, das von ACM ausgestellt wurde, um den Besitz Ihrer benutzerdefinierten Domain zu überprüfen. Nur erforderlich, wenn Sie Mutual TLS konfigurieren und einen von ACM importierten oder privaten CA-Zertifikat-ARN für angeben. `CertificateArn`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[OwnershipVerificationCertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-ownershipverificationcertificatearn)` Eigenschaft des `AWS::ApiGatewayV2::DomainName` `DomainNameConfiguration` Datentyps übergeben.

 `Route53`   <a name="sam-httpapi-httpapidomainconfiguration-route53"></a>
Definiert eine Amazon Route 53-Konfiguration.  
*Typ*: [Route53-Konfiguration](sam-property-httpapi-route53configuration.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. CloudFormation 

 `SecurityPolicy`   <a name="sam-httpapi-httpapidomainconfiguration-securitypolicy"></a>
Die TLS-Version der Sicherheitsrichtlinie für diesen Domainnamen.  
Der einzig gültige Wert für HTTP APIs ist`TLS_1_2`.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[SecurityPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-securitypolicy)` Eigenschaft des `AWS::ApiGatewayV2::DomainName` `DomainNameConfiguration` Datentyps übergeben.

## Beispiele
<a name="sam-property-httpapi-httpapidomainconfiguration--examples"></a>

### DomainName
<a name="sam-property-httpapi-httpapidomainconfiguration--examples--domainname"></a>

DomainName Beispiel

#### YAML
<a name="sam-property-httpapi-httpapidomainconfiguration--examples--domainname--yaml"></a>

```
Domain:
  DomainName: www.example.com
  CertificateArn: arn-example
  EndpointConfiguration: REGIONAL
  Route53:
    HostedZoneId: Z1PA6795UKMFR9
  BasePath:
    - foo
    - bar
```

# Route53Configuration
<a name="sam-property-httpapi-route53configuration"></a>

Konfiguriert die Route53-Datensätze für eine API.

## Syntax
<a name="sam-property-httpapi-route53configuration-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS Serverless Application Model (AWS SAM) -Vorlage zu deklarieren.

### YAML
<a name="sam-property-httpapi-route53configuration-syntax.yaml"></a>

```
  [DistributionDomainName](#sam-httpapi-route53configuration-distributiondomainname): String
  [EvaluateTargetHealth](#sam-httpapi-route53configuration-evaluatetargethealth): Boolean
  [HostedZoneId](#sam-httpapi-route53configuration-hostedzoneid): String
  [HostedZoneName](#sam-httpapi-route53configuration-hostedzonename): String
  [IpV6](#sam-httpapi-route53configuration-ipv6): Boolean
  Region: String
  SetIdentifier: String
```

## Eigenschaften
<a name="sam-property-httpapi-route53configuration-properties"></a>

 `DistributionDomainName`   <a name="sam-httpapi-route53configuration-distributiondomainname"></a>
Konfiguriert eine benutzerdefinierte Verteilung des benutzerdefinierten API-Domänennamens.  
*Typ:* Zeichenfolge  
*Required*: No  
*Standard*: Verwenden Sie die API Gateway Gateway-Distribution.  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[DNSName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget-1.html#cfn-route53-aliastarget-dnshostname)` Eigenschaft einer `AWS::Route53::RecordSetGroup AliasTarget` Ressource übergeben.  
*Zusätzliche Hinweise*: Der Domainname einer [CloudFrontDistribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html).

 `EvaluateTargetHealth`   <a name="sam-httpapi-route53configuration-evaluatetargethealth"></a>
Wenn EvaluateTargetHealth wahr, erbt ein Aliaseintrag den Zustand der referenzierten AWS Ressource, z. B. eines Elastic Load Balancing Balancing-Load Balancers oder eines anderen Datensatzes in der Hosting-Zone.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[EvaluateTargetHealth](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth)` Eigenschaft einer `AWS::Route53::RecordSetGroup AliasTarget` Ressource übergeben.  
*Zusätzliche Hinweise*: Sie können den Wert nicht auf „true“ EvaluateTargetHealth setzen, wenn es sich bei dem Alias-Ziel um eine CloudFront Distribution handelt.

 `HostedZoneId`   <a name="sam-httpapi-route53configuration-hostedzoneid"></a>
Die ID der gehosteten Zone, in der Sie Datensätze erstellen möchten.  
Geben Sie `HostedZoneName` oder `HostedZoneId` an, jedoch nicht beides. Wenn Sie mehrere gehostete Zonen mit dem gleichen Domainnamen haben, müssen Sie die gehostete Zone mit der `HostedZoneId` angeben.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[HostedZoneId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-hostedzoneid)` Eigenschaft einer `AWS::Route53::RecordSetGroup RecordSet` Ressource übergeben.

 `HostedZoneName`   <a name="sam-httpapi-route53configuration-hostedzonename"></a>
Der Name der gehosteten Zone, in der Sie Datensätze erstellen möchten. Sie müssen einen abschließenden Punkt (z. B. `www.example.com.`) als Teil des `HostedZoneName` angeben.  
Geben Sie `HostedZoneName` oder `HostedZoneId` an, jedoch nicht beides. Wenn Sie mehrere gehostete Zonen mit dem gleichen Domainnamen haben, müssen Sie die gehostete Zone mit der `HostedZoneId` angeben.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[HostedZoneName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-hostedzonename)` Eigenschaft einer `AWS::Route53::RecordSetGroup RecordSet` Ressource übergeben.

 `IpV6`   <a name="sam-httpapi-route53configuration-ipv6"></a>
Wenn diese Eigenschaft gesetzt ist, wird eine `AWS::Route53::RecordSet` Ressource AWS SAM erstellt und [Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type) `AAAA` für die angegebene Ressource auf gesetzt HostedZone.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

`Region`  <a name="sam-httpapi-route53configuration-region"></a>
*Nur latenzbasierte Ressourcendatensätze:* Die EC2 Amazon-Region, in der Sie die Ressource erstellt haben, auf die sich dieser Ressourcendatensatz bezieht. Bei der Ressource handelt es sich in der Regel um eine AWS Ressource, z. B. eine EC2 Instance oder einen ELB-Load Balancer, auf die je nach Datensatztyp mit einer IP-Adresse oder einem DNS-Domainnamen verwiesen wird.  
Wenn Amazon Route 53 eine DNS-Abfrage für einen Domainnamen und einen Domain-Typ empfängt, für den Sie Latenzressourcendatensätze erstellt haben, wählt Route 53 den Latenzressourcendatensatz aus, der die niedrigste Latenz zwischen dem Endbenutzer und der zugehörigen EC2 Amazon-Region aufweist. Route 53 gibt dann den Wert zurück, der dem ausgewählten Ressourcendatensatz zugeordnet ist.  
Beachten Sie Folgendes:  
+ Sie können nur einen `ResourceRecord` pro Latenz-Ressourcendatensatz angeben.
+ Sie können nur einen Latenzressourcendatensatz für jede EC2 Amazon-Region erstellen.
+ Sie müssen keine Latenzressourcendatensätze für alle EC2 Amazon-Regionen erstellen. Route 53 wählt die Region mit der besten Latenz aus den Regionen aus, für die Sie Latenz-Ressourcendatensätze erstellen.
+ Sie können keine Nicht-Latenz-Ressourcendatensätze erstellen, die die gleichen Werte für die Elemente `Name` und `Type` haben wie Latenz-Ressourcendatensätze.
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ Region](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-region)` Eigenschaft eines `AWS::Route53::RecordSetGroup` `RecordSet` Datentyps übergeben.

`SetIdentifier`  <a name="sam-httpapi-route53configuration-setidentifier"></a>
*Ressourcendatensätze, die eine andere Routing-Richtlinie als "einfach" haben:* Ein Bezeichner, der zwischen mehreren Ressourcendatensätzen unterscheidet, die die gleiche Kombination aus Name und Typ haben, wie beispielsweise mehrere gewichtete Ressourcendatensätze namens acme.example.com, die einen Typ A haben. In einer Gruppe von Ressourcendatensätzen, die den gleichen Namen und Typ haben, muss der Wert von `SetIdentifier` für jeden Ressourcen-Datensatz eindeutig sein.  
Informationen zu Routing-Richtlinien finden Sie unter [Auswahl einer Routing-Richtlinie](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) im *Amazon Route 53-Entwicklerhandbuch*.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ SetIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-setidentifier)` Eigenschaft eines `AWS::Route53::RecordSetGroup` `RecordSet` Datentyps übergeben.

## Beispiele
<a name="sam-property-httpapi-route53configuration--examples"></a>

### Konfigurationsbeispiel für Route 53
<a name="sam-property-httpapi-route53configuration--examples--route-53-configuration-example"></a>

Dieses Beispiel zeigt, wie Route 53 konfiguriert wird.

#### YAML
<a name="sam-property-httpapi-route53configuration--examples--route-53-configuration-example--yaml"></a>

```
Domain:
  DomainName: www.example.com
  CertificateArn: arn-example
  EndpointConfiguration: EDGE
  Route53:
    HostedZoneId: Z1PA6795UKMFR9
    EvaluateTargetHealth: true
    DistributionDomainName: xyz
```

# AWS::Serverless::LayerVersion
<a name="sam-resource-layerversion"></a>

Erzeugt ein Lambda LayerVersion , das Bibliotheks- oder Laufzeitcode enthält, der von einer Lambda-Funktion benötigt wird.

Die [AWS::Serverless::LayerVersion](#sam-resource-layerversion) Ressource unterstützt auch das `Metadata` Ressourcenattribut, sodass Sie anweisen können, Ebenen AWS SAM zu erstellen, die in Ihrer Anwendung enthalten sind. Weitere Informationen zum Erstellen von Layern finden Sie unter[Aufbau von Lambda-Schichten in AWS SAM](building-layers.md).

**Wichtiger Hinweis**: Seit der Veröffentlichung des [UpdateReplacePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html)Ressourcenattributs in CloudFormation bietet [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html)(empfohlen) dieselben Vorteile wie[AWS::Serverless::LayerVersion](#sam-resource-layerversion).

Wenn ein Serverless transformiert LayerVersion wird, transformiert SAM auch die logische ID der Ressource, sodass alte Ressourcen nicht automatisch gelöscht LayerVersions werden, CloudFormation wenn die Ressource aktualisiert wird.

**Anmerkung**  
Bei der Bereitstellung auf werden AWS CloudFormation Ihre AWS SAM Ressourcen in AWS SAM Ressourcen umgewandelt. CloudFormation Weitere Informationen finden Sie unter [Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md).

## Syntax
<a name="sam-resource-layerversion-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-resource-layerversion-syntax.yaml"></a>

```
Type: AWS::Serverless::LayerVersion
Properties:
  [CompatibleArchitectures](#sam-layerversion-compatiblearchitectures): List
  [CompatibleRuntimes](#sam-layerversion-compatibleruntimes): List
  [ContentUri](#sam-layerversion-contenturi): String | LayerContent
  [Description](#sam-layerversion-description): String
  [LayerName](#sam-layerversion-layername): String
  [LicenseInfo](#sam-layerversion-licenseinfo): String
  [PublishLambdaVersion](#sam-layerversion-PublishLambdaVersion): Boolean
  [RetentionPolicy](#sam-layerversion-retentionpolicy): String
```

## Eigenschaften
<a name="sam-resource-layerversion-properties"></a>

 `CompatibleArchitectures`   <a name="sam-layerversion-compatiblearchitectures"></a>
Gibt die unterstützten Befehlssatzarchitekturen für die Layer-Version an.  
Weitere Informationen zu dieser Eigenschaft finden Sie unter [Lambda-Befehlssatzarchitekturen](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) im *AWS Lambda Developer* Guide.  
*Zulässige Werte*: `x86_64`, `arm64`  
*Typ*: Liste  
*Required*: No  
*Standardwert*: `x86_64`  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[CompatibleArchitectures](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-compatiblearchitectures)` Eigenschaft einer `AWS::Lambda::LayerVersion` Ressource übergeben.

 `CompatibleRuntimes`   <a name="sam-layerversion-compatibleruntimes"></a>
Liste der damit kompatiblen Laufzeiten. LayerVersion  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[CompatibleRuntimes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-compatibleruntimes)` Eigenschaft einer `AWS::Lambda::LayerVersion` Ressource übergeben.

 `ContentUri`   <a name="sam-layerversion-contenturi"></a>
Amazon S3 S3-URI, Pfad zum lokalen Ordner oder LayerContent Objekt des Layer-Codes.  
Wenn eine Amazon S3 S3-Uri oder ein Amazon LayerContent S3-Objekt bereitgestellt wird, muss es sich bei dem referenzierten Amazon S3-Objekt um ein gültiges ZIP-Archiv handeln, das den Inhalt einer [Lambda-Schicht](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) enthält.  
Wenn ein Pfad zu einem lokalen Ordner angegeben wird, muss die Vorlage, damit der Inhalt ordnungsgemäß transformiert werden kann, den [sam build](sam-cli-command-reference-sam-build.md) folgenden Workflow durchlaufen: entweder [sam deploy](sam-cli-command-reference-sam-deploy.md) oder[sam package](sam-cli-command-reference-sam-package.md). Standardmäßig werden relative Pfade in Bezug auf den Speicherort der AWS SAM Vorlage aufgelöst.  
*Typ*: Zeichenfolge \$1 [LayerContent](sam-property-layerversion-layercontent.md)  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[Content](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-content)` Eigenschaft einer `AWS::Lambda::LayerVersion` Ressource. Die verschachtelten Amazon S3 S3-Eigenschaften sind unterschiedlich benannt.

 `Description`   <a name="sam-layerversion-description"></a>
Beschreibung dieser Ebene.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-description)` Eigenschaft einer `AWS::Lambda::LayerVersion` Ressource übergeben.

 `LayerName`   <a name="sam-layerversion-layername"></a>
Der Name oder der Amazon-Ressourcenname (ARN) des Layers.  
*Typ:* Zeichenfolge  
*Required*: No  
*Standard*: Logische Ressourcen-ID  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[LayerName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-layername)` Eigenschaft einer `AWS::Lambda::LayerVersion` Ressource. Wenn Sie keinen Namen angeben, wird die logische ID der Ressource als Name verwendet.

 `LicenseInfo`   <a name="sam-layerversion-licenseinfo"></a>
Informationen zur Lizenz dafür LayerVersion.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[LicenseInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-licenseinfo)` Eigenschaft einer `AWS::Lambda::LayerVersion` Ressource übergeben.

 `PublishLambdaVersion`   <a name="sam-layerversion-PublishLambdaVersion"></a>
Eine Opt-in-Eigenschaft, die bei jeder Änderung der referenzierten `LayerVersion` Ressource eine neue Lambda-Version erstellt. Wenn sie mit `AutoPublishAlias` und `AutoPublishAliasAllProperties` in der verbundenen Lambda-Funktion aktiviert ist, wird für jede Änderung an der Ressource eine neue Lambda-Version erstellt. `LayerVersion`  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `RetentionPolicy`   <a name="sam-layerversion-retentionpolicy"></a>
Diese Eigenschaft gibt an, ob alte Versionen von Ihnen `LayerVersion` beibehalten oder gelöscht werden, wenn Sie eine Ressource löschen. Wenn Sie `LayerVersion` beim Aktualisieren oder Ersetzen einer Ressource alte Versionen von Ihrem beibehalten müssen, muss das `UpdateReplacePolicy` Attribut aktiviert sein. Informationen dazu finden Sie unter [`UpdateReplacePolicy`Attribut](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) im *AWS CloudFormation Benutzerhandbuch*.  
*Zulässige Werte*: `Retain` oder `Delete`.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.  
*Zusätzliche Hinweise*: Wenn Sie angeben`Retain`, AWS SAM wird der transformierten `DeletionPolicy: Retain` `AWS::Lambda::LayerVersion` Ressource ein [Ressourcenattribute, unterstützt von AWS SAM](sam-specification-resource-attributes.md) of hinzugefügt.

## Rückgabewerte
<a name="sam-resource-layerversion-return-values"></a>

### Punkt
<a name="sam-resource-layerversion-return-values-ref"></a>

Wenn die logische ID dieser Ressource für die `Ref` intrinsische Funktion bereitgestellt wird, gibt sie den Ressourcen-ARN des zugrunde liegenden Lambda zurück. LayerVersion

*Weitere Informationen zur Verwendung der `Ref` Funktion finden Sie [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)im AWS CloudFormation Benutzerhandbuch.* 

## Beispiele
<a name="sam-resource-layerversion--examples"></a>

### LayerVersionExample
<a name="sam-resource-layerversion--examples--layerversionexample"></a>

Beispiel für ein LayerVersion

#### YAML
<a name="sam-resource-layerversion--examples--layerversionexample--yaml"></a>

```
Properties:
  LayerName: MyLayer
  Description: Layer description
  ContentUri: 's3://sam-s3-demo-bucket/my-layer.zip'
  CompatibleRuntimes:
    - nodejs10.x
    - nodejs12.x
  LicenseInfo: 'Available under the MIT-0 license.'
  RetentionPolicy: Retain
```

# LayerContent
<a name="sam-property-layerversion-layercontent"></a>

Ein ZIP-Archiv, das die Inhalte einer [Lambda-Ebene](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) enthält.

## Syntax
<a name="sam-property-layerversion-layercontent-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-layerversion-layercontent-syntax.yaml"></a>

```
  [Bucket](#sam-layerversion-layercontent-bucket): String
  [Key](#sam-layerversion-layercontent-key): String
  [Version](#sam-layerversion-layercontent-version): String
```

## Eigenschaften
<a name="sam-property-layerversion-layercontent-properties"></a>

 `Bucket`   <a name="sam-layerversion-layercontent-bucket"></a>
Der Amazon S3-Bucket des Layer-Archivs.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[S3Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3bucket)` Eigenschaft des `AWS::Lambda::LayerVersion` `Content` Datentyps übergeben.

 `Key`   <a name="sam-layerversion-layercontent-key"></a>
Der Amazon S3-Schlüssel des Layer-Archivs.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[S3Key](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3key)` Eigenschaft des `AWS::Lambda::LayerVersion` `Content` Datentyps übergeben.

 `Version`   <a name="sam-layerversion-layercontent-version"></a>
Für versionierte Objekte, die Version des zu verwendenden Layer-Archiv-Objekts.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[S3ObjectVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3objectversion)` Eigenschaft des `AWS::Lambda::LayerVersion` `Content` Datentyps übergeben.

## Beispiele
<a name="sam-property-layerversion-layercontent--examples"></a>

### LayerContent
<a name="sam-property-layerversion-layercontent--examples--layercontent"></a>

Beispiel für Ebeneninhalt

#### YAML
<a name="sam-property-layerversion-layercontent--examples--layercontent--yaml"></a>

```
LayerContent:
  Bucket: amzn-s3-demo-bucket-name
  Key: mykey-name
  Version: 121212
```

# AWS::Serverless::SimpleTable
<a name="sam-resource-simpletable"></a>

Erstellt eine DynamoDB-Tabelle mit einem einzelnen Attribut-Primärschlüssel. Dies ist nützlich, wenn auf Daten nur über einen Primärschlüssel zugegriffen werden muss.

Für erweiterte Funktionen verwenden Sie eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html)Ressource in CloudFormation. Diese Ressourcen können in verwendet werden. AWS SAM Sie sind umfassend und ermöglichen weitere Anpassungen, einschließlich [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html)Anpassungen. [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-resourcepolicy.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-resourcepolicy.html)

**Anmerkung**  
Bei der Bereitstellung von AWS CloudFormation werden Ihre AWS SAM Ressourcen in AWS SAM CloudFormation Ressourcen umgewandelt. Weitere Informationen finden Sie unter [Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md).

## Syntax
<a name="sam-resource-simpletable-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-resource-simpletable-syntax.yaml"></a>

```
Type: AWS::Serverless::SimpleTable
Properties:
  PointInTimeRecoverySpecification: [PointInTimeRecoverySpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-pointintimerecoveryspecification.html)
  [PrimaryKey](#sam-simpletable-primarykey): PrimaryKeyObject
  [ProvisionedThroughput](#sam-simpletable-provisionedthroughput): ProvisionedThroughputObject
  [SSESpecification](#sam-simpletable-ssespecification): [SSESpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html)
  [TableName](#sam-simpletable-tablename): String
  [Tags](#sam-simpletable-tags): Map
```

## Eigenschaften
<a name="sam-resource-simpletable-properties"></a>

 `PointInTimeRecoverySpecification`   <a name="sam-simpletable-pointintimerecoveryspecification"></a>
Die Einstellungen, die zum Aktivieren der zeitpunktbezogenen Wiederherstellung verwendet werden.  
*Geben Sie ein*: [PointInTimeRecoverySpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-pointintimerecoveryspecification.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[PointInTimeRecoverySpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-pointintimerecoveryspecification.html)` Eigenschaft einer `AWS::DynamoDB::Table` Ressource übergeben.

 `PrimaryKey`   <a name="sam-simpletable-primarykey"></a>
Name und Typ des Attributs, die als Primärschlüssel der Tabelle verwendet werden sollen. Wenn nicht angegeben, ist der Primärschlüssel a `String` mit dem Wert`id`.  
Der Wert dieser Eigenschaft kann nicht geändert werden, nachdem diese Ressource erstellt wurde.
*Typ:* [PrimaryKeyObject](sam-property-simpletable-primarykeyobject.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `ProvisionedThroughput`   <a name="sam-simpletable-provisionedthroughput"></a>
Lesen und Schreiben von Informationen zur Durchsatzbereitstellung.  
Falls `ProvisionedThroughput` nicht angegeben, `BillingMode` wird als `PAY_PER_REQUEST` angegeben.  
*Typ:* [ProvisionedThroughputObject](sam-property-simpletable-provisionedthroughputobject.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-provisionedthroughput.html)` Eigenschaft einer `AWS::DynamoDB::Table` Ressource übergeben.

 `SSESpecification`   <a name="sam-simpletable-ssespecification"></a>
Gibt die Einstellungen zum Aktivieren der serverseitigen Verschlüsselung an.  
*Typ:* [SSESpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[SSESpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html)` Eigenschaft einer `AWS::DynamoDB::Table` Ressource übergeben.

 `TableName`   <a name="sam-simpletable-tablename"></a>
Name für die DynamoDB-Tabelle.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[TableName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tablename)` Eigenschaft einer `AWS::DynamoDB::Table` Ressource übergeben.

 `Tags`   <a name="sam-simpletable-tags"></a>
Eine Zuordnung (von Zeichenfolge zu Zeichenfolge), die die Tags angibt, die dieser hinzugefügt werden sollen SimpleTable. Einzelheiten zu gültigen Schlüsseln und Werten für Tags finden Sie unter [Resource-Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) im *AWS CloudFormation Benutzerhandbuch*.  
*Typ*: Karte  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tags)` Eigenschaft einer `AWS::DynamoDB::Table` Ressource. Die Tags-Eigenschaft in SAM besteht aus Key:Value-Paaren; darin besteht CloudFormation sie aus einer Liste von Tag-Objekten.

## Rückgabewerte
<a name="sam-resource-simpletable-return-values"></a>

### Punkt
<a name="sam-resource-simpletable-return-values-ref"></a>

Wenn die logische ID dieser Ressource für die intrinsische Funktion Ref bereitgestellt wird, gibt sie den Ressourcennamen der zugrunde liegenden DynamoDB-Tabelle zurück.

*Weitere Informationen zur Verwendung der `Ref` Funktion finden Sie [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)im Benutzerhandbuch.AWS CloudFormation * 

## Beispiele
<a name="sam-resource-simpletable--examples"></a>

### SimpleTableExample
<a name="sam-resource-simpletable--examples--simpletableexample"></a>

Beispiel für ein SimpleTable

#### YAML
<a name="sam-resource-simpletable--examples--simpletableexample--yaml"></a>

```
Properties:
  TableName: my-table
  PrimaryKey:
    Name: MyPrimaryKey
    Type: String
  ProvisionedThroughput:
    ReadCapacityUnits: 5
    WriteCapacityUnits: 5
  Tags:
    Department: Engineering
    AppType: Serverless
```

# PrimaryKeyObject
<a name="sam-property-simpletable-primarykeyobject"></a>

Das Objekt, das die Eigenschaften eines Primärschlüssels beschreibt.

## Syntax
<a name="sam-property-simpletable-primarykeyobject-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-simpletable-primarykeyobject-syntax.yaml"></a>

```
  [Name](#sam-simpletable-primarykeyobject-name): String
  [Type](#sam-simpletable-primarykeyobject-type): String
```

## Eigenschaften
<a name="sam-property-simpletable-primarykeyobject-properties"></a>

 `Name`   <a name="sam-simpletable-primarykeyobject-name"></a>
Attributname des Primärschlüssels.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[AttributeName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-attributedef.html#cfn-dynamodb-attributedef-attributename)` Eigenschaft des `AWS::DynamoDB::Table` `AttributeDefinition` Datentyps übergeben.  
*Zusätzliche Hinweise*: Diese Eigenschaft wird auch an die [AttributeName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html#aws-properties-dynamodb-keyschema-attributename)Eigenschaft eines `AWS::DynamoDB::Table KeySchema` Datentyps übergeben.

 `Type`   <a name="sam-simpletable-primarykeyobject-type"></a>
Der Datentyp für den Primärschlüssel.  
*Gültige Werte*:`String`,`Number`, `Binary`  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[AttributeType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-attributedef.html#cfn-dynamodb-attributedef-attributename-attributetype)` Eigenschaft des `AWS::DynamoDB::Table` `AttributeDefinition` Datentyps übergeben.

## Beispiele
<a name="sam-property-simpletable-primarykeyobject--examples"></a>

### PrimaryKey
<a name="sam-property-simpletable-primarykeyobject--examples--primarykey"></a>

Beispiel für einen Primärschlüssel.

#### YAML
<a name="sam-property-simpletable-primarykeyobject--examples--primarykey--yaml"></a>

```
Properties:
  PrimaryKey:
    Name: MyPrimaryKey
    Type: String
```

# ProvisionedThroughputObject
<a name="sam-property-simpletable-provisionedthroughputobject"></a>

Das Objekt, das die Eigenschaften eines bereitgestellten Durchsatzes beschreibt.

## Syntax
<a name="sam-property-simpletable-provisionedthroughputobject-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="w2aac13c22c41c19b5b5"></a>

```
  [ReadCapacityUnits](#sam-simpletable-provisionedthroughputobject-readcapacityunits): Integer
  [WriteCapacityUnits](#sam-simpletable-provisionedthroughputobject-writecapacityunits): Integer
```

## Eigenschaften
<a name="sam-property-simpletable-provisionedthroughputobject-properties"></a>

 `ReadCapacityUnits`   <a name="sam-simpletable-provisionedthroughputobject-readcapacityunits"></a>
Die maximale Anzahl der Strongly Consistent-Lesevorgänge, die pro Sekunde verbraucht werden, bevor DynamoDB eine `ThrottlingException` zurückgibt.  
*Typ*: Ganzzahl  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ReadCapacityUnits](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-provisionedthroughput.html#aws-properties-dynamodb-table-provisionedthroughput-properties)` Eigenschaft des `AWS::DynamoDB::Table` `ProvisionedThroughput` Datentyps übergeben.

 `WriteCapacityUnits`   <a name="sam-simpletable-provisionedthroughputobject-writecapacityunits"></a>
Die maximale Anzahl der Schreibvorgänge, die pro Sekunde verbraucht werden, bevor DynamoDB eine `ThrottlingException` zurückgibt.  
*Typ*: Ganzzahl  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[WriteCapacityUnits](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-provisionedthroughput.html#aws-properties-dynamodb-table-provisionedthroughput-properties)` Eigenschaft des `AWS::DynamoDB::Table` `ProvisionedThroughput` Datentyps übergeben.

## Beispiele
<a name="sam-property-simpletable-provisionedthroughputobject--examples"></a>

### ProvisionedThroughput
<a name="sam-property-simpletable-provisionedthroughputobject--examples--provisionedthroughput"></a>

Beispiel für einen bereitgestellten Durchsatz.

#### YAML
<a name="sam-property-simpletable-provisionedthroughputobject--examples--provisionedthroughput--yaml"></a>

```
Properties:
   ProvisionedThroughput:
     ReadCapacityUnits: 5
     WriteCapacityUnits: 5
```

# AWS::Serverless::StateMachine
<a name="sam-resource-statemachine"></a>

Erstellt eine AWS Step Functions Zustandsmaschine, mit der Sie AWS Lambda Funktionen und andere AWS Ressourcen orchestrieren können, um komplexe und robuste Workflows zu bilden.

Weitere Informationen zu Step Functions finden Sie im [AWS Step Functions Developer Guide](https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html).

**Anmerkung**  
Bei der Bereitstellung werden AWS CloudFormation Ihre AWS SAM Ressourcen in Ressourcen umgewandelt CloudFormation . AWS SAM Weitere Informationen finden Sie unter [Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md).

## Syntax
<a name="sam-resource-statemachine-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS Serverless Application Model (AWS SAM) -Vorlage zu deklarieren.

### YAML
<a name="sam-resource-statemachine-syntax.yaml"></a>

```
Type: AWS::Serverless::StateMachine
Properties:
  AutoPublishAlias: String
  UseAliasAsEventTarget: Boolean
  [Definition](#sam-statemachine-definition): Map
  [DefinitionSubstitutions](#sam-statemachine-definitionsubstitutions): Map
  [DefinitionUri](#sam-statemachine-definitionuri): String | [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitions3location)
  DeploymentPreference: [DeploymentPreference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html)
  [Events](#sam-statemachine-events): EventSource
  [Logging](#sam-statemachine-logging): [LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration)
  [Name](#sam-statemachine-name): String
  [PermissionsBoundary](#sam-statemachine-permissionsboundary): String
  [Policies](#sam-statemachine-policies): String | List | Map
  PropagateTags: Boolean
  [RolePath](#sam-statemachine-rolepath): String
  [Role](#sam-statemachine-role): String
  [Tags](#sam-statemachine-tags): Map
  [Tracing](#sam-statemachine-tracing): [TracingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tracingconfiguration)
  [Type](#sam-statemachine-type): String
```

## Eigenschaften
<a name="sam-resource-statemachine-properties"></a>

 `AutoPublishAlias`   <a name="sam-statemachine-autopublishalias"></a>
Der Name des Alias für die Zustandsmaschine. *Weitere Informationen zur Verwendung von Step Functions Functions-Zustandsmaschinenaliasen finden Sie unter [Manage Continuous Deployments with versions and aliases im AWS Step Functions Developer](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-cd-aliasing-versioning.html) Guide.*  
Wird verwendet`DeploymentPreference`, um die Bereitstellungseinstellungen für Ihren Alias zu konfigurieren. Wenn Sie nichts angeben`DeploymentPreference`, AWS SAM wird der Datenverkehr so konfiguriert, dass er auf einmal zur neueren State-Machine-Version wechselt.  
AWS SAM legt `Retain` standardmäßig die Version `DeletionPolicy` und `UpdateReplacePolicy` auf fest. Frühere Versionen werden nicht automatisch gelöscht.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die ` [ Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.html#cfn-stepfunctions-statemachinealias-name)` Eigenschaft einer `AWS::StepFunctions::StateMachineAlias` Ressource übergeben.

 `UseAliasAsEventTarget`   <a name="sam-statemachine-usealiasaseventtarget"></a>
[Geben Sie an, ob der mit der `AutoPublishAlias` Eigenschaft erstellte Alias an das mit Events definierte Ziel der Ereignisquelle übergeben werden soll oder nicht.](#sam-statemachine-events)  
Geben Sie `True` an, dass der Alias als Ziel der Ereignisse verwendet werden soll.  
*Typ*: Boolesch  
*Required*: No  
*Standardwert*: `False`  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Definition`   <a name="sam-statemachine-definition"></a>
Die State-Machine-Definition ist ein Objekt, bei dem das Format des Objekts dem Format Ihrer AWS SAM Vorlagendatei entspricht, z. B. JSON oder YAML. State Machine-Definitionen halten sich an die [Amazon States Language](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html).  
Ein Beispiel für eine Inline-State-Machine-Definition finden Sie unter[Beispiele](#sam-resource-statemachine--examples).  
Sie müssen entweder a `Definition` oder a angeben`DefinitionUri`.  
*Typ*: Karte  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `DefinitionSubstitutions`   <a name="sam-statemachine-definitionsubstitutions"></a>
Eine string-to-string Map, die die Zuordnungen für Platzhaltervariablen in der State-Machine-Definition spezifiziert. Auf diese Weise können Sie Werte, die Sie zur Laufzeit erhalten haben (z. B. aus systeminternen Funktionen), in die Zustandsmaschinen-Definition einfügen.  
*Typ: Karte*  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[DefinitionSubstitutions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitionsubstitutions)` Eigenschaft einer `AWS::StepFunctions::StateMachine` Ressource. Wenn in einer Inline-State-Machine-Definition irgendwelche systemeigenen Funktionen angegeben sind, AWS SAM fügt dieser Eigenschaft Einträge hinzu, um sie in die Zustandsmaschinen-Definition einzufügen.

 `DefinitionUri`   <a name="sam-statemachine-definitionuri"></a>
Die Amazon Simple Storage Service (Amazon S3) -URI oder der lokale Dateipfad der Zustandsmaschinen-Definition, geschrieben in der [Sprache Amazon States](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html).  
Wenn Sie einen lokalen Dateipfad angeben, muss die Vorlage den Workflow durchlaufen, der den `sam package` Befehl `sam deploy` or enthält, um die Definition korrekt zu transformieren. Dazu müssen Sie Version 0.52.0 oder höher der AWS SAM CLI verwenden.  
Sie müssen entweder a `Definition` oder a `DefinitionUri` angeben.  
*Typ*: Zeichenfolge \$1 [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitions3location)  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[DefinitionS3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitions3location)` Eigenschaft einer `AWS::StepFunctions::StateMachine` Ressource übergeben.

 `DeploymentPreference`   <a name="sam-statemachine-deploymentpreference"></a>
Die Einstellungen, die die schrittweise Bereitstellung von Zustandsmaschinen ermöglichen und konfigurieren. *Weitere Informationen zu schrittweisen Bereitstellungen von Step Functions finden Sie unter [Manage Continuous Deployments with versions and aliases im AWS Step Functions Developer](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-cd-aliasing-versioning.html) Guide.*  
Geben Sie dies an, `AutoPublishAlias` bevor Sie diese Eigenschaft konfigurieren. Ihre `DeploymentPreference` Einstellungen werden auf den mit angegebenen Alias angewendet`AutoPublishAlias`.  
Wenn Sie angeben`DeploymentPreference`, AWS SAM wird der Wert der `StateMachineVersionArn` Untereigenschaft automatisch generiert.  
*Typ:* [DeploymentPreference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html)  
*Required*: No  
*CloudFormation Kompatibilität*: AWS SAM generiert den `StateMachineVersionArn` Eigenschaftswert, hängt ihn an `DeploymentPreference` und leitet ihn `DeploymentPreference` an die `[DeploymentPreference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.html#cfn-stepfunctions-statemachinealias-deploymentpreference)` Eigenschaft einer `AWS::StepFunctions::StateMachineAlias` Ressource weiter. 

 `Events`   <a name="sam-statemachine-events"></a>
Gibt die Ereignisse an, die diese Zustandsmaschine auslösen. Ereignisse bestehen aus einem Typ und einer Reihe von Eigenschaften, die vom Typ abhängen.  
*Typ:* [EventSource](sam-property-statemachine-statemachineeventsource.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Logging`   <a name="sam-statemachine-logging"></a>
Definiert, welche Ereignisse im Ausführungsverlauf protokolliert werden und wo sie protokolliert werden.  
*Typ:* [LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration)` Eigenschaft einer `AWS::StepFunctions::StateMachine` Ressource übergeben.

 `Name`   <a name="sam-statemachine-name"></a>
Der Name des Zustandsautomaten.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[StateMachineName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinename)` Eigenschaft einer `AWS::StepFunctions::StateMachine` Ressource übergeben.

 `PermissionsBoundary`   <a name="sam-statemachine-permissionsboundary"></a>
Der ARN einer Berechtigungsgrenze, die für die Ausführungsrolle dieser Zustandsmaschine verwendet werden soll. Diese Eigenschaft funktioniert nur, wenn die Rolle für Sie generiert wurde.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[PermissionsBoundary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary)` Eigenschaft einer `AWS::IAM::Role` Ressource übergeben.

 `Policies`   <a name="sam-statemachine-policies"></a>
Berechtigungsrichtlinien für diesen Zustandsmaschine. Richtlinien werden an die standardmäßige Ausführungsrolle AWS Identity and Access Management (IAM) des Zustandsmaschinen angehängt.  
Diese Eigenschaft akzeptiert einen einzelnen Wert oder eine Liste von Werten. Gültige Werte sind:  
+ [AWS SAM Richtlinienvorlagen](serverless-policy-templates.md).
+ Die ARN einer [AWS verwalteten Richtlinie](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#aws-managed-policies) oder einer vom [Kunden verwalteten Richtlinie](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#customer-managed-policies).
+ Der Name einer AWS verwalteten Richtlinie aus der folgenden [Liste](https://github.com/aws/serverless-application-model/blob/develop/samtranslator/internal/data/aws_managed_policies.json).
+ Eine [Inline-IAM-Richtlinie](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#inline-policies), die YAML als Map formatiert ist.
Wenn Sie die `Role` Eigenschaft festlegen, wird diese Eigenschaft ignoriert.
*Typ*: Zeichenfolge \$1 Liste \$1 Karte  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

`PropagateTags`  <a name="sam-statemachine-propagatetags"></a>
Geben Sie an, ob Tags von der `Tags` Eigenschaft an Ihre [AWS::Serverless::StateMachine](sam-specification-generated-resources-statemachine.md) generierten Ressourcen weitergegeben werden sollen oder nicht. Geben Sie `True` an, dass Tags in Ihren generierten Ressourcen verbreitet werden sollen.  
*Typ*: Boolesch  
*Required*: No  
*Standardwert*: `False`  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Role`   <a name="sam-statemachine-role"></a>
Der ARN einer IAM-Rolle, die als Ausführungsrolle dieser Zustandsmaschine verwendet werden soll.  
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-rolearn)` Eigenschaft einer `AWS::StepFunctions::StateMachine` Ressource übergeben.

 `RolePath`   <a name="sam-statemachine-rolepath"></a>
Der Pfad zur IAM-Ausführungsrolle der Zustandsmaschine.  
Verwenden Sie diese Eigenschaft, wenn die Rolle für Sie generiert wird. Nicht verwenden, wenn die Rolle mit der `Role` Eigenschaft angegeben ist.  
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Path](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-path)` Eigenschaft einer `AWS::IAM::Role` Ressource übergeben.

 `Tags`   <a name="sam-statemachine-tags"></a>
Eine string-to-string Map, die die zur Zustandsmaschine hinzugefügten Tags und die entsprechende Ausführungsrolle angibt. Informationen zu gültigen Schlüsseln und Werten für Tags finden Sie in der [Tags-Eigenschaft](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tags) einer [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html)Ressource.  
*Typ*: Karte  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tags)` Eigenschaft einer `AWS::StepFunctions::StateMachine` Ressource. AWS SAM fügt dieser Ressource und der dafür generierten Standardrolle automatisch ein `stateMachine:createdBy:SAM` Tag hinzu.

 `Tracing`   <a name="sam-statemachine-tracing"></a>
Wählt aus, ob sie für die Zustandsmaschine aktiviert AWS X-Ray ist oder nicht. Weitere Informationen zur Verwendung von X-Ray mit Step Functions finden Sie unter [AWS X-Ray und Step Functions](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-xray-tracing.html) im *AWS Step Functions Entwicklerhandbuch*.  
*Typ:* [TracingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tracingconfiguration)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[TracingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tracingconfiguration)` Eigenschaft einer `AWS::StepFunctions::StateMachine` Ressource übergeben.

 `Type`   <a name="sam-statemachine-type"></a>
Der Typ der Zustandsmaschine.  
*Zulässige Werte*: `STANDARD` oder `EXPRESS`.  
*Typ:* Zeichenfolge  
*Required*: No  
*Standardwert*: `STANDARD`  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[StateMachineType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinetype)` Eigenschaft einer `AWS::StepFunctions::StateMachine` Ressource übergeben.

## Rückgabewerte
<a name="sam-resource-statemachine-return-values"></a>

### Punkt
<a name="sam-resource-statemachine-return-values-ref"></a>

Wenn Sie die logische ID dieser Ressource für die intrinsische Funktion Ref angeben, gibt Ref den Amazon-Ressourcennamen (ARN) der zugrunde liegenden `AWS::StepFunctions::StateMachine` Ressource zurück.

Weitere Informationen zur Verwendung der `Ref` Funktion finden Sie [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)im *AWS CloudFormation Benutzerhandbuch*. 

### Fn:: GetAtt
<a name="sam-resource-statemachine-return-values-fn--getatt"></a>

`Fn::GetAtt` gibt einen Wert für ein angegebenes Attribut dieses Typs zurück. Im Folgenden sehen Sie die verfügbaren Attribute und Beispielrückgabewerte. 

Weitere Informationen zur Verwendung `Fn::GetAtt` finden Sie [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html)im *AWS CloudFormation Benutzerhandbuch*. 

`Name`  <a name="Name-fn::getatt"></a>
Gibt den Namen der Zustandsmaschine zurück, z. `HelloWorld-StateMachine` B.

## Beispiele
<a name="sam-resource-statemachine--examples"></a>

### Definitionsdatei für Zustandsmaschinen
<a name="sam-resource-statemachine--examples--state-machine-definition-file"></a>

Im Folgenden finden Sie ein Beispiel für eine Inline-State-Machine-Definition, die es einer Lambda-Funktion ermöglicht, eine Zustandsmaschine aufzurufen. Beachten Sie, dass in diesem Beispiel davon ausgegangen wird, dass die `Role` Eigenschaft die richtige Richtlinie konfiguriert, um den Aufruf zu ermöglichen. Die `my_state_machine.asl.json` Datei muss in der [Sprache der Amazonas-Staaten](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) verfasst sein.

In diesem Beispiel ermöglichen die `DefinitionSubstitution` Einträge der Zustandsmaschine, Ressourcen einzubeziehen, die in der AWS SAM Vorlagendatei deklariert sind.

#### YAML
<a name="sam-resource-statemachine--examples--state-machine-definition-file--yaml"></a>

```
MySampleStateMachine:
  Type: AWS::Serverless::StateMachine
  Properties:
    DefinitionUri: statemachine/my_state_machine.asl.json
    Role: arn:aws:iam::123456123456:role/service-role/my-sample-role
    Tracing:
      Enabled: true
    DefinitionSubstitutions:
      MyFunctionArn: !GetAtt MyFunction.Arn
      MyDDBTable: !Ref TransactionTable
```

### Definition von Inline-Zustandsmaschinen
<a name="sam-resource-statemachine--examples--inline-state-machine-definition"></a>

Im Folgenden finden Sie ein Beispiel für eine Inline-State-Machine-Definition.

In diesem Beispiel ist die AWS SAM Vorlagendatei in YAML geschrieben, sodass die Zustandsmaschinen-Definition auch in YAML geschrieben ist. Um eine Inline-State-Machine-Definition in JSON zu deklarieren, schreiben Sie Ihre AWS SAM Vorlagendatei in JSON.

#### YAML
<a name="sam-resource-statemachine--examples--inline-state-machine-definition--yaml"></a>

```
MySampleStateMachine:
  Type: AWS::Serverless::StateMachine
  Properties:
    Definition:
      StartAt: MyLambdaState
      States:
        MyLambdaState:
          Type: Task
          Resource: arn:aws:lambda:us-east-1:123456123456:function:my-sample-lambda-app
          End: true
    Role: arn:aws:iam::123456123456:role/service-role/my-sample-role
    Tracing:
      Enabled: true
```

# EventSource
<a name="sam-property-statemachine-statemachineeventsource"></a>

Das Objekt, das die Quelle der Ereignisse beschreibt, die die Zustandsmaschine auslösen. Jedes Ereignis besteht aus einem Typ und einer Reihe von Eigenschaften, die von diesem Typ abhängen. Weitere Informationen zu den Eigenschaften der einzelnen Ereignisquellen finden Sie in dem Unterthema zum jeweiligen Typ.

## Syntax
<a name="sam-property-statemachine-statemachineeventsource-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-statemachine-statemachineeventsource-syntax.yaml"></a>

```
  [Properties](#sam-statemachine-statemachineeventsource-properties): Schedule | ScheduleV2 | CloudWatchEvent | EventBridgeRule | Api
  [Type](#sam-statemachine-statemachineeventsource-type): String
```

## Eigenschaften
<a name="sam-property-statemachine-statemachineeventsource-properties"></a>

 `Properties`   <a name="sam-statemachine-statemachineeventsource-properties"></a>
Ein Objekt, das die Eigenschaften dieser Event-Mapping beschreibt. Der Satz von Eigenschaften muss den definierten `Type` entsprechen.  
*Typ*[: [Schedule](sam-property-statemachine-statemachineschedule.md) \$1 [ScheduleV2 \$1 \$1 \$1 Api [CloudWatchEvent[EventBridgeRule](sam-property-statemachine-statemachineeventbridgerule.md)](sam-property-statemachine-statemachinecloudwatchevent.md)](sam-property-statemachine-statemachineschedulev2.md)](sam-property-statemachine-statemachineapi.md)  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Type`   <a name="sam-statemachine-statemachineeventsource-type"></a>
Der Ereignistyp.  
*Gültige Werte*:`Api`,`Schedule`,`ScheduleV2`,`CloudWatchEvent`, `EventBridgeRule`  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-statemachine-statemachineeventsource--examples"></a>

### API
<a name="sam-property-statemachine-statemachineeventsource--examples--api"></a>

Das Folgende ist ein Beispiel für ein Ereignis dieses `API` Typs.

#### YAML
<a name="sam-property-statemachine-statemachineeventsource--examples--api--yaml"></a>

```
ApiEvent:
  Type: Api
  Properties:
    Method: get
    Path: /group/{user}
    RestApiId: 
      Ref: MyApi
```

# Api
<a name="sam-property-statemachine-statemachineapi"></a>

Das Objekt, das einen `Api` Ereignisquellentyp beschreibt. Wenn eine [AWS::Serverless::Api](sam-resource-api.md) Ressource definiert ist, müssen der Pfad und die Methodenwerte einer Operation in der OpenAPI-Definition der API entsprechen. 

## Syntax
<a name="sam-property-statemachine-statemachineapi-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-statemachine-statemachineapi-syntax.yaml"></a>

```
  [Auth](#sam-statemachine-statemachineapi-auth): ApiStateMachineAuth
  [Method](#sam-statemachine-statemachineapi-method): String
  [Path](#sam-statemachine-statemachineapi-path): String
  [RestApiId](#sam-statemachine-statemachineapi-restapiid): String
  UnescapeMappingTemplate: Boolean
```

## Eigenschaften
<a name="sam-property-statemachine-statemachineapi-properties"></a>

 `Auth`   <a name="sam-statemachine-statemachineapi-auth"></a>
Die Autorisierungskonfiguration für diese API, diesen Pfad und diese Methode.  
Verwenden Sie diese Eigenschaft, um die `DefaultAuthorizer` API-Einstellung für einen einzelnen Pfad zu überschreiben, wenn kein Pfad angegeben `DefaultAuthorizer` ist, oder um die `ApiKeyRequired` Standardeinstellung zu überschreiben.  
*Typ:* [ApiStateMachineAuth](sam-property-statemachine-apistatemachineauth.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Method`   <a name="sam-statemachine-statemachineapi-method"></a>
Die HTTP-Methode, für die diese Funktion aufgerufen wird.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Path`   <a name="sam-statemachine-statemachineapi-path"></a>
Der URI-Pfad, für den diese Funktion aufgerufen wird. Der Wert muss mit `/` beginnen.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `RestApiId`   <a name="sam-statemachine-statemachineapi-restapiid"></a>
Der Bezeichner einer `RestApi` Ressource, die eine Operation mit dem angegebenen Pfad und der angegebenen Methode enthalten muss. In der Regel ist dies so eingestellt, dass es auf eine [AWS::Serverless::Api](sam-resource-api.md) Ressource verweist, die in dieser Vorlage definiert ist.  
Wenn Sie diese Eigenschaft nicht definieren, AWS SAM wird mithilfe eines generierten `OpenApi` Dokuments eine [AWS::Serverless::Api](sam-resource-api.md) Standardressource erstellt. Diese Ressource enthält eine Vereinigung aller Pfade und Methoden, die durch `Api` Ereignisse in derselben Vorlage definiert wurden, ohne dass a angegeben ist`RestApiId`.  
Diese Eigenschaft kann nicht auf eine [AWS::Serverless::Api](sam-resource-api.md) Ressource verweisen, die in einer anderen Vorlage definiert ist.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `UnescapeMappingTemplate`   <a name="sam-statemachine-statemachineapi-unescapemappingtemplate"></a>
Macht einfache Anführungszeichen rückgängig, indem sie `\'` bei der Eingabe`'`, die an die Zustandsmaschine übergeben wird, durch ersetzt werden. Wird verwendet, wenn Ihre Eingabe einfache Anführungszeichen enthält.  
Wenn dieser Wert auf gesetzt ist `False` und Ihre Eingabe einfache Anführungszeichen enthält, tritt ein Fehler auf.
*Typ*: Boolesch  
*Required*: No  
*Standard*: False  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-statemachine-statemachineapi--examples"></a>

### ApiEvent
<a name="sam-property-statemachine-statemachineapi--examples--apievent"></a>

Das Folgende ist ein Beispiel für ein Ereignis dieses `Api` Typs.

#### YAML
<a name="sam-property-statemachine-statemachineapi--examples--apievent--yaml"></a>

```
Events:
  ApiEvent:
    Type: Api
    Properties:
      Path: /path
      Method: get
```

# ApiStateMachineAuth
<a name="sam-property-statemachine-apistatemachineauth"></a>

Konfiguriert die Autorisierung auf Ereignisebene für eine bestimmte API, einen bestimmten Pfad und eine Methode.

## Syntax
<a name="sam-property-statemachine-apistatemachineauth-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer AWS Serverless Application Model (AWS SAM) -Vorlage zu deklarieren.

### YAML
<a name="sam-property-statemachine-apistatemachineauth-syntax.yaml"></a>

```
  [ApiKeyRequired](#sam-statemachine-apistatemachineauth-apikeyrequired): Boolean
  [AuthorizationScopes](#sam-statemachine-apistatemachineauth-authorizationscopes): List
  [Authorizer](#sam-statemachine-apistatemachineauth-authorizer): String
  [ResourcePolicy](#sam-statemachine-apistatemachineauth-resourcepolicy): ResourcePolicyStatement
```

## Eigenschaften
<a name="sam-property-statemachine-apistatemachineauth-properties"></a>

 `ApiKeyRequired`   <a name="sam-statemachine-apistatemachineauth-apikeyrequired"></a>
Erfordert einen API-Schlüssel für diese API, diesen Pfad und diese Methode.  
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `AuthorizationScopes`   <a name="sam-statemachine-apistatemachineauth-authorizationscopes"></a>
Die Autorisierungsbereiche, die für diese API, diesen Pfad und diese Methode gelten sollen.  
Die von Ihnen angegebenen Bereiche haben Vorrang vor allen Bereichen, die von der `DefaultAuthorizer` Eigenschaft angewendet werden, sofern Sie sie angegeben haben.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Authorizer`   <a name="sam-statemachine-apistatemachineauth-authorizer"></a>
Die `Authorizer` für eine bestimmte Zustandsmaschine.  
Wenn Sie einen globalen Autorisierer für die API angegeben haben und diesen Zustandsmaschine öffentlich machen möchten, überschreiben Sie den globalen Autorisierer, indem Sie auf setzen`Authorizer`. `NONE`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `ResourcePolicy`   <a name="sam-statemachine-apistatemachineauth-resourcepolicy"></a>
Konfigurieren Sie die Ressourcenrichtlinie für diese API und diesen Pfad.  
*Typ:* [ResourcePolicyStatement](sam-property-statemachine-resourcepolicystatement.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-statemachine-apistatemachineauth--examples"></a>

### StateMachine-Authentifizierung
<a name="sam-property-statemachine-apistatemachineauth--examples--statemachine-auth"></a>

Das folgende Beispiel spezifiziert die Autorisierung auf State-Machine-Ebene.

#### YAML
<a name="sam-property-statemachine-apistatemachineauth--examples--statemachine-auth--yaml"></a>

```
Auth:
  ApiKeyRequired: true
  Authorizer: NONE
```

# ResourcePolicyStatement
<a name="sam-property-statemachine-resourcepolicystatement"></a>

Konfiguriert eine Ressourcenrichtlinie für alle Methoden und Pfade einer API. Weitere Informationen zu Ressourcenrichtlinien finden Sie unter [Steuern des Zugriffs auf eine API mit API-Gateway-Ressourcenrichtlinien](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies.html) im *API Gateway Developer Guide*.

## Syntax
<a name="sam-property-statemachine-resourcepolicystatement-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-statemachine-resourcepolicystatement-syntax.yaml"></a>

```
  [AwsAccountBlacklist](#sam-statemachine-resourcepolicystatement-awsaccountblacklist): List
  [AwsAccountWhitelist](#sam-statemachine-resourcepolicystatement-awsaccountwhitelist): List
  [CustomStatements](#sam-statemachine-resourcepolicystatement-customstatements): List
  [IntrinsicVpcBlacklist](#sam-statemachine-resourcepolicystatement-intrinsicvpcblacklist): List
  [IntrinsicVpcWhitelist](#sam-statemachine-resourcepolicystatement-intrinsicvpcwhitelist): List
  [IntrinsicVpceBlacklist](#sam-statemachine-resourcepolicystatement-intrinsicvpceblacklist): List
  [IntrinsicVpceWhitelist](#sam-statemachine-resourcepolicystatement-intrinsicvpcewhitelist): List
  [IpRangeBlacklist](#sam-statemachine-resourcepolicystatement-iprangeblacklist): List
  [IpRangeWhitelist](#sam-statemachine-resourcepolicystatement-iprangewhitelist): List
  [SourceVpcBlacklist](#sam-statemachine-resourcepolicystatement-sourcevpcblacklist): List
  [SourceVpcWhitelist](#sam-statemachine-resourcepolicystatement-sourcevpcwhitelist): List
```

## Eigenschaften
<a name="sam-property-statemachine-resourcepolicystatement-properties"></a>

 `AwsAccountBlacklist`   <a name="sam-statemachine-resourcepolicystatement-awsaccountblacklist"></a>
Die zu sperrenden AWS Konten.  
*Typ*: Liste von Zeichenfolgen  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig AWS SAM und hat kein CloudFormation Äquivalent.

 `AwsAccountWhitelist`   <a name="sam-statemachine-resourcepolicystatement-awsaccountwhitelist"></a>
Die AWS Konten, die zugelassen werden sollen. Ein Beispiel für die Verwendung dieser Eigenschaft finden Sie im Abschnitt Beispiele unten auf dieser Seite.  
*Typ*: Liste von Zeichenfolgen  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `CustomStatements`   <a name="sam-statemachine-resourcepolicystatement-customstatements"></a>
Eine Liste von benutzerdefinierten Ressourcenrichtlinien-Anweisungen, die auf diese API angewendet werden sollen. Ein Beispiel für die Verwendung dieser Eigenschaft finden Sie im Abschnitt Beispiele unten auf dieser Seite.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `IntrinsicVpcBlacklist`   <a name="sam-statemachine-resourcepolicystatement-intrinsicvpcblacklist"></a>
Die Liste der zu blockierenden virtuellen privaten Clouds (VPCs), wobei jede VPC als Referenz angegeben ist, z. B. als [dynamische Referenz](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) oder als `Ref` [intrinsische Funktion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). Ein Beispiel für die Verwendung dieser Eigenschaft finden Sie im Abschnitt Beispiele unten auf dieser Seite.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `IntrinsicVpcWhitelist`   <a name="sam-statemachine-resourcepolicystatement-intrinsicvpcwhitelist"></a>
Die Liste der VPCs Zulässigen, wobei jede VPC als Referenz angegeben wird, z. B. als [dynamische Referenz](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) oder als `Ref` [intrinsische Funktion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig AWS SAM und hat kein Äquivalent. CloudFormation 

 `IntrinsicVpceBlacklist`   <a name="sam-statemachine-resourcepolicystatement-intrinsicvpceblacklist"></a>
[Die Liste der zu blockierenden VPC-Endpunkte, wobei jeder VPC-Endpunkt als Referenz angegeben ist, z. B. als [dynamische Referenz oder als intrinsische](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) Funktion. `Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. CloudFormation 

 `IntrinsicVpceWhitelist`   <a name="sam-statemachine-resourcepolicystatement-intrinsicvpcewhitelist"></a>
[Die Liste der VPC-Endpunkte, die zugelassen werden sollen, wobei jeder VPC-Endpunkt als Referenz angegeben ist, z. B. als [dynamische Referenz](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) oder als systemeigene Funktion. `Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) Ein Beispiel für die Verwendung dieser Eigenschaft finden Sie im Abschnitt Beispiele unten auf dieser Seite.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `IpRangeBlacklist`   <a name="sam-statemachine-resourcepolicystatement-iprangeblacklist"></a>
Die IP-Adressen oder Adressbereiche, die blockiert werden sollen. Ein Beispiel für die Verwendung dieser Eigenschaft finden Sie im Abschnitt Beispiele unten auf dieser Seite.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `IpRangeWhitelist`   <a name="sam-statemachine-resourcepolicystatement-iprangewhitelist"></a>
Die IP-Adressen oder Adressbereiche, die zugelassen werden sollen.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `SourceVpcBlacklist`   <a name="sam-statemachine-resourcepolicystatement-sourcevpcblacklist"></a>
Die Quell-VPC oder die VPC-Endpoints, die blockiert werden sollen. Quell-VPC-Namen müssen mit beginnen `"vpc-"` und Quell-VPC-Endpunktnamen müssen mit beginnen. `"vpce-"` Ein Beispiel für die Verwendung dieser Eigenschaft finden Sie im Abschnitt Beispiele unten auf dieser Seite.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `SourceVpcWhitelist`   <a name="sam-statemachine-resourcepolicystatement-sourcevpcwhitelist"></a>
Die Quell-VPC oder VPC-Endpoints, die zugelassen werden sollen. Quell-VPC-Namen müssen mit beginnen `"vpc-"` und Quell-VPC-Endpunktnamen müssen mit beginnen. `"vpce-"`  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-statemachine-resourcepolicystatement--examples"></a>

### Beispiel für eine Ressourcenrichtlinie
<a name="sam-property-statemachine-resourcepolicystatement--examples--resource-policy-example"></a>

Das folgende Beispiel blockiert zwei IP-Adressen und eine Quell-VPC und lässt ein AWS Konto zu.

#### YAML
<a name="sam-property-statemachine-resourcepolicystatement--examples--resource-policy-example--yaml"></a>

```
Auth:
  ResourcePolicy:
    CustomStatements: [{
                         "Effect": "Allow",
                         "Principal": "*",
                         "Action": "execute-api:Invoke",
                         "Resource": "execute-api:/Prod/GET/pets",
                         "Condition": {
                           "IpAddress": {
                             "aws:SourceIp": "1.2.3.4"
                           }
                         }
                       }]
    IpRangeBlacklist:
      - "10.20.30.40"
      - "1.2.3.4"
    SourceVpcBlacklist:
      - "vpce-1a2b3c4d"
    AwsAccountWhitelist:
      - "111122223333"
    IntrinsicVpcBlacklist:
      - "{{resolve:ssm:SomeVPCReference:1}}" 
      - !Ref MyVPC
    IntrinsicVpceWhitelist:
      - "{{resolve:ssm:SomeVPCEReference:1}}" 
      - !Ref MyVPCE
```

# CloudWatchEvent
<a name="sam-property-statemachine-statemachinecloudwatchevent"></a>

Das Objekt, das einen `CloudWatchEvent` Ereignisquellentyp beschreibt.

AWS Serverless Application Model (AWS SAM) generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)Ressource, wenn dieser Ereignistyp gesetzt ist.

**Wichtiger Hinweis**: [EventBridgeRule](sam-property-statemachine-statemachineeventbridgerule.md) ist der bevorzugte Typ der Ereignisquelle, der anstelle von verwendet wird`CloudWatchEvent`. `EventBridgeRule`und `CloudWatchEvent` verwenden Sie denselben zugrunde liegenden Dienst, dieselbe API und dieselben CloudFormation Ressourcen. AWS SAM Wird jedoch nur Unterstützung für neue Funktionen hinzufügen`EventBridgeRule`.

## Syntax
<a name="sam-property-statemachine-statemachinecloudwatchevent-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-statemachine-statemachinecloudwatchevent-syntax.yaml"></a>

```
  [EventBusName](#sam-statemachine-statemachinecloudwatchevent-eventbusname): String
  [Input](#sam-statemachine-statemachinecloudwatchevent-input): String
  [InputPath](#sam-statemachine-statemachinecloudwatchevent-inputpath): String
  [Pattern](#sam-statemachine-statemachinecloudwatchevent-pattern): [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
```

## Eigenschaften
<a name="sam-property-statemachine-statemachinecloudwatchevent-properties"></a>

 `EventBusName`   <a name="sam-statemachine-statemachinecloudwatchevent-eventbusname"></a>
Der Ereignisbus, der dieser Regel zugeordnet werden soll. Wenn Sie diese Eigenschaft weglassen, AWS SAM wird der Standard-Event-Bus verwendet.  
*Typ:* Zeichenfolge  
*Required*: No  
*Standard: Standard-Event-Bus*  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[EventBusName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname)` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

 `Input`   <a name="sam-statemachine-statemachinecloudwatchevent-input"></a>
Gültiger JSON-Text wurde an das Ziel übergeben. Wenn Sie diese Eigenschaft verwenden, wird nichts aus dem Ereignistext selbst an das Ziel weitergeleitet.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` Eigenschaft einer `AWS::Events::Rule Target` Ressource übergeben.

 `InputPath`   <a name="sam-statemachine-statemachinecloudwatchevent-inputpath"></a>
Wenn Sie nicht das gesamte übereinstimmende Ereignis an das Ziel übergeben möchten, verwenden Sie die `InputPath` Eigenschaft, um zu beschreiben, welcher Teil des Ereignisses übergeben werden soll.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[InputPath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath)` Eigenschaft einer `AWS::Events::Rule Target` Ressource übergeben.

 `Pattern`   <a name="sam-statemachine-statemachinecloudwatchevent-pattern"></a>
Beschreibt, welche Ereignisse an das angegebene Ziel weitergeleitet werden. Weitere Informationen finden Sie unter [Ereignisse und Ereignismuster EventBridge im EventBridge ](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) *Amazon-Benutzerhandbuch*.  
*Typ:* [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

## Beispiele
<a name="sam-property-statemachine-statemachinecloudwatchevent--examples"></a>

### CloudWatchEvent
<a name="sam-property-statemachine-statemachinecloudwatchevent--examples--cloudwatchevent"></a>

Im Folgenden finden Sie ein Beispiel für einen `CloudWatchEvent` Ereignisquellentyp.

#### YAML
<a name="sam-property-statemachine-statemachinecloudwatchevent--examples--cloudwatchevent--yaml"></a>

```
CWEvent:
  Type: CloudWatchEvent
  Properties:
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - running
```

# EventBridgeRule
<a name="sam-property-statemachine-statemachineeventbridgerule"></a>

Das Objekt, das einen `EventBridgeRule` Ereignisquellentyp beschreibt, der Ihren Zustandsmaschine als Ziel für eine EventBridge Amazon-Regel festlegt. Weitere Informationen finden Sie unter [Was ist Amazon EventBridge?](https://docs.aws.amazon.com/eventbridge/latest/userguide/what-is-amazon-eventbridge.html) im * EventBridge Amazon-Benutzerhandbuch*.

AWS SAM generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)Ressource, wenn dieser Ereignistyp festgelegt ist.

## Syntax
<a name="sam-property-statemachine-statemachineeventbridgerule-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-statemachine-statemachineeventbridgerule-syntax.yaml"></a>

```
  DeadLetterConfig: DeadLetterConfig
  EventBusName: String
  Input: String
  InputPath: String
  InputTransformer: [InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html)
  Pattern: [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
  RetryPolicy: [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)
  RuleName: String
  State: String
  Target: Target
```

## Eigenschaften
<a name="sam-property-statemachine-statemachineeventbridgerule-properties"></a>

 `DeadLetterConfig`   <a name="sam-statemachine-statemachineeventbridgerule-deadletterconfig"></a>
Konfigurieren Sie die Amazon Simple Queue Service (Amazon SQS) -Warteschlange, über die Ereignisse nach einem fehlgeschlagenen Zielaufruf EventBridge gesendet werden. Der Aufruf kann beispielsweise fehlschlagen, wenn ein Ereignis an eine Lambda-Funktion gesendet wird, die nicht existiert, oder wenn EventBridge die Berechtigungen zum Aufrufen der Lambda-Funktion nicht ausreichen. *Weitere Informationen finden Sie unter [Richtlinien zur Wiederholung von Ereignissen und Verwenden von Warteschlangen mit unerlaubten Briefen im Amazon-Benutzerhandbuch](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html). EventBridge *  
*Typ:* [DeadLetterConfig](sam-property-statemachine-statemachinedeadletterconfig.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig)` Eigenschaft des Datentyps. `AWS::Events::Rule` `Target` Die AWS SAM Version dieser Eigenschaft enthält zusätzliche Untereigenschaften für den Fall, dass Sie die Warteschlange AWS SAM für unzustellbare Briefe erstellen möchten.

 `EventBusName`   <a name="sam-statemachine-statemachineeventbridgerule-eventbusname"></a>
Der Ereignisbus, der dieser Regel zugeordnet werden soll. Wenn Sie diese Eigenschaft weglassen, wird der AWS SAM Standardereignisbus verwendet.  
*Typ:* Zeichenfolge  
*Required*: No  
*Standard: Standard-Event-Bus*  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[EventBusName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname)` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

 `Input`   <a name="sam-statemachine-statemachineeventbridgerule-input"></a>
Gültiger JSON-Text wurde an das Ziel übergeben. Wenn Sie diese Eigenschaft verwenden, wird nichts aus dem Ereignistext selbst an das Ziel weitergeleitet.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` Eigenschaft einer `AWS::Events::Rule Target` Ressource übergeben.

 `InputPath`   <a name="sam-statemachine-statemachineeventbridgerule-inputpath"></a>
Wenn Sie nicht das gesamte übereinstimmende Ereignis an das Ziel übergeben möchten, verwenden Sie die `InputPath` Eigenschaft, um zu beschreiben, welcher Teil des Ereignisses übergeben werden soll.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[InputPath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath)` Eigenschaft einer `AWS::Events::Rule Target` Ressource übergeben.

`InputTransformer`  <a name="sam-statemachine-statemachineeventbridgerule-inputtransformer"></a>
Einstellungen, mit denen Sie benutzerdefinierte Eingaben für ein Ziel basierend auf bestimmten Ereignisdaten bereitstellen können. Sie können einzelne oder mehrere Schlüssel-Wert-Paare aus dem Ereignis extrahieren und diese Daten dann verwenden, um benutzerdefinierte Eingaben an das Ziel zu senden. Weitere Informationen finden Sie unter [Amazon EventBridge Input Transformation](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-transform-target-input.html) im * EventBridge Amazon-Benutzerhandbuch*.  
*Typ:* [InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputtransformer)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html) ` Eigenschaft eines `AWS::Events::Rule` `Target` Datentyps übergeben.

 `Pattern`   <a name="sam-statemachine-statemachineeventbridgerule-pattern"></a>
Beschreibt, welche Ereignisse an das angegebene Ziel weitergeleitet werden. Weitere Informationen finden Sie unter [Ereignisse und Ereignismuster EventBridge im EventBridge ](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) *Amazon-Benutzerhandbuch*.  
*Typ:* [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

 `RetryPolicy`   <a name="sam-statemachine-statemachineeventbridgerule-retrypolicy"></a>
Ein `RetryPolicy`-Objekt, das Informationen zu den Richtlinieneinstellungen für Wiederholungsversuche enthält. *Weitere Informationen finden Sie unter [Richtlinien zur Wiederholung von Ereignissen und Verwenden von Warteschlangen mit unerlaubten Briefen im Amazon-Benutzerhandbuch](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html). EventBridge *  
*Typ:* [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)` Eigenschaft des Datentyps übergeben. `AWS::Events::Rule` `Target`

 `RuleName`   <a name="sam-statemachine-statemachineeventbridgerule-rulename"></a>
Der Name der Regel.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name)` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

`State`  <a name="sam-statemachine-statemachineeventbridgerule-state"></a>
Der Status der Regel.  
*Gültige Werte*: `[ DISABLED | ENABLED ]`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

 `Target`   <a name="sam-statemachine-statemachineeventbridgerule-target"></a>
Die AWS Ressource, die EventBridge aufgerufen wird, wenn eine Regel ausgelöst wird. Sie können diese Eigenschaft verwenden, um die logische ID des Ziels anzugeben. Wenn diese Eigenschaft nicht angegeben ist, wird die logische ID des Ziels AWS SAM generiert.  
*Typ*: [Ziel](sam-property-statemachine-statemachinetarget.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[Targets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets)` Eigenschaft einer `AWS::Events::Rule` Ressource. In der AWS SAM Version dieser Eigenschaft können Sie nur die logische ID eines einzelnen Ziels angeben.

## Beispiele
<a name="sam-property-statemachine-statemachineeventbridgerule--examples"></a>

### EventBridgeRule
<a name="sam-property-statemachine-statemachineeventbridgerule--examples--eventbridgerule"></a>

Im Folgenden finden Sie ein Beispiel für einen `EventBridgeRule` Ereignisquellentyp.

#### YAML
<a name="sam-property-statemachine-statemachineeventbridgerule--examples--eventbridgerule--yaml"></a>

```
EBRule:
  Type: EventBridgeRule
  Properties:
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - terminated
```

# DeadLetterConfig
<a name="sam-property-statemachine-statemachinedeadletterconfig"></a>

Das Objekt, das zur Angabe der Amazon Simple Queue Service (Amazon SQS) -Warteschlange verwendet wird, über die Ereignisse nach einem fehlgeschlagenen Zielaufruf EventBridge gesendet werden. Der Aufruf kann beispielsweise fehlschlagen, wenn ein Ereignis an eine Zustandsmaschine gesendet wird, die nicht existiert, oder wenn die Berechtigungen zum Aufrufen der Zustandsmaschine nicht ausreichen. *Weitere Informationen finden Sie unter [Richtlinien zur Wiederholung von Ereignissen und Verwenden von Warteschlangen mit unerlaubten Briefen im Amazon-Benutzerhandbuch](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html). EventBridge *

## Syntax
<a name="sam-property-statemachine-statemachinedeadletterconfig-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-statemachine-statemachinedeadletterconfig-syntax.yaml"></a>

```
  [Arn](#sam-statemachine-statemachinedeadletterconfig-arn): String
  [QueueLogicalId](#sam-statemachine-statemachinedeadletterconfig-queuelogicalid): String
  [Type](#sam-statemachine-statemachinedeadletterconfig-type): String
```

## Eigenschaften
<a name="sam-property-statemachine-statemachinedeadletterconfig-properties"></a>

 `Arn`   <a name="sam-statemachine-statemachinedeadletterconfig-arn"></a>
Der Amazon-Ressourcenname (ARN) der Amazon SQS-Warteschlange, der als Ziel für die Warteschlange mit unzustellbaren Briefen angegeben wurde.  
Geben Sie entweder die `Type` Eigenschaft oder `Arn` die Eigenschaft an, aber nicht beide.
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Arn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn)` Eigenschaft des `AWS::Events::Rule` `DeadLetterConfig` Datentyps übergeben.

 `QueueLogicalId`   <a name="sam-statemachine-statemachinedeadletterconfig-queuelogicalid"></a>
Der benutzerdefinierte Name der Warteschlange mit unerlaubten Briefen, die sie AWS SAM erstellt, `Type` ist angegeben.  
Wenn die `Type` Eigenschaft nicht festgelegt ist, wird diese Eigenschaft ignoriert.
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Type`   <a name="sam-statemachine-statemachinedeadletterconfig-type"></a>
Der Typ der Warteschlange. Wenn diese Eigenschaft festgelegt ist, wird AWS SAM automatisch eine Warteschlange für unzustellbare Nachrichten erstellt und die erforderliche [ressourcenbasierte Richtlinie](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-perms) angehängt, um der Regelressource die Erlaubnis zu erteilen, Ereignisse an die Warteschlange zu senden.  
Geben Sie entweder die `Type` Eigenschaft oder die Eigenschaft an, aber nicht beide`Arn`.
*Gültige Werte*: `SQS`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-statemachine-statemachinedeadletterconfig--examples"></a>

### DeadLetterConfig
<a name="sam-property-statemachine-statemachinedeadletterconfig--examples--deadletterconfig"></a>

DeadLetterConfig

#### YAML
<a name="sam-property-statemachine-statemachinedeadletterconfig--examples--deadletterconfig--yaml"></a>

```
DeadLetterConfig:
  Type: SQS
  QueueLogicalId: MyDLQ
```

# Target
<a name="sam-property-statemachine-statemachinetarget"></a>

Konfiguriert die AWS Ressource, die EventBridge aufgerufen wird, wenn eine Regel ausgelöst wird.

## Syntax
<a name="sam-property-statemachine-statemachinetarget-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-statemachine-statemachinetarget-syntax.yaml"></a>

```
  [Id](#sam-statemachine-statemachinetarget-id): String
```

## Eigenschaften
<a name="sam-property-statemachine-statemachinetarget-properties"></a>

 `Id`   <a name="sam-statemachine-statemachinetarget-id"></a>
Die logische ID des Ziels.  
Der Wert von `Id` kann alphanumerische Zeichen, Punkte (`.`), Bindestriche () und Unterstriche (`-`) enthalten. `_`  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Id](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id)` Eigenschaft des Datentyps übergeben. `AWS::Events::Rule` `Target`

## Beispiele
<a name="sam-property-statemachine-statemachinetarget--examples"></a>

### Target
<a name="sam-property-statemachine-statemachinetarget--examples--target"></a>

#### YAML
<a name="sam-property-statemachine-statemachinetarget--examples--target--yaml"></a>

```
EBRule:
  Type: EventBridgeRule
  Properties:
    Target:
      Id: MyTarget
```

# Schedule
<a name="sam-property-statemachine-statemachineschedule"></a>

Das Objekt, das einen `Schedule` Ereignisquellentyp beschreibt, der Ihren Zustandsmaschine als Ziel einer EventBridge Regel festlegt, die nach einem Zeitplan ausgelöst wird. Weitere Informationen finden Sie unter [Was ist Amazon EventBridge?](https://docs.aws.amazon.com/eventbridge/latest/userguide/what-is-amazon-eventbridge.html) im * EventBridge Amazon-Benutzerhandbuch*.

AWS Serverless Application Model (AWS SAM) generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)Ressource, wenn dieser Ereignistyp festgelegt ist.

## Syntax
<a name="sam-property-statemachine-statemachineschedule-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-statemachine-statemachineschedule-syntax.yaml"></a>

```
  [DeadLetterConfig](#sam-statemachine-statemachineschedule-deadletterconfig): DeadLetterConfig
  [Description](#sam-statemachine-statemachineschedule-description): String
  [Enabled](#sam-statemachine-statemachineschedule-enabled): Boolean
  [Input](#sam-statemachine-statemachineschedule-input): String
  [Name](#sam-statemachine-statemachineschedule-name): String
  [RetryPolicy](#sam-statemachine-statemachineschedule-retrypolicy): [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)
  [RoleArn](#sam-statemachine-statemachineschedulev-rolearn): String
  [Schedule](#sam-statemachine-statemachineschedule-schedule): String
  [State](#sam-statemachine-statemachineschedule-state): String
  Target: Target
```

## Eigenschaften
<a name="sam-property-statemachine-statemachineschedule-properties"></a>

 `DeadLetterConfig`   <a name="sam-statemachine-statemachineschedule-deadletterconfig"></a>
Konfigurieren Sie die Amazon Simple Queue Service (Amazon SQS) -Warteschlange, über die Ereignisse nach einem fehlgeschlagenen Zielaufruf EventBridge gesendet werden. Der Aufruf kann beispielsweise fehlschlagen, wenn ein Ereignis an eine Lambda-Funktion gesendet wird, die nicht existiert, oder wenn EventBridge nicht genügend Berechtigungen zum Aufrufen der Lambda-Funktion vorhanden sind. *Weitere Informationen finden Sie unter [Richtlinien zur Wiederholung von Ereignissen und Verwenden von Warteschlangen mit unerlaubten Briefen im Amazon-Benutzerhandbuch](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html). EventBridge *  
*Typ:* [DeadLetterConfig](sam-property-statemachine-statemachinescheduledeadletterconfig.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig)` Eigenschaft des Datentyps. `AWS::Events::Rule` `Target` Die AWS SAM Version dieser Eigenschaft enthält zusätzliche Untereigenschaften für den Fall, dass Sie die Warteschlange AWS SAM für unzustellbare Briefe erstellen möchten.

 `Description`   <a name="sam-statemachine-statemachineschedule-description"></a>
Eine Beschreibung der Regel.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description)` Eigenschaft einer Ressource übergeben. `AWS::Events::Rule`

 `Enabled`   <a name="sam-statemachine-statemachineschedule-enabled"></a>
Gibt an, ob die Regel aktiviert ist.  
Um die Regel zu deaktivieren, setzen Sie diese Eigenschaft auf`false`.  
Geben Sie entweder die `State` Eigenschaft `Enabled` oder an, aber nicht beide.
*Typ*: Boolesch  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` Eigenschaft einer `AWS::Events::Rule` Ressource. Wenn diese Eigenschaft auf `true` gesetzt ist, gilt sie AWS SAM als erfolgreich`ENABLED`, andernfalls gilt sie als erfolgreich`DISABLED`.

 `Input`   <a name="sam-statemachine-statemachineschedule-input"></a>
Gültiger JSON-Text wurde an das Ziel übergeben. Wenn Sie diese Eigenschaft verwenden, wird nichts aus dem Ereignistext selbst an das Ziel weitergeleitet.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` Eigenschaft einer `AWS::Events::Rule Target` Ressource übergeben.

 `Name`   <a name="sam-statemachine-statemachineschedule-name"></a>
Der Name der Regel. Wenn Sie keinen Namen angeben, CloudFormation generiert es eine eindeutige physische ID und verwendet diese ID als Regelnamen.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name)` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

 `RetryPolicy`   <a name="sam-statemachine-statemachineschedule-retrypolicy"></a>
Ein `RetryPolicy`-Objekt, das Informationen zu den Richtlinieneinstellungen für Wiederholungsversuche enthält. *Weitere Informationen finden Sie unter [Richtlinien zur Wiederholung von Ereignissen und Verwenden von Warteschlangen mit unerlaubten Briefen im Amazon-Benutzerhandbuch](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html). EventBridge *  
*Typ:* [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)` Eigenschaft des Datentyps übergeben. `AWS::Events::Rule` `Target`

 `RoleArn`   <a name="sam-statemachine-statemachineschedulev-rolearn"></a>
Der ARN der IAM-Rolle, die der EventBridge Scheduler für das Ziel verwendet, wenn der Zeitplan aufgerufen wird.  
*Typ:* [RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)  
*Erforderlich*: Nein. Falls nicht angegeben, wird eine neue Rolle erstellt und verwendet.  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)` Eigenschaft des `AWS::Scheduler::Schedule` `Target` Datentyps übergeben.

 `Schedule`   <a name="sam-statemachine-statemachineschedule-schedule"></a>
Der Planungsausdruck, der bestimmt, wann und wie oft die Regel ausgeführt wird. Weitere Informationen finden Sie unter [Planen von Ausdrücken für Regeln](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html).  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ScheduleExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression)` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

 `State`   <a name="sam-statemachine-statemachineschedule-state"></a>
Der Status der Regel.  
*Zulässige Werte:* `DISABLED | ENABLED`  
Geben Sie entweder die `State` Eigenschaft `Enabled` oder an, aber nicht beide.
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` Eigenschaft einer `AWS::Events::Rule` Ressource übergeben.

 `Target`   <a name="sam-statemachine-statemachineschedule-target"></a>
Die AWS Ressource, die EventBridge aufgerufen wird, wenn eine Regel ausgelöst wird. Sie können diese Eigenschaft verwenden, um die logische ID des Ziels anzugeben. Wenn diese Eigenschaft nicht angegeben ist, wird die logische ID des Ziels AWS SAM generiert.  
*Typ*: [Ziel](sam-property-statemachine-statemachinetarget.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[Targets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets)` Eigenschaft einer `AWS::Events::Rule` Ressource. In der AWS SAM Version dieser Eigenschaft können Sie nur die logische ID eines einzelnen Ziels angeben.

## Beispiele
<a name="sam-property-statemachine-statemachineschedule--examples"></a>

### CloudWatch Veranstaltung planen
<a name="sam-property-statemachine-statemachineschedule--examples--cloudwatch-schedule-event"></a>

CloudWatch Beispiel für einen Termin planen

#### YAML
<a name="sam-property-statemachine-statemachineschedule--examples--cloudwatch-schedule-event--yaml"></a>

```
CWSchedule:
  Type: Schedule
  Properties:
    Schedule: 'rate(1 minute)'
    Name: TestSchedule
    Description: test schedule
    Enabled: false
```

# DeadLetterConfig
<a name="sam-property-statemachine-statemachinescheduledeadletterconfig"></a>

Das Objekt, das zur Angabe der Amazon Simple Queue Service (Amazon SQS) -Warteschlange verwendet wird, über die Ereignisse nach einem fehlgeschlagenen Zielaufruf EventBridge gesendet werden. Der Aufruf kann beispielsweise fehlschlagen, wenn ein Ereignis an eine Zustandsmaschine gesendet wird, die nicht existiert, oder wenn die Berechtigungen zum Aufrufen der Zustandsmaschine nicht ausreichen. *Weitere Informationen finden Sie unter [Richtlinien zur Wiederholung von Ereignissen und Verwenden von Warteschlangen mit unerlaubten Briefen im Amazon-Benutzerhandbuch](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html). EventBridge *

## Syntax
<a name="sam-property-statemachine-statemachinescheduledeadletterconfig-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-statemachine-statemachinescheduledeadletterconfig-syntax.yaml"></a>

```
  [Arn](#sam-statemachine-statemachinescheduledeadletterconfig-arn): String
  [QueueLogicalId](#sam-statemachine-statemachinescheduledeadletterconfig-queuelogicalid): String
  [Type](#sam-statemachine-statemachinescheduledeadletterconfig-type): String
```

## Eigenschaften
<a name="sam-property-statemachine-statemachinescheduledeadletterconfig-properties"></a>

 `Arn`   <a name="sam-statemachine-statemachinescheduledeadletterconfig-arn"></a>
Der Amazon-Ressourcenname (ARN) der Amazon SQS-Warteschlange, der als Ziel für die Warteschlange mit unzustellbaren Briefen angegeben wurde.  
Geben Sie entweder die `Type` Eigenschaft oder `Arn` die Eigenschaft an, aber nicht beide.
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Arn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn)` Eigenschaft des `AWS::Events::Rule` `DeadLetterConfig` Datentyps übergeben.

 `QueueLogicalId`   <a name="sam-statemachine-statemachinescheduledeadletterconfig-queuelogicalid"></a>
Der benutzerdefinierte Name der Warteschlange mit unerlaubten Briefen, die sie AWS SAM erstellt, `Type` ist angegeben.  
Wenn die `Type` Eigenschaft nicht festgelegt ist, wird diese Eigenschaft ignoriert.
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Type`   <a name="sam-statemachine-statemachinescheduledeadletterconfig-type"></a>
Der Typ der Warteschlange. Wenn diese Eigenschaft festgelegt ist, wird AWS SAM automatisch eine Warteschlange für unzustellbare Nachrichten erstellt und die erforderliche [ressourcenbasierte Richtlinie](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-perms) angehängt, um der Regelressource die Erlaubnis zu erteilen, Ereignisse an die Warteschlange zu senden.  
Geben Sie entweder die `Type` Eigenschaft oder die Eigenschaft an, aber nicht beide`Arn`.
*Gültige Werte*: `SQS`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

## Beispiele
<a name="sam-property-statemachine-statemachinescheduledeadletterconfig--examples"></a>

### DeadLetterConfig
<a name="sam-property-statemachine-statemachinescheduledeadletterconfig--examples--deadletterconfig"></a>

DeadLetterConfig

#### YAML
<a name="sam-property-statemachine-statemachinescheduledeadletterconfig--examples--deadletterconfig--yaml"></a>

```
DeadLetterConfig:
  Type: SQS
  QueueLogicalId: MyDLQ
```

# Target
<a name="sam-property-statemachine-statemachinescheduletarget"></a>

Konfiguriert die AWS Ressource, die EventBridge aufgerufen wird, wenn eine Regel ausgelöst wird.

## Syntax
<a name="sam-property-statemachine-statemachinescheduletarget-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-statemachine-statemachinescheduletarget-syntax.yaml"></a>

```
  [Id](#sam-statemachine-statemachinescheduletarget-id): String
```

## Eigenschaften
<a name="sam-property-statemachine-statemachinescheduletarget-properties"></a>

 `Id`   <a name="sam-statemachine-statemachinescheduletarget-id"></a>
Die logische ID des Ziels.  
Der Wert von `Id` kann alphanumerische Zeichen, Punkte (`.`), Bindestriche () und Unterstriche (`-`) enthalten. `_`  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Id](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id)` Eigenschaft des Datentyps übergeben. `AWS::Events::Rule` `Target`

## Beispiele
<a name="sam-property-statemachine-statemachinescheduletarget--examples"></a>

### Target
<a name="sam-property-statemachine-statemachinescheduletarget--examples--target"></a>

#### YAML
<a name="sam-property-statemachine-statemachinescheduletarget--examples--target--yaml"></a>

```
EBRule:
  Type: Schedule
  Properties:
    Target:
      Id: MyTarget
```

# ScheduleV2
<a name="sam-property-statemachine-statemachineschedulev2"></a>

Das Objekt, das einen `ScheduleV2` Ereignisquellentyp beschreibt, der Ihren Zustandsmaschine als Ziel eines Amazon EventBridge Scheduler-Ereignisses festlegt, das nach einem Zeitplan ausgelöst wird. Weitere Informationen finden Sie unter [Was ist Amazon EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/what-is-scheduler.html)? im *EventBridge Scheduler-Benutzerhandbuch*.

AWS Serverless Application Model (AWS SAM) generiert eine [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html)Ressource, wenn dieser Ereignistyp festgelegt ist.

## Syntax
<a name="sam-property-statemachine-statemachineschedulev2-syntax"></a>

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### YAML
<a name="sam-property-statemachine-statemachineschedulev2-syntax.yaml"></a>

```
DeadLetterConfig: DeadLetterConfig
[Description](#sam-statemachine-statemachineschedulev2-description): String
[EndDate](#sam-statemachine-statemachineschedulev2-enddate): String
[FlexibleTimeWindow](#sam-statemachine-statemachineschedulev2-flexibletimewindow): FlexibleTimeWindow
[GroupName](#sam-statemachine-statemachineschedulev2-groupname): String
[Input](#sam-statemachine-statemachineschedulev2-input): String
[KmsKeyArn](#sam-statemachine-statemachineschedulev2-kmskeyarn): String
[Name](#sam-statemachine-statemachineschedulev2-name): String
OmitName: Boolean
[PermissionsBoundary](#sam-statemachine-statemachineschedulev2-permissionsboundary): String
[RetryPolicy](#sam-statemachine-statemachineschedulev2-retrypolicy): RetryPolicy
[RoleArn](#sam-statemachine-statemachineschedulev2-rolearn): String
[ScheduleExpression](#sam-statemachine-statemachineschedulev2-scheduleexpression): String
[ScheduleExpressionTimezone](#sam-statemachine-statemachineschedulev2-scheduleexpressiontimezone): String
[StartDate](#sam-statemachine-statemachineschedulev2-startdate): String
[State](#sam-statemachine-statemachineschedulev2-state): String
```

## Eigenschaften
<a name="sam-property-statemachine-statemachineschedulev2-properties"></a>

 `DeadLetterConfig`   <a name="sam-statemachine-statemachineschedulev2-deadletterconfig"></a>
Konfigurieren Sie die Amazon Simple Queue Service (Amazon SQS) -Warteschlange, über die Ereignisse nach einem fehlgeschlagenen Zielaufruf EventBridge gesendet werden. Der Aufruf kann beispielsweise fehlschlagen, wenn ein Ereignis an eine Lambda-Funktion gesendet wird, die nicht existiert, oder wenn EventBridge die Berechtigungen zum Aufrufen der Lambda-Funktion nicht ausreichen. *Weitere Informationen finden Sie im Scheduler-Benutzerhandbuch unter [Konfiguration einer Warteschlange mit uneingeschränkten Briefen für den EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/configuring-schedule-dlq.html). EventBridge *  
*Typ:* [DeadLetterConfig](sam-property-statemachine-statemachinescheduledeadletterconfig.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ähnelt der `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-deadletterconfig)` Eigenschaft des Datentyps. `AWS::Scheduler::Schedule` `Target` Die AWS SAM Version dieser Eigenschaft enthält zusätzliche Untereigenschaften für den Fall, dass Sie die Warteschlange AWS SAM für unzustellbare Briefe erstellen möchten.

 `Description`   <a name="sam-statemachine-statemachineschedulev2-description"></a>
Eine Beschreibung des Zeitplans.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-description)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

 `EndDate`   <a name="sam-statemachine-statemachineschedulev2-enddate"></a>
Das Datum in UTC, bevor der Zeitplan sein Ziel aufrufen kann. Abhängig vom Wiederholungsausdruck des Zeitplans können Aufrufe an oder vor dem von Ihnen angegebenen **EndDate** anhalten.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[EndDate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-enddate)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

 `FlexibleTimeWindow`   <a name="sam-statemachine-statemachineschedulev2-flexibletimewindow"></a>
Ermöglicht die Konfiguration eines Fensters, in dem ein Zeitplan aufgerufen werden kann.  
*Typ:* [FlexibleTimeWindow](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-flexibletimewindow)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[FlexibleTimeWindow](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler.html#cfn-scheduler-schedule-flexibletimewindow)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

 `GroupName`   <a name="sam-statemachine-statemachineschedulev2-groupname"></a>
Der Name der Zeitplangruppe, die diesem Zeitplan zugeordnet werden soll. Wenn nicht definiert, wird die Standardgruppe verwendet.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[GroupName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-groupname)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

 `Input`   <a name="sam-statemachine-statemachineschedulev2-input"></a>
Gültiger JSON-Text wurde an das Ziel übergeben. Wenn Sie diese Eigenschaft verwenden, wird nichts aus dem Ereignistext selbst an das Ziel weitergeleitet.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-input)` Eigenschaft einer `AWS::Scheduler::Schedule Target` Ressource übergeben.

 `KmsKeyArn`   <a name="sam-statemachine-statemachineschedulev2-kmskeyarn"></a>
Der ARN für einen KMS-Schlüssel, der zur Verschlüsselung von Kundendaten verwendet wird.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-kmskeyarn)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

 `Name`   <a name="sam-statemachine-statemachineschedulev2-name"></a>
Der Name des Plans. Wenn Sie keinen Namen angeben, AWS SAM generiert es einen Namen im Format `StateMachine-Logical-IDEvent-Source-Name` und verwendet diese ID als Namen des Zeitplans.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-name)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

`OmitName`  <a name="sam-statemachine-statemachineschedulev2-omitname"></a>
 AWS SAM Generiert und verwendet standardmäßig einen Zeitplannamen im Format von*<State-machine-logical-ID><event-source-name>*. Stellen Sie diese Eigenschaft so ein`true`, dass eine eindeutige physische ID CloudFormation generiert und diese stattdessen für den Zeitplannamen verwendet wird.  
*Typ*: Boolesch  
*Required*: No  
*Standardwert*: `false`  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `PermissionsBoundary`   <a name="sam-statemachine-statemachineschedulev2-permissionsboundary"></a>
Der ARN der Richtlinie, mit der die Berechtigungsgrenze für die Rolle festgelegt wurde.  
Wenn sie definiert `PermissionsBoundary` ist, AWS SAM werden dieselben Grenzen auf die IAM-Zielrolle des Scheduler-Zeitplans angewendet.
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[PermissionsBoundary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary)` Eigenschaft einer `AWS::IAM::Role` Ressource übergeben.

 `RetryPolicy`   <a name="sam-statemachine-statemachineschedulev2-retrypolicy"></a>
Ein `RetryPolicy`-Objekt, das Informationen zu den Richtlinieneinstellungen für Wiederholungsversuche enthält.  
*Typ:* [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy)` Eigenschaft des `AWS::Scheduler::Schedule` `Target` Datentyps übergeben.

 `RoleArn`   <a name="sam-statemachine-statemachineschedulev2-rolearn"></a>
Der ARN der IAM-Rolle, die der EventBridge Scheduler für das Ziel verwendet, wenn der Zeitplan aufgerufen wird.  
*Typ:* [RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)` Eigenschaft des Datentyps übergeben. `AWS::Scheduler::Schedule` `Target`

 `ScheduleExpression`   <a name="sam-statemachine-statemachineschedulev2-scheduleexpression"></a>
Der Planungsausdruck, der bestimmt, wann und wie oft der Zeitplan ausgeführt wird.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ScheduleExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpression)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

 `ScheduleExpressionTimezone`   <a name="sam-statemachine-statemachineschedulev2-scheduleexpressiontimezone"></a>
Die Zeitzone, in der der Planungsausdruck ausgewertet wird.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[ScheduleExpressionTimezone](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpressiontimezone)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

 `StartDate`   <a name="sam-statemachine-statemachineschedulev2-startdate"></a>
Das Datum in UTC, nach dem der Zeitplan mit dem Aufrufen eines Ziels beginnen kann. Abhängig vom Wiederholungsausdruck des Zeitplans können Aufrufe an oder nach dem von Ihnen angegebenen **StartDate** erfolgen.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[StartDate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-startdate)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

 `State`   <a name="sam-statemachine-statemachineschedulev2-state"></a>
Der Status des Zeitplans.  
*Zulässige Werte:* `DISABLED | ENABLED`  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-state)` Eigenschaft einer `AWS::Scheduler::Schedule` Ressource übergeben.

## Beispiele
<a name="sam-property-statemachine-statemachineschedulev2--examples"></a>

### Einfaches Beispiel für die Definition einer ScheduleV2-Ressource
<a name="sam-property-statemachine-statemachineschedulev2--examples--example1"></a>

```
StateMachine:
  Type: AWS::Serverless::StateMachine
  Properties:
    Name: MyStateMachine
    Events:
      ScheduleEvent:
        Type: ScheduleV2
        Properties:
          ScheduleExpression: "rate(1 minute)"
      ComplexScheduleEvent:
        Type: ScheduleV2
        Properties:
          ScheduleExpression: rate(1 minute)
          FlexibleTimeWindow:
            Mode: FLEXIBLE
            MaximumWindowInMinutes: 5
          StartDate: '2022-12-28T12:00:00.000Z'
          EndDate: '2023-01-28T12:00:00.000Z'
          ScheduleExpressionTimezone: UTC
          RetryPolicy:
            MaximumRetryAttempts: 5
            MaximumEventAgeInSeconds: 300
          DeadLetterConfig:
            Type: SQS
    DefinitionUri:
      Bucket: sam-sam-s3-demo-bucket
      Key: my-state-machine.asl.json
      Version: 3
    Policies:
      - LambdaInvokePolicy:
          FunctionName: !Ref MyFunction
```

# Generierte CloudFormation Ressourcen für AWS SAM
<a name="sam-specification-generated-resources"></a>

Dieser Abschnitt enthält Einzelheiten zu den CloudFormation Ressourcen, die bei der Verarbeitung Ihrer AWS SAM AWS Vorlage erstellt werden. Welche CloudFormation Ressourcen AWS SAM generiert werden, hängt von den von Ihnen angegebenen Szenarien ab. Ein *Szenario* ist die Kombination von AWS SAM Ressourcen und Eigenschaften, die in Ihrer Vorlagendatei angegeben sind. Sie können an anderer Stelle in Ihrer Vorlagendatei auf die generierten CloudFormation Ressourcen verweisen, ähnlich wie Sie auf Ressourcen verweisen, die Sie in Ihrer Vorlagendatei explizit deklarieren.

Wenn Sie beispielsweise eine `AWS::Serverless::Function` Ressource in Ihrer AWS SAM Vorlagendatei angeben, wird AWS SAM immer eine `AWS::Lambda::Function` Basisressource generiert. Wenn Sie auch die optionale `AutoPublishAlias` Eigenschaft angeben, AWS SAM werden zusätzlich `AWS::Lambda::Alias` auch `AWS::Lambda::Version` Ressourcen generiert.

In diesem Abschnitt werden die Szenarien und die CloudFormation Ressourcen, die sie generieren, aufgeführt. Außerdem wird gezeigt, wie Sie in Ihrer AWS SAM Vorlagendatei auf die generierten CloudFormation Ressourcen verweisen können.

## Verweisen auf generierte Ressourcen CloudFormation
<a name="sam-specification-generated-resources-referencing"></a>

Sie haben zwei Möglichkeiten, generierte CloudFormation Ressourcen in Ihrer AWS SAM Vorlagendatei zu referenzieren: nach `LogicalId` oder nach referenzierbarer Eigenschaft.

### Generierte Ressourcen referenzieren von CloudFormation LogicalId
<a name="sam-specification-generated-resources-referencing-logicalid"></a>

Die AWS SAM generierten CloudFormation Ressourcen haben jeweils eine`[LogicalId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-logicalid)`, was eine alphanumerische (A-Z, a-z, 0-9) Kennung ist, die innerhalb einer Vorlagendatei eindeutig ist. AWS SAM verwendet die `LogicalIds` AWS SAM Ressourcen in Ihrer Vorlagendatei, um die `LogicalIds` generierten Ressourcen zu erstellen. CloudFormation Sie können die `LogicalId` einer generierten CloudFormation Ressource verwenden, um auf Eigenschaften dieser Ressource in Ihrer Vorlagendatei zuzugreifen, genau wie Sie es für eine CloudFormation Ressource tun würden, die Sie explizit deklariert haben. Weitere Informationen zu `LogicalIds` Gin CloudFormation und AWS SAM Vorlagen finden Sie unter [Ressourcen](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html) im *AWS CloudFormation Benutzerhandbuch*.

**Anmerkung**  
Einige generierte Ressourcen enthalten einen eindeutigen Hashwert, um Namespace-Konflikte zu vermeiden. `LogicalIds` Diese Ressourcen werden bei `LogicalIds` der Erstellung des Stacks abgeleitet. Sie können sie erst abrufen, nachdem der Stack mit dem AWS-Managementkonsole AWS CLI, oder einem der folgenden Befehle erstellt wurde AWS SDKs. Es wird nicht empfohlen, diese Ressourcen mit zu referenzieren`LogicalId`, da sich die Hashwerte ändern könnten.

### Referenzieren generierter CloudFormation Ressourcen anhand einer referenzierbaren Eigenschaft
<a name="sam-specification-generated-resources-referencing-referenceable-property"></a>

 AWS SAM Stellt für einige generierte Ressourcen eine referenzierbare Eigenschaft der Ressource bereit. AWS SAM Sie können diese Eigenschaft verwenden, um in Ihrer AWS SAM Vorlagendatei auf eine generierte CloudFormation Ressource und ihre Eigenschaften zu verweisen.

**Anmerkung**  
Nicht alle generierten CloudFormation Ressourcen haben referenzierbare Eigenschaften. Für diese Ressourcen müssen Sie die `LogicalId` verwenden.

## Generierte CloudFormation Ressourcenszenarien
<a name="sam-specification-generated-resources-scenarios"></a>

In der folgenden Tabelle sind die AWS SAM Ressourcen und Eigenschaften zusammengefasst, aus denen sich die Szenarien zusammensetzen, mit denen CloudFormation Ressourcen generiert werden. Die Themen in der Spalte **Szenarien** enthalten Einzelheiten zu den zusätzlichen CloudFormation Ressourcen, die für dieses Szenario AWS SAM generiert werden.


| AWS SAM Ressource |  CloudFormation Basisressource | Szenarien | 
| --- | --- | --- | 
| AWS::Serverless::Api  | [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/serverless-application-model/latest/developerguide/sam-specification-generated-resources.html)  | 
| AWS::Serverless::Application  | [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html) |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/serverless-application-model/latest/developerguide/sam-specification-generated-resources.html)  | 
| AWS::Serverless::CapacityProvider  | [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-capacityprovider.html) |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/serverless-application-model/latest/developerguide/sam-specification-generated-resources.html)  | 
| AWS::Serverless::Function | [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html) |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/serverless-application-model/latest/developerguide/sam-specification-generated-resources.html)  | 
| AWS::Serverless::HttpApi | [AWS::ApiGatewayV2::Api](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html) |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/serverless-application-model/latest/developerguide/sam-specification-generated-resources.html)  | 
| AWS::Serverless::LayerVersion  | [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html) |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/serverless-application-model/latest/developerguide/sam-specification-generated-resources.html)  | 
| AWS::Serverless::SimpleTable  | [AWS::DynamoDB::Table](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html) |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/serverless-application-model/latest/developerguide/sam-specification-generated-resources.html)  | 
| AWS::Serverless::StateMachine  | [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html) |  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/de_de/serverless-application-model/latest/developerguide/sam-specification-generated-resources.html)  | 

**Topics**
+ [Verweisen auf generierte Ressourcen CloudFormation](#sam-specification-generated-resources-referencing)
+ [Generierte CloudFormation Ressourcenszenarien](#sam-specification-generated-resources-scenarios)
+ [CloudFormation Ressourcen, die generiert werdenAWS::Serverless::Api, wenn angegeben](sam-specification-generated-resources-api.md)
+ [CloudFormation Ressourcen, die generiert werdenAWS::Serverless::Application, wenn angegeben](sam-specification-generated-resources-application.md)
+ [CloudFormation Ressourcen, die generiert werdenAWS::Serverless::CapacityProvider, wenn angegeben](sam-specification-generated-resources-capacityprovider.md)
+ [CloudFormation Ressourcen, die generiert werden, wenn Sie angeben AWS::Serverless::Connector](sam-specification-generated-resources-connector.md)
+ [CloudFormation Ressourcen, die generiert werdenAWS::Serverless::Function, wenn angegeben](sam-specification-generated-resources-function.md)
+ [CloudFormation Ressourcen, die generiert werdenAWS::Serverless::GraphQLApi, wenn angegeben](sam-specification-generated-resources-graphqlapi.md)
+ [CloudFormation Ressourcen, die generiert werden AWS::Serverless::HttpApi , wenn angegeben](sam-specification-generated-resources-httpapi.md)
+ [CloudFormation Ressourcen, die generiert werdenAWS::Serverless::LayerVersion, wenn angegeben](sam-specification-generated-resources-layerversion.md)
+ [CloudFormation Ressourcen, die generiert werdenAWS::Serverless::SimpleTable, wenn angegeben](sam-specification-generated-resources-simpletable.md)
+ [CloudFormation Ressourcen, die generiert werdenAWS::Serverless::StateMachine, wenn angegeben](sam-specification-generated-resources-statemachine.md)

# CloudFormation Ressourcen, die generiert werdenAWS::Serverless::Api, wenn angegeben
<a name="sam-specification-generated-resources-api"></a>

Wenn an angegeben `AWS::Serverless::Api` ist, generiert AWS Serverless Application Model (AWS SAM) immer eine `AWS::ApiGateway::RestApi` CloudFormation Basisressource. Darüber hinaus generiert es auch immer eine `AWS::ApiGateway::Stage` und eine `AWS::ApiGateway::Deployment` Ressource.

**`AWS::ApiGateway::RestApi`**  
*`LogicalId`: *`<api‑LogicalId>`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

**`AWS::ApiGateway::Stage`**  
*`LogicalId`: *`<api‑LogicalId><stage‑name>Stage`  
`<stage‑name>`ist die Zeichenfolge, auf die die `StageName` Eigenschaft gesetzt ist. Wenn Sie beispielsweise `StageName` auf einstellen`Gamma`, `LogicalId` ist der`MyRestApiGammaStage`.  
*Referenzierbare Eigenschaft:* `<api‑LogicalId>.Stage`

**`AWS::ApiGateway::Deployment`**  
*`LogicalId`: *`<api‑LogicalId>Deployment<sha>`  
`<sha>`ist ein eindeutiger Hashwert, der bei der Erstellung des Stacks generiert wird. Beispiel, `MyRestApiDeployment926eeb5ff1`.  
*Referenzierbare Eigenschaft:* `<api‑LogicalId>.Deployment`

Zusätzlich zu diesen CloudFormation Ressourcen werden, sofern `AWS::Serverless::Api` angegeben, zusätzliche CloudFormation Ressourcen für die folgenden Szenarien AWS SAM generiert.

**Topics**
+ [DomainName Eigenschaft ist angegeben](#sam-specification-generated-resources-api-domain-name)
+ [UsagePlan Eigenschaft ist spezifiziert](#sam-specification-generated-resources-api-usage-plan)

## DomainName Eigenschaft ist angegeben
<a name="sam-specification-generated-resources-api-domain-name"></a>

Wenn die `DomainName` Eigenschaft der `Domain` Eigenschaft von an angegeben `AWS::Serverless::Api` ist, wird die `AWS::ApiGateway::DomainName` CloudFormation Ressource AWS SAM generiert.

**`AWS::ApiGateway::DomainName`**  
*`LogicalId`: *`ApiGatewayDomainName<sha>`  
`<sha>`ist ein eindeutiger Hashwert, der generiert wird, wenn der Stack erstellt wird. Beispiel: `ApiGatewayDomainName926eeb5ff1`.  
*Referenzierbare Eigenschaft:* `<api‑LogicalId>.DomainName`

## UsagePlan Eigenschaft ist spezifiziert
<a name="sam-specification-generated-resources-api-usage-plan"></a>

Wenn die `UsagePlan` `Auth` Eigenschaft einer angegeben `AWS::Serverless::Api` ist, werden die folgenden CloudFormation Ressourcen AWS SAM generiert: `AWS::ApiGateway::UsagePlan``AWS::ApiGateway::UsagePlanKey`, und`AWS::ApiGateway::ApiKey`.

**`AWS::ApiGateway::UsagePlan`**  
*`LogicalId`: *`<api‑LogicalId>UsagePlan`  
*Referenzierbare Eigenschaft:* `<api‑LogicalId>.UsagePlan`

**`AWS::ApiGateway::UsagePlanKey`**  
*`LogicalId`: *`<api‑LogicalId>UsagePlanKey`  
*Referenzierbares Eigentum:* `<api‑LogicalId>.UsagePlanKey`

**`AWS::ApiGateway::ApiKey`**  
*`LogicalId`: *`<api‑LogicalId>ApiKey`  
*Referenzierbares Eigentum:* `<api‑LogicalId>.ApiKey`

# CloudFormation Ressourcen, die generiert werdenAWS::Serverless::Application, wenn angegeben
<a name="sam-specification-generated-resources-application"></a>

Wenn an angegeben `AWS::Serverless::Application` ist, generiert AWS Serverless Application Model (AWS SAM) eine `AWS::CloudFormation::Stack` CloudFormation Basisressource.

**`AWS::CloudFormation::Stack`**  
*`LogicalId`: *`<application‑LogicalId>`   
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

# CloudFormation Ressourcen, die generiert werdenAWS::Serverless::CapacityProvider, wenn angegeben
<a name="sam-specification-generated-resources-capacityprovider"></a>

Wenn an angegeben `AWS::Serverless::CapacityProvider` ist, generiert AWS Serverless Application Model (AWS SAM) eine `AWS::Lambda::CapacityProvider` CloudFormation Basisressource.

**`AWS::Lambda::CapacityProvider`**  
*`LogicalId`: *`<capacityprovider‑LogicalId>`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

Zusätzlich zu dieser CloudFormation Ressource werden, wenn `AWS::Serverless::CapacityProvider` angegeben, AWS SAM auch CloudFormation Ressourcen für die folgenden Szenarien generiert:

**Topics**
+ [OperatorRole Eigenschaft ist nicht angegeben](#sam-specification-generated-resources-capacityprovider-iam-role)

## OperatorRole Eigenschaft ist nicht angegeben
<a name="sam-specification-generated-resources-capacityprovider-iam-role"></a>

Wenn die `OperatorRole` Eigenschaft von *nicht* angegeben `AWS::Serverless::CapacityProvider` ist, wird eine `AWS::IAM::Role` CloudFormation Ressource mit der angehängten `AWSLambdaManagedEC2ResourceOperator` verwalteten Richtlinie AWS SAM generiert.

**`AWS::IAM::Role`**  
*`LogicalId`: *`<capacityprovider‑LogicalId>OperatorRole`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

# CloudFormation Ressourcen, die generiert werden, wenn Sie angeben AWS::Serverless::Connector
<a name="sam-specification-generated-resources-connector"></a>

**Anmerkung**  
Wenn Sie Konnektoren mithilfe der eingebetteten `Connectors` Eigenschaft definieren, wird diese zunächst in eine `AWS::Serverless::Connector` Ressource umgewandelt, bevor diese Ressourcen generiert werden.

Wenn Sie eine `AWS::Serverless::Connector` Ressource in einer AWS SAM Vorlage angeben, werden bei Bedarf die folgenden AWS CloudFormation Ressourcen AWS SAM generiert.

**`AWS::IAM::ManagedPolicy`**  
 *`LogicalId`:*`<connector‑LogicalId>Policy`   
 *Referenzierbare Eigenschaft:* N/A (Um auf diese CloudFormation Ressource zu verweisen, müssen Sie die verwenden`LogicalId`.) 

**`AWS::SNS::TopicPolicy`**  
 *`LogicalId`:*`<connector‑LogicalId>TopicPolicy`   
 *Referenzierbare Eigenschaft:* N/A (Um auf diese CloudFormation Ressource zu verweisen, müssen Sie die `LogicalId` verwenden.) 

**`AWS::SQS::QueuePolicy`**  
 *`LogicalId`:*`<connector‑LogicalId>QueuePolicy`   
 *Referenzierbare Eigenschaft:* N/A (Um auf diese CloudFormation Ressource zu verweisen, müssen Sie die `LogicalId` verwenden.) 

**`AWS::Lambda::Permission`**  
 *`LogicalId`:*`<connector‑LogicalId><permission>LambdaPermission`   
 `<permission>`ist eine von der `Permissions` Eigenschaft angegebene Berechtigung. Beispiel, `Write`.   
*Referenzierbare Eigenschaft:* N/A (Um auf diese CloudFormation Ressource zu verweisen, müssen Sie die verwenden`LogicalId`.) 

# CloudFormation Ressourcen, die generiert werdenAWS::Serverless::Function, wenn angegeben
<a name="sam-specification-generated-resources-function"></a>

Wenn an angegeben `AWS::Serverless::Function` ist, erstellt AWS Serverless Application Model (AWS SAM) immer eine `AWS::Lambda::Function` CloudFormation Basisressource.

**`AWS::Lambda::Function`**  
*`LogicalId`: *`<function‑LogicalId>`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

Zusätzlich zu dieser CloudFormation Ressource werden, wenn `AWS::Serverless::Function` angegeben, AWS SAM auch CloudFormation Ressourcen für die folgenden Szenarien generiert.

**Topics**
+ [Eigenschaften der Kernfunktion](#sam-specification-generated-resources-function-core-properties)
+ [Ereignisquellen](#sam-specification-generated-resources-function-event-sources)
+ [Konfiguration des Ereignisses](#sam-specification-generated-resources-function-event-configuration)

## Eigenschaften der Kernfunktion
<a name="sam-specification-generated-resources-function-core-properties"></a>

In den folgenden Szenarien werden CloudFormation Ressourcen auf der Grundlage von Kernfunktionseigenschaften generiert:

### Die Rolleneigenschaft ist nicht angegeben
<a name="sam-specification-generated-resources-function-not-role"></a>

Wenn die `Role` Eigenschaft von *nicht* angegeben `AWS::Serverless::Function` ist, wird eine `AWS::IAM::Role` CloudFormation Ressource AWS SAM generiert.

**`AWS::IAM::Role`**  
*`LogicalId`: *`<function‑LogicalId>Role`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

### AutoPublishAlias Eigenschaft ist angegeben
<a name="sam-specification-generated-resources-function-autopublishalias"></a>

Wenn die `AutoPublishAlias` Eigenschaft von an angegeben `AWS::Serverless::Function` ist, werden die folgenden CloudFormation Ressourcen AWS SAM generiert: `AWS::Lambda::Alias` und`AWS::Lambda::Version`.

**`AWS::Lambda::Alias`**  
*`LogicalId`: *`<function‑LogicalId>Alias<alias‑name>`  
`<alias‑name>`ist die Zeichenfolge, die auf gesetzt `AutoPublishAlias` ist. Wenn Sie beispielsweise `AutoPublishAlias` auf einstellen`live`, `LogicalId` lautet das: *MyFunction* Alias*live*.  
*Referenzierbare Eigenschaft:* `<function‑LogicalId>.Alias`

**`AWS::Lambda::Version`**  
*`LogicalId`: *`<function‑LogicalId>Version<sha>`  
`<sha>`ist ein eindeutiger Hashwert, der bei der Erstellung des Stacks generiert wird. Zum Beispiel *MyFunction* Version*926eeb5ff1*.  
*Referenzierbare Eigenschaft:* `<function‑LogicalId>.Version`

Weitere Informationen zur `AutoPublishAlias` Eigenschaft finden Sie im [Abschnitt Eigenschaften von AWS::Serverless::Function](sam-resource-function.md#sam-resource-function-properties).

### DeploymentPreference Eigenschaft ist angegeben
<a name="sam-specification-generated-resources-function-deploymentpreference"></a>

Wenn die `DeploymentPreference` Eigenschaft von an angegeben `AWS::Serverless::Function` ist, werden die folgenden CloudFormation Ressourcen AWS SAM generiert: `AWS::CodeDeploy::Application` und`AWS::CodeDeploy::DeploymentGroup`. Wenn die `Role` Eigenschaft des `DeploymentPreference` Objekts *nicht* angegeben ist, wird AWS SAM außerdem eine `AWS::IAM::Role` CloudFormation Ressource generiert.

**`AWS::CodeDeploy::Application`**  
*`LogicalId`: *`ServerlessDeploymentApplication`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

**`AWS::CodeDeploy::DeploymentGroup`**  
*`LogicalId`: *`<function‑LogicalId>DeploymentGroup`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen das verwenden, um auf diese Ressource `LogicalId` zu verweisen) CloudFormation 

**`AWS::IAM::Role`**  
*`LogicalId`: *`CodeDeployServiceRole`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen das verwenden, um auf diese Ressource `LogicalId` zu verweisen) CloudFormation 

### FunctionUrlConfig Eigenschaft ist angegeben
<a name="sam-specification-generated-resources-function-functionurlconfig"></a>

Wenn die `FunctionUrlConfig` Eigenschaft angegeben ist, AWS SAM generiert verschiedene CloudFormation Ressourcen auf der Grundlage von`AuthType`.

Wenn `AuthType: NONE` angegeben, werden die folgenden CloudFormation Ressourcen AWS SAM generiert:

**`AWS::Lambda::Permission`(Zugriff aufrufen)**  
*`LogicalId`: *`<function‑LogicalId>URLInvokeAllowPublicAccess`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese Ressource `LogicalId` zu verweisen) CloudFormation 

**`AWS::Lambda::Permission`(Öffentlicher Zugang)**  
*`LogicalId`: *`<function‑LogicalId>UrlPublicPermissions`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen das verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

**`AWS::Lambda::Url`**  
*`LogicalId`: *`<function‑LogicalId>Url`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen das verwenden, um auf diese Ressource `LogicalId` zu verweisen) CloudFormation 

Wenn `AuthType: AWS_IAM` angegeben, AWS SAM generiert nur:

**`AWS::Lambda::Url`**  
*`LogicalId`: *`<function‑LogicalId>Url`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

Weitere Informationen zur `FunctionUrlConfig` Eigenschaft finden Sie unter. [FunctionUrlConfig](sam-property-function-functionurlconfig.md)

## Ereignisquellen
<a name="sam-specification-generated-resources-function-event-sources"></a>

In den folgenden Szenarien werden CloudFormation Ressourcen auf der Grundlage von Ereignisquellen generiert:

### Eine API-Ereignisquelle ist angegeben
<a name="sam-specification-generated-resources-function-api"></a>

Wenn die `Event` Eigenschaft von auf gesetzt `AWS::Serverless::Function` ist`Api`, die `RestApiId` Eigenschaft aber *nicht* angegeben ist, wird die `AWS::ApiGateway::RestApi` CloudFormation Ressource AWS SAM generiert.

**`AWS::ApiGateway::RestApi`**  
*`LogicalId`: *`ServerlessRestApi`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

### Eine HttpApi Ereignisquelle ist angegeben
<a name="sam-specification-generated-resources-function-httpapi"></a>

Wenn die `Event` Eigenschaft von auf gesetzt `AWS::Serverless::Function` ist`HttpApi`, die `ApiId` Eigenschaft aber *nicht* angegeben ist, wird die `AWS::ApiGatewayV2::Api` CloudFormation Ressource AWS SAM generiert.

**`AWS::ApiGatewayV2::Api`**  
*`LogicalId`: *`ServerlessHttpApi`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

### Eine Quelle für Streaming-Ereignisse ist angegeben
<a name="sam-specification-generated-resources-function-streaming"></a>

Wenn die `Event` Eigenschaft von auf einen der Streaming-Typen gesetzt `AWS::Serverless::Function` ist, AWS SAM wird die `AWS::Lambda::EventSourceMapping` CloudFormation Ressource generiert. Dies gilt für die folgenden Typen: `DynamoDB``Kinesis`,`MQ`,`MSK`, und`SQS`.

**`AWS::Lambda::EventSourceMapping`**  
*`LogicalId`: *`<function‑LogicalId><event‑LogicalId>`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

### Eine Ereignisquelle für eine Event-Bridge (oder einen Event-Bus) wurde angegeben
<a name="sam-specification-generated-resources-function-eventbridge"></a>

Wenn die `Event` Eigenschaft von auf einen der Typen Event Bridge (oder Event Bus) gesetzt `AWS::Serverless::Function` ist, AWS SAM wird die `AWS::Events::Rule` CloudFormation Ressource generiert. Dies gilt für die folgenden Typen: `EventBridgeRule``Schedule`, und`CloudWatchEvents`.

**`AWS::Events::Rule`**  
*`LogicalId`: *`<function‑LogicalId><event‑LogicalId>`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

### Eine IotRule Ereignisquelle ist angegeben
<a name="sam-specification-generated-resources-function-iotrule"></a>

Wenn die `Event` Eigenschaft von an auf Io gesetzt `AWS::Serverless::Function` istTRule, wird die `AWS::IoT::TopicRule` CloudFormation Ressource AWS SAM generiert.

**`AWS::IoT::TopicRule`**  
*`LogicalId`: *`<function‑LogicalId><event‑LogicalId>`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

## Konfiguration des Ereignisses
<a name="sam-specification-generated-resources-function-event-configuration"></a>

In den folgenden Szenarien werden CloudFormation Ressourcen basierend auf der Ereigniskonfiguration generiert:

### OnSuccess (oder OnFailure) Die Eigenschaft ist für Amazon SNS SNS-Ereignisse angegeben
<a name="sam-specification-generated-resources-function-sns-onsuccess"></a>

Wenn die Eigenschaft `OnSuccess` (oder`OnFailure`) der `DestinationConfig` Eigenschaft der `EventInvokeConfig` Eigenschaft von an angegeben `AWS::Serverless::Function` ist und der Zieltyp ist, `SNS` aber der Ziel-ARN *nicht* angegeben ist, werden die folgenden CloudFormation Ressourcen AWS SAM generiert: `AWS::Lambda::EventInvokeConfig` und`AWS::SNS::Topic`.

**`AWS::Lambda::EventInvokeConfig`**  
*`LogicalId`: *`<function‑LogicalId>EventInvokeConfig`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

**`AWS::SNS::Topic`**  
*`LogicalId`: `<function‑LogicalId>OnSuccessTopic` (oder*) `<function‑LogicalId>OnFailureTopic`  
*Referenzierbares Eigentum:* `<function‑LogicalId>.DestinationTopic`  
Wenn beide `OnSuccess` und für ein Amazon SNS SNS-Ereignis angegeben `OnFailure` sind, müssen Sie zur Unterscheidung zwischen den generierten Ressourcen den `LogicalId` verwenden.

### OnSuccess (oder OnFailure) Die Eigenschaft ist für Amazon SQS SQS-Ereignisse angegeben
<a name="sam-specification-generated-resources-function-sqs-onsuccess"></a>

Wenn die Eigenschaft `OnSuccess` (oder`OnFailure`) der `DestinationConfig` Eigenschaft der `EventInvokeConfig` Eigenschaft von an angegeben `AWS::Serverless::Function` ist und der Zieltyp ist, `SQS` aber der Ziel-ARN *nicht* angegeben ist, werden die folgenden CloudFormation Ressourcen AWS SAM generiert: `AWS::Lambda::EventInvokeConfig` und`AWS::SQS::Queue`.

**`AWS::Lambda::EventInvokeConfig`**  
*`LogicalId`: *`<function‑LogicalId>EventInvokeConfig`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

**`AWS::SQS::Queue`**  
*`LogicalId`: `<function‑LogicalId>OnSuccessQueue` (oder*) `<function‑LogicalId>OnFailureQueue`  
*Referenzierbares Eigentum:* `<function‑LogicalId>.DestinationQueue`  
Wenn beide `OnSuccess` und für ein Amazon SQS SQS-Ereignis angegeben `OnFailure` sind, müssen Sie zur Unterscheidung zwischen den generierten Ressourcen den `LogicalId` verwenden.

# CloudFormation Ressourcen, die generiert werdenAWS::Serverless::GraphQLApi, wenn angegeben
<a name="sam-specification-generated-resources-graphqlapi"></a>

Wenn Sie eine `AWS::Serverless::GraphQLApi` Ressource in einer Vorlage AWS Serverless Application Model (AWS SAM) angeben, werden AWS SAM immer die folgenden AWS CloudFormation Basisressourcen erstellt.

**`AWS::AppSync::DataSource`**  
*`LogicalId`: *`<graphqlapi-LogicalId><datasource-RelativeId><datasource-Type>DataSource`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen die verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

**`AWS::AppSync::FunctionConfiguration`**  
*`LogicalId`: *`<graphqlapi-LogicalId><function-RelativeId>`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen das verwenden, um auf diese Ressource `LogicalId` zu verweisen) CloudFormation 

**`AWS::AppSync::GraphQLApi`**  
*`LogicalId`: *`<graphqlapi-LogicalId>`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen das verwenden, um auf diese Ressource `LogicalId` zu verweisen) CloudFormation 

**`AWS::AppSync::GraphQLSchema`**  
*`LogicalId`: *`<graphqlapi-LogicalId>Schema`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen das verwenden, um auf diese Ressource `LogicalId` zu verweisen) CloudFormation 

**`AWS::AppSync::Resolver`**  
*`LogicalId`: *`<graphqlapi-LogicalId><OperationType><resolver-RelativeId>`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen das verwenden, um auf diese Ressource `LogicalId` zu verweisen) CloudFormation 

Zusätzlich zu diesen CloudFormation Ressourcen AWS SAM können, sofern `AWS::Serverless::GraphQLApi` angegeben, auch die folgenden CloudFormation Ressourcen generiert werden.

`AWS::AppSync::ApiCache`  
*`LogicalId`: *`<graphqlapi-LogicalId>ApiCache`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

`AWS::AppSync::ApiKey`  
*`LogicalId`: *`<graphqlapi-LogicalId><apikey-RelativeId>`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen das verwenden, um auf diese Ressource `LogicalId` zu verweisen) CloudFormation 

`AWS::AppSync::DomainName`  
*`LogicalId`: *`<graphqlapi-LogicalId>DomainName`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen das verwenden, um auf diese Ressource `LogicalId` zu verweisen) CloudFormation 

`AWS::AppSync::DomainNameApiAssociation`  
*`LogicalId`: *`<graphqlapi-LogicalId>DomainNameApiAssociation`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen das verwenden, um auf diese Ressource `LogicalId` zu verweisen) CloudFormation 

AWS SAM kann die `AWS::Serverless::Connector` Ressource auch verwenden, um Berechtigungen bereitzustellen. Weitere Informationen finden Sie unter [CloudFormation Ressourcen, die generiert werden, wenn Sie angeben AWS::Serverless::Connector](sam-specification-generated-resources-connector.md).

# CloudFormation Ressourcen, die generiert werden AWS::Serverless::HttpApi , wenn angegeben
<a name="sam-specification-generated-resources-httpapi"></a>

Wenn an angegeben `AWS::Serverless::HttpApi` ist, generiert AWS Serverless Application Model (AWS SAM) eine `AWS::ApiGatewayV2::Api` CloudFormation Basisressource.

**`AWS::ApiGatewayV2::Api`**  
*`LogicalId`: *`<httpapi‑LogicalId>`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

Zusätzlich zu dieser CloudFormation Ressource werden, wenn `AWS::Serverless::HttpApi` angegeben, AWS SAM auch CloudFormation Ressourcen für die folgenden Szenarien generiert:

**Topics**
+ [StageName Eigenschaft ist angegeben](#sam-specification-generated-resources-httpapi-stage-name)
+ [StageName Eigenschaft ist *nicht spezifiziert*](#sam-specification-generated-resources-httpapi-not-stage-name)
+ [DomainName Eigenschaft ist spezifiziert](#sam-specification-generated-resources-httpapi-domain-name)

## StageName Eigenschaft ist angegeben
<a name="sam-specification-generated-resources-httpapi-stage-name"></a>

Wenn die `StageName` Eigenschaft von an angegeben `AWS::Serverless::HttpApi` ist, wird die `AWS::ApiGatewayV2::Stage` CloudFormation Ressource AWS SAM generiert.

**`AWS::ApiGatewayV2::Stage`**  
*`LogicalId`: *`<httpapi‑LogicalId><stage‑name>Stage`  
`<stage‑name>`ist die Zeichenfolge, auf die die `StageName` Eigenschaft gesetzt ist. Wenn Sie beispielsweise `StageName` auf einstellen`Gamma`, `LogicalId` ist dies: *MyHttpApiGamma* Phase.  
*Referenzierbare Eigenschaft:* `<httpapi‑LogicalId>.Stage`

## StageName Eigenschaft ist *nicht spezifiziert*
<a name="sam-specification-generated-resources-httpapi-not-stage-name"></a>

Wenn die `StageName` Eigenschaft von an *nicht* angegeben `AWS::Serverless::HttpApi` ist, wird die `AWS::ApiGatewayV2::Stage` CloudFormation Ressource AWS SAM generiert.

**`AWS::ApiGatewayV2::Stage`**  
*`LogicalId`: *`<httpapi‑LogicalId>ApiGatewayDefaultStage`  
*Referenzierbare Eigenschaft:* `<httpapi‑LogicalId>.Stage`

## DomainName Eigenschaft ist spezifiziert
<a name="sam-specification-generated-resources-httpapi-domain-name"></a>

Wenn die `DomainName` Eigenschaft der `Domain` Eigenschaft von an angegeben `AWS::Serverless::HttpApi` ist, wird die `AWS::ApiGatewayV2::DomainName` CloudFormation Ressource AWS SAM generiert.

**`AWS::ApiGatewayV2::DomainName`**  
*`LogicalId`: *`ApiGatewayDomainNameV2<sha>`  
`<sha>`ist ein eindeutiger Hashwert, der generiert wird, wenn der Stack erstellt wird. Beispiel, `ApiGatewayDomainNameV2`*926eeb5ff1*.  
*Referenzierbare Eigenschaft:* `<httpapi‑LogicalId>.DomainName`

# CloudFormation Ressourcen, die generiert werdenAWS::Serverless::LayerVersion, wenn angegeben
<a name="sam-specification-generated-resources-layerversion"></a>

Wenn an angegeben `AWS::Serverless::LayerVersion` ist, generiert AWS Serverless Application Model (AWS SAM) eine `AWS::Lambda::LayerVersion` CloudFormation Basisressource.

**`AWS::Lambda::LayerVersion`**  
*`LogicalId`: *`<layerversion‑LogicalId>`   
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

# CloudFormation Ressourcen, die generiert werdenAWS::Serverless::SimpleTable, wenn angegeben
<a name="sam-specification-generated-resources-simpletable"></a>

Wenn an angegeben `AWS::Serverless::SimpleTable` ist, generiert AWS Serverless Application Model (AWS SAM) eine `AWS::DynamoDB::Table` CloudFormation Basisressource.

**`AWS::DynamoDB::Table`**  
*`LogicalId`: *`<simpletable‑LogicalId>`   
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

# CloudFormation Ressourcen, die generiert werdenAWS::Serverless::StateMachine, wenn angegeben
<a name="sam-specification-generated-resources-statemachine"></a>

Wenn an angegeben `AWS::Serverless::StateMachine` ist, generiert AWS Serverless Application Model (AWS SAM) eine `AWS::StepFunctions::StateMachine` CloudFormation Basisressource.

**`AWS::StepFunctions::StateMachine`**  
*`LogicalId`: *`<statemachine‑LogicalId>`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

Zusätzlich zu dieser CloudFormation Ressource werden, wenn `AWS::Serverless::StateMachine` angegeben, AWS SAM auch CloudFormation Ressourcen für die folgenden Szenarien generiert:

**Topics**
+ [Die Rolleneigenschaft ist nicht angegeben](#sam-specification-generated-resources-statemachine-not-role)
+ [Eine API-Ereignisquelle ist angegeben](#sam-specification-generated-resources-statemachine-api)
+ [Eine Ereignisquelle für eine Event-Bridge (oder einen Event-Bus) wurde angegeben](#sam-specification-generated-resources-statemachine-eventbridge)

## Die Rolleneigenschaft ist nicht angegeben
<a name="sam-specification-generated-resources-statemachine-not-role"></a>

Wenn die `Role` Eigenschaft von *nicht* angegeben `AWS::Serverless::StateMachine` ist, wird eine `AWS::IAM::Role` CloudFormation Ressource AWS SAM generiert.

**`AWS::IAM::Role`**  
*`LogicalId`: *`<statemachine‑LogicalId>Role`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

## Eine API-Ereignisquelle ist angegeben
<a name="sam-specification-generated-resources-statemachine-api"></a>

Wenn die `Event` Eigenschaft von auf gesetzt `AWS::Serverless::StateMachine` ist`Api`, die `RestApiId` Eigenschaft aber *nicht* angegeben ist, wird die `AWS::ApiGateway::RestApi` CloudFormation Ressource AWS SAM generiert.

**`AWS::ApiGateway::RestApi`**  
*`LogicalId`: *`ServerlessRestApi`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

## Eine Ereignisquelle für eine Event-Bridge (oder einen Event-Bus) wurde angegeben
<a name="sam-specification-generated-resources-statemachine-eventbridge"></a>

Wenn die `Event` Eigenschaft von auf einen der Typen Event Bridge (oder Event Bus) gesetzt `AWS::Serverless::StateMachine` ist, AWS SAM wird die `AWS::Events::Rule` CloudFormation Ressource generiert. Dies gilt für die folgenden Typen: `EventBridgeRule``Schedule`, und`CloudWatchEvents`.

**`AWS::Events::Rule`**  
*`LogicalId`: *`<statemachine‑LogicalId><event‑LogicalId>`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

# Ressourcenattribute, unterstützt von AWS SAM
<a name="sam-specification-resource-attributes"></a>

Ressourcenattribute sind Attribute, die Sie hinzufügen können, AWS SAM und CloudFormation Ressourcen, um zusätzliche Verhaltensweisen und Beziehungen zu steuern. Weitere Informationen zu Ressourcenattributen finden Sie unter [Referenz zu Ressourcenattributen](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-product-attribute-reference.html) im *AWS CloudFormation Benutzerhandbuch*.

AWS SAM unterstützt eine Teilmenge von Ressourcenattributen, die von CloudFormation definiert sind. Einige der unterstützten Ressourcenattribute werden nur auf die generierte CloudFormation Basisressource der entsprechenden AWS SAM Ressource kopiert, andere wiederum auf alle generierten CloudFormation Ressourcen, die sich aus der entsprechenden AWS SAM Ressource ergeben. Weitere Hinweise zu CloudFormation Ressourcen, die aus entsprechenden AWS SAM Ressourcen generiert wurden, finden Sie unter[Generierte CloudFormation Ressourcen für AWS SAM](sam-specification-generated-resources.md).

In der folgenden Tabelle wird die Unterstützung von Ressourcenattributen zusammengefasst AWS SAM, abhängig von den unten [Ausnahmen](#sam-specification-resource-attributes-exceptions) aufgeführten Kriterien.


| Ressourcenattribute | Vom Ziel generierte Ressource (n) | 
| --- | --- | 
|  ** [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) ** **[Metadaten](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html)** 1, 2  |  Nur von der Basis CloudFormation generierte Ressource. Informationen zur Zuordnung zwischen AWS SAM Ressourcen und CloudFormation Basisressourcen finden Sie unter[Generierte CloudFormation Ressourcenszenarien](sam-specification-generated-resources.md#sam-specification-generated-resources-scenarios).  | 
| **[Zustand](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html)** ** [DeletionPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) ** ** [UpdateReplacePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) **  |  Alle generierten CloudFormation Ressourcen aus der entsprechenden AWS SAM Ressource. Hinweise zu Szenarien für generierte CloudFormation Ressourcen finden Sie unter[Generierte CloudFormation Ressourcenszenarien](sam-specification-generated-resources.md#sam-specification-generated-resources-scenarios).  | 

**Hinweise:**

1. Weitere Hinweise zur Verwendung des `Metadata` Ressourcenattributs mit dem `AWS::Serverless::Function` Ressourcentyp finden Sie unter[Erstellen von Lambda-Funktionen mit benutzerdefinierten Laufzeiten in AWS SAM](building-custom-runtimes.md).

1. Weitere Hinweise zur Verwendung des `Metadata` Ressourcenattributs mit dem `AWS::Serverless::LayerVersion` Ressourcentyp finden Sie unter[Aufbau von Lambda-Schichten in AWS SAM](building-layers.md).

## Ausnahmen
<a name="sam-specification-resource-attributes-exceptions"></a>

Es gibt eine Reihe von Ausnahmen zu den zuvor beschriebenen Regeln für Ressourcenattribute:
+ Für `RetentionPolicy` legt `AWS::Lambda::LayerVersion` das benutzerdefinierte Feld AWS SAM-only das `DeletionPolicy` für die generierten CloudFormation Ressourcen fest. Dies hat eine höhere Priorität als `DeletionPolicy` es selbst. Wenn keiner von beiden festgelegt ist, `DeletionPolicy` ist standardmäßig auf `Retain` gesetzt.
+ Wenn nicht angegeben, `DeletionPolicy` ist die Standardeinstellung`Retain`. `AWS::Lambda::Version`
+ In dem Szenario, in dem dies für eine serverlose Funktion angegeben `DeploymentPreferences` ist, werden Ressourcenattribute nicht auf die folgenden generierten CloudFormation Ressourcen kopiert:
  + `AWS::CodeDeploy::Application`
  + `AWS::CodeDeploy::DeploymentGroup`
  + Der `AWS::IAM::Role` Name`CodeDeployServiceRole`, der für dieses Szenario erstellt wurde
+ Wenn Ihre AWS SAM Vorlage mehrere Funktionen mit implizit erstellten API-Ereignisquellen enthält, teilen sich die Funktionen die generierte `AWS::ApiGateway::RestApi` Ressource. Wenn die Funktionen in diesem Szenario unterschiedliche Ressourcenattribute haben, werden die `AWS::ApiGateway::RestApi` Ressourcenattribute für die generierte Ressource gemäß den folgenden priorisierten Listen AWS SAM kopiert:
  + `UpdateReplacePolicy`:

    1. `Retain`

    1. `Snapshot`

    1. `Delete`
  + `DeletionPolicy`:

    1. `Retain`

    1. `Delete`

# API-Gateway-Erweiterungen für AWS SAM
<a name="sam-specification-api-gateway-extensions"></a>

API Gateway Gateway-Erweiterungen, die speziell für entwickelt wurden AWS, bieten zusätzliche Anpassungen und Funktionen für Design und Verwaltung APIs. API Gateway Gateway-Erweiterungen sind Erweiterungen der OpenAPI-Spezifikation, die die AWS-spezifische Autorisierung und API Gateway Gateway-spezifische API-Integrationen unterstützen. Weitere Informationen zu API-Gateway-Erweiterungen finden Sie unter [API-Gateway-Erweiterungen für OpenAPI](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html).

AWS SAM unterstützt eine Teilmenge von API Gateway Gateway-Erweiterungen. In der folgenden Tabelle können Sie nachlesen AWS SAM, welche API-Gateway-Erweiterungen unterstützt werden.


|  |  | 
| --- |--- |
|  API-Gateway-Erweiterung  |  Unterstützt von AWS SAM  | 
| [x-amazon-apigateway-any-method Objekt](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-any-method.html) | Ja | 
| [x-amazon-apigateway-api-key-source-Eigenschaft](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-api-key-source.html) | Nein | 
| [x-amazon-apigateway-auth Objekt](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-auth.html) | Ja | 
| [x-amazon-apigateway-authorizer Objekt](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-authorizer.html) | Ja | 
| [x-amazon-apigateway-authtype Eigenschaft](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-authtype.html) | Ja | 
| [x-amazon-apigateway-binary-media-types-Eigenschaft](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-binary-media-types.html) | Ja | 
| [x-amazon-apigateway-documentation Objekt](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-documentation.html) | Nein | 
| [x-amazon-apigateway-endpoint-configuration-Objekt](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-endpoint-configuration.html) | Nein | 
| [x-amazon-apigateway-gatewayObjekt -responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-gateway-responses.html) | Ja | 
| [x-amazon-apigateway-gateway-Responses.GatewayResponse-Objekt](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-gateway-responses.gatewayResponse.html) | Ja | 
| [x-amazon-apigateway-gateway-Responses.ResponseParameters-Objekt](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-gateway-responses.responseParameters.html) | Ja | 
| [x-amazon-apigateway-gateway-Responses.ResponseTemplates-Objekt](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-gateway-responses.responseTemplates.html) | Ja | 
| [x-amazon-apigateway-integration Objekt](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration.html) | Ja | 
| [x-amazon-apigateway-integration.requestTemplates-Objekt](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestTemplates.html) | Ja | 
| [x-amazon-apigateway-integration.RequestParameter-Objekt](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestParameters.html) | Nein | 
| [x-amazon-apigateway-integration.responses-Objekt](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-responses.html) | Ja | 
| [x-amazon-apigateway-integration.response-Objekt](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-response.html) | Ja | 
| [x-amazon-apigateway-integration.responseTemplates-Objekt](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-responseTemplates.html) | Ja | 
| [x-amazon-apigateway-integration.responseParameters-Objekt](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-responseParameters.html) | Ja | 
| [x-amazon-apigateway-request-validator-Eigenschaft](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-request-validator.html) | Nein | 
| [x-amazon-apigateway-request-validators-Objekt](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-request-validators.html) | Nein | 
| [x-amazon-apigateway-request-Validators.RequestValidator-Objekt](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-request-validators.requestValidator.html) | Nein | 

# Intrinsische Funktionen für AWS SAM
<a name="sam-specification-intrinsic-functions"></a>

Systeminterne Funktionen sind integrierte Funktionen, mit denen Sie Eigenschaften Werte zuweisen können, die nur zur Laufzeit verfügbar sind. AWS SAM unterstützt bestimmte intrinsische Funktionseigenschaften nur begrenzt und ist daher nicht in der Lage, einige systeminterne Funktionen aufzulösen. Daher empfehlen wir, die `AWS::LanguageExtensions` Transformation hinzuzufügen, um dieses Problem zu beheben. Das `AWS::LanguageExtensions` ist ein von gehostetes Makro CloudFormation , mit dem Sie systeminterne Funktionen und andere Funktionen verwenden können, die standardmäßig nicht in enthalten sind. CloudFormation

```
Transform:
  - AWS::LanguageExtensions
  - AWS::Serverless-2016-10-31
```

**Anmerkung**  
Wenn Sie systeminterne Funktionen in einer CodeUri Eigenschaft verwenden, können AWS SAM die Werte nicht korrekt analysiert werden. Erwägen Sie stattdessen die Verwendung von Transform`AWS::LanguageExtensions`.  
Weitere Informationen finden Sie im [Abschnitt Eigenschaften von AWS::Serverless::Function](sam-resource-function.md#sam-resource-function-properties).

*Weitere Informationen zu systeminternen Funktionen finden Sie im Benutzerhandbuch unter [Intrinsic Function Reference.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference.html)AWS CloudFormation *