AWS CloudFormationrecursos gerados quando AWS::Serverless::Api é especificado - AWS Serverless Application Model
A propriedade domainName é especificadaA propriedade usagePlan é 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á.

AWS CloudFormationrecursos gerados quando AWS::Serverless::Api é especificado

Quando um AWS::Serverless::Api é especificado, AWS Serverless Application Model (AWS SAM) sempre gera um recurso AWS::ApiGateway::RestApi com base AWS CloudFormation. Além disso, ele sempre gera um AWS::ApiGateway::Stage e um recurso AWS::ApiGateway::Deployment.

AWS::ApiGateway::RestApi

LogicalId: <api‑LogicalId>

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

AWS::ApiGateway::Stage

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

<stage‑name> é a string para a qual a propriedade StageName está definida. Por exemplo, se você definir StageName como Gamma, será LogicalIdMyRestApiGammaStage.

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

AWS::ApiGateway::Deployment

LogicalId: <api‑LogicalId>Deployment<sha>

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

Propriedade referenciável: <api‑LogicalId>.Deployment

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

A propriedade domainName é especificada

Quando a propriedade DomainName da propriedade Domain de um AWS::Serverless::Api é especificada, AWS SAM gera o recurso AWS::ApiGateway::DomainName AWS CloudFormation.

AWS::ApiGateway::DomainName

LogicalId: ApiGatewayDomainName<sha>

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

Propriedade referenciável: <api‑LogicalId>.DomainName

A propriedade usagePlan é especificada

Quando a propriedade UsagePlan da propriedade Auth de um AWS::Serverless::Api é especificada, AWS SAM gera os seguintes recurso: AWS CloudFormation AWS::ApiGateway::UsagePlan, AWS::ApiGateway::UsagePlanKey, e AWS::ApiGateway::ApiKey.

AWS::ApiGateway::UsagePlan

LogicalId: <api‑LogicalId>UsagePlan

Propriedade referenciável: <api‑LogicalId>.UsagePlan

AWS::ApiGateway::UsagePlanKey

LogicalId: <api‑LogicalId>UsagePlanKey

Propriedade referenciável: <api‑LogicalId>.UsagePlanKey

AWS::ApiGateway::ApiKey

LogicalId: <api‑LogicalId>ApiKey

Propriedade referenciável: <api‑LogicalId>.ApiKey