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

Cuando AWS::Serverless::Api se especifica un, AWS Serverless Application Model (AWS SAM) siempre genera un AWS CloudFormation recurso AWS::ApiGateway::RestApi base. Además, siempre genera un recurso AWS::ApiGateway::Stage y un recurso AWS::ApiGateway::Deployment.

AWS::ApiGateway::RestApi

LogicalId: <api‑LogicalId>

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

AWS::ApiGateway::Stage

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

<stage‑name> es la cadena en la que está establecida la propiedad StageName. Por ejemplo, si establece StageName como Gamma, entonces LogicalId es MyRestApiGammaStage.

Propiedad referenciable: <api‑LogicalId>.Stage

AWS::ApiGateway::Deployment

LogicalId: <api‑LogicalId>Deployment<sha>

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

Propiedad referenciable: <api‑LogicalId>.Deployment

Además de estos AWS CloudFormation recursos, cuando AWS::Serverless::Api se especifica, AWS SAM genera AWS CloudFormation recursos adicionales para los siguientes escenarios.

DomainNamese especifica la propiedad

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

AWS::ApiGateway::DomainName

LogicalId: ApiGatewayDomainName<sha>

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

Propiedad referenciable: <api‑LogicalId>.DomainName

UsagePlanse especifica la propiedad

Cuando se especifica la Auth propiedad de AWS::Serverless::Api una, AWS SAM genera los siguientes AWS CloudFormation recursos: AWS::ApiGateway::UsagePlanAWS::ApiGateway::UsagePlanKey, yAWS::ApiGateway::ApiKey. UsagePlan

AWS::ApiGateway::UsagePlan

LogicalId: <api‑LogicalId>UsagePlan

Propiedad referenciable: <api‑LogicalId>.UsagePlan

AWS::ApiGateway::UsagePlanKey

LogicalId: <api‑LogicalId>UsagePlanKey

Propiedad referenciable: <api‑LogicalId>.UsagePlanKey

AWS::ApiGateway::ApiKey

LogicalId: <api‑LogicalId>ApiKey

Propiedad referenciable: <api‑LogicalId>.ApiKey