

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.

# 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
```