

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.

# CloudFormation Ressourcen, die generiert werden AWS::Serverless::WebSocketApi , wenn angegeben
<a name="sam-specification-generated-resources-websocketapi"></a>

Wenn an angegeben `AWS::Serverless::WebSocketApi` ist, generiert AWS Serverless Application Model (AWS SAM) eine `AWS::ApiGatewayV2::Api` CloudFormation Basisressource. Darüber hinaus generiert es immer eine `AWS::ApiGatewayV2::Stage` Ressource und AWS SAM generiert für jede in der `Routes` Eigenschaft definierte Route`AWS::ApiGatewayV2::Route`,`AWS::ApiGatewayV2::Integration`, und `AWS::Lambda::Permission` Ressourcen.

**`AWS::ApiGatewayV2::Api`**  
*`LogicalId`: *`{{<websocketapi‑LogicalId>}}`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

**`AWS::ApiGatewayV2::Stage`**  
*`LogicalId`: *`{{<websocketapi‑LogicalId>}}{{<stage‑name>}}Stage`  
`{{<stage‑name>}}`ist die Zeichenfolge, auf die die `StageName` Eigenschaft gesetzt ist. Wenn `StageName` nicht angegeben, ist der Standardwert`default`. Wenn Sie beispielsweise `StageName` auf einstellen`prod`, `LogicalId` ist der`{{MyWebSocketApi}}prodStage`.  
*Referenzierbare Eigenschaft:* `{{<websocketapi‑LogicalId>}}.Stage`

**`AWS::ApiGatewayV2::Route`**  
*`LogicalId`: *`{{<websocketapi‑LogicalId>}}{{<normalized‑route‑key>}}Route`  
`{{<normalized‑route‑key>}}`ist der Routenschlüssel ohne Sonderzeichen. Zum Beispiel ist für den Routenschlüssel `$connect` `LogicalId` der`{{MyWebSocketApi}}connectRoute`.  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

**`AWS::ApiGatewayV2::Integration`**  
*`LogicalId`: *`{{<websocketapi‑LogicalId>}}{{<normalized‑route‑key>}}Integration`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen das verwenden, um auf diese Ressource `LogicalId` zu verweisen) CloudFormation 

**`AWS::Lambda::Permission`**  
*`LogicalId`: *`{{<websocketapi‑LogicalId>}}{{<normalized‑route‑key>}}Permission`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen das verwenden, um auf diese Ressource `LogicalId` zu verweisen) CloudFormation 

Wenn `AWS::Serverless::WebSocketApi` angegeben, werden zusätzlich zu diesen CloudFormation Ressourcen AWS SAM auch CloudFormation Ressourcen für die folgenden Szenarien generiert:

**Topics**
+ [Die Auth-Eigenschaft ist mit dem Wert AuthType CUSTOM angegeben](#sam-specification-generated-resources-websocketapi-auth)
+ [DomainName Eigenschaft ist angegeben](#sam-specification-generated-resources-websocketapi-domain-name)
+ [BasePath Eigenschaft ist angegeben](#sam-specification-generated-resources-websocketapi-basepath)
+ [Die Route53-Eigenschaft ist angegeben](#sam-specification-generated-resources-websocketapi-route53)

## Die Auth-Eigenschaft ist mit dem Wert AuthType CUSTOM angegeben
<a name="sam-specification-generated-resources-websocketapi-auth"></a>

Wenn die `Auth` Eigenschaft von mit `AuthType` set to angegeben `AWS::Serverless::WebSocketApi` wird`CUSTOM`, wird eine `AWS::ApiGatewayV2::Authorizer` CloudFormation Ressource AWS SAM generiert. Wenn nicht angegeben, `InvokeRole` wird AWS SAM auch eine `AWS::Lambda::Permission` Ressource generiert, die es API Gateway ermöglicht, die Autorisierungsfunktion aufzurufen.

**`AWS::ApiGatewayV2::Authorizer`**  
*`LogicalId`: *`{{<websocketapi‑LogicalId>}}Authorizer`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese Ressource `LogicalId` zu verweisen) CloudFormation 

**`AWS::Lambda::Permission`(wann `InvokeRole` ist nicht angegeben)**  
*`LogicalId`: *`{{<websocketapi‑LogicalId>}}AuthorizerPermission`  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

## DomainName Eigenschaft ist angegeben
<a name="sam-specification-generated-resources-websocketapi-domain-name"></a>

Wenn die `DomainName` Eigenschaft der `Domain` Eigenschaft von an angegeben `AWS::Serverless::WebSocketApi` ist, wird die `AWS::ApiGatewayV2::DomainName` CloudFormation Ressource AWS SAM generiert.

**`AWS::ApiGatewayV2::DomainName`**  
*`LogicalId`: *`ApiGatewayDomainNameV2{{<sha>}}`  
`{{<sha>}}`ist ein eindeutiger Hashwert, der bei der Erstellung des Stacks generiert wird. Beispiel: `ApiGatewayDomainNameV2{{926eeb5ff1}}`.  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

## BasePath Eigenschaft ist angegeben
<a name="sam-specification-generated-resources-websocketapi-basepath"></a>

Wenn die `BasePath` `Domain` Eigenschaft einer angegeben `AWS::Serverless::WebSocketApi` ist, werden `AWS::ApiGatewayV2::ApiMapping` CloudFormation Ressourcen AWS SAM generiert, eine für jeden angegebenen Basispfad.

**`AWS::ApiGatewayV2::ApiMapping`**  
*`LogicalId`: *`{{<websocketapi‑LogicalId>}}{{<basepath>}}ApiMapping`  
`{{<basepath>}}`ist der Basispfadwert. Wenn Sie beispielsweise `v1` als Basispfad angeben, `LogicalId` ist der`{{MyWebSocketApi}}v1ApiMapping`.  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )

## Die Route53-Eigenschaft ist angegeben
<a name="sam-specification-generated-resources-websocketapi-route53"></a>

Wenn die `Route53` Eigenschaft einer angegeben `AWS::Serverless::WebSocketApi` ist, wird eine `AWS::Route53::RecordSetGroup` CloudFormation Ressource AWS SAM generiert. `Domain`

**`AWS::Route53::RecordSetGroup`**  
*`LogicalId`: *`RecordSetGroup{{<sha>}}`  
`{{<sha>}}`ist ein eindeutiger Hashwert, der bei der Erstellung des Stacks generiert wird. Beispiel: `RecordSetGroup{{926eeb5ff1}}`.  
*Referenzierbare Eigenschaft:* N/A (Sie müssen den verwenden, um auf diese `LogicalId` Ressource zu verweisen CloudFormation )