View a markdown version of this page

CloudFormation recursos generados cuando AWS::Serverless::WebSocketApi se especifica - AWS Serverless Application Model
La propiedad de autenticación se AuthType especifica con el valor CUSTOMDomainName se especifica la propiedadBasePath se especifica la propiedadSe ha especificado la propiedad Route53

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

CloudFormation recursos generados cuando AWS::Serverless::WebSocketApi se especifica

Cuando AWS::Serverless::WebSocketApi se especifica un, AWS Serverless Application Model (AWS SAM) genera un CloudFormation recurso AWS::ApiGatewayV2::Api base. Además, siempre genera un AWS::ApiGatewayV2::Stage recurso y, para cada ruta definida en la Routes propiedad AWS::ApiGatewayV2::RouteAWS::ApiGatewayV2::Integration, AWS SAM genera y AWS::Lambda::Permission recursos.

AWS::ApiGatewayV2::Api

LogicalId: <websocketapi‑LogicalId>

Propiedad referenciable: N/A (debe usar la LogicalId para hacer referencia a este CloudFormation recurso)

AWS::ApiGatewayV2::Stage

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

<stage‑name> es la cadena en la que está establecida la propiedad StageName. Si no StageName se especifica, el valor predeterminado es. default Por ejemplo, si establece StageName como prod, entonces LogicalId es MyWebSocketApiprodStage.

Propiedad referenciable: <websocketapi‑LogicalId>.Stage

AWS::ApiGatewayV2::Route

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

<normalized‑route‑key>es la clave de ruta sin caracteres especiales. Por ejemplo, en el caso de la clave de ruta$connect, el LogicalId esMyWebSocketApiconnectRoute.

Propiedad referenciable: N/A (debe usar la LogicalId para hacer referencia a este CloudFormation recurso)

AWS::ApiGatewayV2::Integration

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

Propiedad referenciable: N/A (debe usar la para hacer referencia LogicalId a este recurso) CloudFormation

AWS::Lambda::Permission

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

Propiedad referenciable: N/A (debe usar la para hacer referencia LogicalId a este recurso) CloudFormation

Además de estos CloudFormation recursos, cuando AWS::Serverless::WebSocketApi se especifica, AWS SAM también genera CloudFormation recursos para los siguientes escenarios:

La propiedad de autenticación se AuthType especifica con el valor CUSTOM

Cuando la Auth propiedad de an AWS::Serverless::WebSocketApi se especifica con el valor AuthType establecido enCUSTOM, AWS SAM genera un AWS::ApiGatewayV2::Authorizer CloudFormation recurso. Si no InvokeRole se especifica, AWS SAM también genera un AWS::Lambda::Permission recurso para permitir que API Gateway invoque la función de autorización.

AWS::ApiGatewayV2::Authorizer

LogicalId: <websocketapi‑LogicalId>Authorizer

Propiedad referenciable: N/A (debe usar la para hacer referencia LogicalId a este recurso) CloudFormation

AWS::Lambda::Permission(cuando no InvokeRole se especifica)

LogicalId: <websocketapi‑LogicalId>AuthorizerPermission

Propiedad referenciable: N/A (debe usar la LogicalId para hacer referencia a este CloudFormation recurso)

DomainName se especifica la propiedad

Cuando se especifica la DomainName Domain propiedad de AWS::Serverless::WebSocketApi una, AWS SAM genera el AWS::ApiGatewayV2::DomainName CloudFormation recurso.

AWS::ApiGatewayV2::DomainName

LogicalId: ApiGatewayDomainNameV2<sha>

<sha> es un valor hash único que se genera cuando se crea la pila. Por ejemplo: ApiGatewayDomainNameV2926eeb5ff1.

Propiedad referenciable: N/A (debe usar la LogicalId para hacer referencia a este CloudFormation recurso)

BasePath se especifica la propiedad

Cuando AWS::Serverless::WebSocketApi se especifica la Domain propiedad de una, AWS SAM genera AWS::ApiGatewayV2::ApiMapping CloudFormation recursos, uno para cada ruta base especificada. BasePath

AWS::ApiGatewayV2::ApiMapping

LogicalId: <websocketapi‑LogicalId><basepath>ApiMapping

<basepath>es el valor de la ruta base. Por ejemplo, si se especifica v1 como ruta base, el LogicalId esMyWebSocketApiv1ApiMapping.

Propiedad referenciable: N/A (debe usar la LogicalId para hacer referencia a este CloudFormation recurso)

Se ha especificado la propiedad Route53

Cuando se especifica la Route53 Domain propiedad de AWS::Serverless::WebSocketApi una, AWS SAM genera un AWS::Route53::RecordSetGroup CloudFormation recurso.

AWS::Route53::RecordSetGroup

LogicalId: RecordSetGroup<sha>

<sha> es un valor hash único que se genera cuando se crea la pila. Por ejemplo: RecordSetGroup926eeb5ff1.

Propiedad referenciable: N/A (debe usar la LogicalId para hacer referencia a este CloudFormation recurso)