View a markdown version of this page

CloudFormation risorse generate quando AWS::Serverless::WebSocketApi è specificato - AWS Serverless Application Model
La proprietà Auth viene specificata con AuthType set to CUSTOMDomainName la proprietà è specificataBasePath la proprietà è specificataLa proprietà Route53 è specificata

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

CloudFormation risorse generate quando AWS::Serverless::WebSocketApi è specificato

Quando AWS::Serverless::WebSocketApi viene specificato un, AWS Serverless Application Model (AWS SAM) genera una CloudFormation risorsa di AWS::ApiGatewayV2::Api base. Inoltre, genera sempre una AWS::ApiGatewayV2::Stage risorsa e, per ogni percorso definito nella Routes proprietà AWS::ApiGatewayV2::RouteAWS::ApiGatewayV2::Integration, AWS SAM genera e AWS::Lambda::Permission risorse.

AWS::ApiGatewayV2::Api

LogicalId: <websocketapi‑LogicalId>

Proprietà referenziabile: N/A (è necessario utilizzare per fare riferimento LogicalId a questa risorsa) CloudFormation

AWS::ApiGatewayV2::Stage

LogicalId: <websocketapi‑LogicalId><stage‑name>Stage

<stage‑name>è la stringa su cui è impostata la StageName proprietà. Se non StageName è specificato, il valore predefinito èdefault. Ad esempio, se si imposta StageName suprod, LogicalId èMyWebSocketApiprodStage.

Proprietà referenziabile: <websocketapi‑LogicalId>.Stage

AWS::ApiGatewayV2::Route

LogicalId: <websocketapi‑LogicalId><normalized‑route‑key>Route

<normalized‑route‑key>è la chiave di percorso con caratteri speciali rimossi. Ad esempio, per la chiave route$connect, LogicalId isMyWebSocketApiconnectRoute.

Proprietà referenziabile: N/A (è necessario utilizzare per fare riferimento LogicalId a questa risorsa) CloudFormation

AWS::ApiGatewayV2::Integration

LogicalId: <websocketapi‑LogicalId><normalized‑route‑key>Integration

Proprietà referenziabile: N/A (è necessario utilizzare il per fare riferimento a questa risorsa) LogicalId CloudFormation

AWS::Lambda::Permission

LogicalId: <websocketapi‑LogicalId><normalized‑route‑key>Permission

Proprietà referenziabile: N/A (è necessario utilizzare il per fare riferimento a questa risorsa) LogicalId CloudFormation

Oltre a queste CloudFormation risorse, quando AWS::Serverless::WebSocketApi specificato, genera AWS SAM anche CloudFormation risorse per i seguenti scenari:

La proprietà Auth viene specificata con AuthType set to CUSTOM

Quando la Auth proprietà di an AWS::Serverless::WebSocketApi viene specificata con AuthType set toCUSTOM, AWS SAM genera una AWS::ApiGatewayV2::Authorizer CloudFormation risorsa. Se non InvokeRole è specificato, genera AWS SAM anche una AWS::Lambda::Permission risorsa per consentire ad API Gateway di richiamare la funzione di autorizzazione.

AWS::ApiGatewayV2::Authorizer

LogicalId: <websocketapi‑LogicalId>Authorizer

Proprietà referenziabile: N/A (è necessario utilizzare per fare riferimento a questa risorsa) LogicalId CloudFormation

AWS::Lambda::Permission(quando InvokeRole non è specificato)

LogicalId: <websocketapi‑LogicalId>AuthorizerPermission

Proprietà referenziabile: N/A (è necessario utilizzare il LogicalId per fare riferimento a questa risorsa) CloudFormation

DomainName la proprietà è specificata

Quando AWS::Serverless::WebSocketApi viene specificata la Domain proprietà della proprietà di an, AWS SAM genera la AWS::ApiGatewayV2::DomainName CloudFormation risorsa. DomainName

AWS::ApiGatewayV2::DomainName

LogicalId: ApiGatewayDomainNameV2<sha>

<sha>è un valore hash univoco che viene generato quando viene creato lo stack. Ad esempio: ApiGatewayDomainNameV2926eeb5ff1.

Proprietà referenziabile: N/A (è necessario utilizzare il per fare riferimento a questa risorsa) LogicalId CloudFormation

BasePath la proprietà è specificata

Quando AWS::Serverless::WebSocketApi viene specificata la Domain proprietà della proprietà di an, AWS SAM genera AWS::ApiGatewayV2::ApiMapping CloudFormation risorse, una per ogni percorso di base specificato. BasePath

AWS::ApiGatewayV2::ApiMapping

LogicalId: <websocketapi‑LogicalId><basepath>ApiMapping

<basepath>è il valore del percorso di base. Ad esempio, se si specifica v1 come percorso di base, LogicalId èMyWebSocketApiv1ApiMapping.

Proprietà referenziabile: N/A (è necessario utilizzare il LogicalId per fare riferimento a questa risorsa) CloudFormation

La proprietà Route53 è specificata

Quando AWS::Serverless::WebSocketApi viene specificata la Domain proprietà della proprietà di an, AWS SAM genera una AWS::Route53::RecordSetGroup CloudFormation risorsa. Route53

AWS::Route53::RecordSetGroup

LogicalId: RecordSetGroup<sha>

<sha>è un valore hash univoco che viene generato quando viene creato lo stack. Ad esempio: RecordSetGroup926eeb5ff1.

Proprietà referenziabile: N/A (è necessario utilizzare il per fare riferimento a questa risorsa) LogicalId CloudFormation