View a markdown version of this page

CloudFormation recursos gerados quando AWS::Serverless::WebSocketApi é especificado - AWS Serverless Application Model
A propriedade Auth é especificada com AuthType definida como CUSTOMDomainName propriedade é especificadaBasePath propriedade é especificadaA propriedade Route53 é especificada

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

CloudFormation recursos gerados quando AWS::Serverless::WebSocketApi é especificado

Quando um AWS::Serverless::WebSocketApi é especificado, AWS Serverless Application Model (AWS SAM) gera um CloudFormation recurso AWS::ApiGatewayV2::Api básico. Além disso, ele sempre gera um AWS::ApiGatewayV2::Stage recurso e, para cada rota definida na Routes propriedade AWS::ApiGatewayV2::RouteAWS::ApiGatewayV2::Integration, AWS SAM gera e AWS::Lambda::Permission recursos.

AWS::ApiGatewayV2::Api

LogicalId: <websocketapi‑LogicalId>

Propriedade referenciável: N/A (você deve usar o LogicalId para referenciar este recurso) CloudFormation

AWS::ApiGatewayV2::Stage

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

<stage‑name> é a string para a qual a propriedade StageName está definida. Se não StageName for especificado, o valor padrão serádefault. Por exemplo, se você definir StageName como prod, será LogicalIdMyWebSocketApiprodStage.

Propriedade referenciável: <websocketapi‑LogicalId>.Stage

AWS::ApiGatewayV2::Route

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

<normalized‑route‑key>é a chave de rota com caracteres especiais removidos. Por exemplo, para a chave de rota$connect, o LogicalId éMyWebSocketApiconnectRoute.

Propriedade referenciável: N/A (você deve usar o LogicalId para referenciar este recurso) CloudFormation

AWS::ApiGatewayV2::Integration

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

Propriedade referenciável: N/A (você deve usar o LogicalId para referenciar este recurso) CloudFormation

AWS::Lambda::Permission

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

Propriedade referenciável: N/A (você deve usar o LogicalId para referenciar este recurso) CloudFormation

Além desses CloudFormation recursos, quando AWS::Serverless::WebSocketApi especificado, AWS SAM também gera CloudFormation recursos para os seguintes cenários:

A propriedade Auth é especificada com AuthType definida como CUSTOM

Quando a Auth propriedade de um AWS::Serverless::WebSocketApi é especificada com AuthType set toCUSTOM, AWS SAM gera um AWS::ApiGatewayV2::Authorizer CloudFormation recurso. Se não InvokeRole for especificado, AWS SAM também gera um AWS::Lambda::Permission recurso para permitir que o API Gateway invoque a função autorizadora.

AWS::ApiGatewayV2::Authorizer

LogicalId: <websocketapi‑LogicalId>Authorizer

Propriedade referenciável: N/A (você deve usar o LogicalId para referenciar este recurso) CloudFormation

AWS::Lambda::Permission(quando não InvokeRole é especificado)

LogicalId: <websocketapi‑LogicalId>AuthorizerPermission

Propriedade referenciável: N/A (você deve usar o LogicalId para referenciar este recurso) CloudFormation

DomainName propriedade é especificada

Quando a DomainName propriedade da Domain propriedade de an AWS::Serverless::WebSocketApi é especificada, AWS SAM gera o AWS::ApiGatewayV2::DomainName CloudFormation recurso.

AWS::ApiGatewayV2::DomainName

LogicalId: ApiGatewayDomainNameV2<sha>

O <sha> é um valor de hash exclusivo que é gerado quando a pilha é criada. Por exemplo: ApiGatewayDomainNameV2926eeb5ff1.

Propriedade referenciável: N/A (você deve usar o LogicalId para referenciar este recurso) CloudFormation

BasePath propriedade é especificada

Quando a BasePath propriedade da Domain propriedade de an AWS::Serverless::WebSocketApi é especificada, AWS SAM gera AWS::ApiGatewayV2::ApiMapping CloudFormation recursos, um para cada caminho base especificado.

AWS::ApiGatewayV2::ApiMapping

LogicalId: <websocketapi‑LogicalId><basepath>ApiMapping

<basepath>é o valor do caminho base. Por exemplo, se você especificar v1 como um caminho base, o LogicalId éMyWebSocketApiv1ApiMapping.

Propriedade referenciável: N/A (você deve usar o LogicalId para referenciar este recurso) CloudFormation

A propriedade Route53 é especificada

Quando a Route53 propriedade da Domain propriedade de um AWS::Serverless::WebSocketApi é especificada, AWS SAM gera um AWS::Route53::RecordSetGroup CloudFormation recurso.

AWS::Route53::RecordSetGroup

LogicalId: RecordSetGroup<sha>

O <sha> é um valor de hash exclusivo que é gerado quando a pilha é criada. Por exemplo: RecordSetGroup926eeb5ff1.

Propriedade referenciável: N/A (você deve usar o LogicalId para referenciar este recurso) CloudFormation