Recursos de AWS CloudFormation generados cuando se especifica AWS::Serverless::Api - AWS Serverless Application Model
DomainNamese especifica la propiedadUsagePlanse especifica la propiedad

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.

Recursos de AWS CloudFormation generados cuando se especifica AWS::Serverless::Api

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

AWS::ApiGateway::RestApi

LogicalId: <api‑LogicalId>

Propiedad referenciable: N/D (debe usar el LogicalId para hacer referencia a este recurso de AWS CloudFormation)

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 recursos AWS CloudFormation, cuando se especifica AWS::Serverless::Api, AWS SAM genera AWS CloudFormation recursos adicionales para los siguientes escenarios.

DomainNamese especifica la propiedad

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

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 propiedad UsagePlan de la propiedad Auth de un AWS::Serverless::Api, AWS SAM genera los siguientes recursos AWS CloudFormation: AWS::ApiGateway::UsagePlan, AWS::ApiGateway::UsagePlanKey y AWS::ApiGateway::ApiKey.

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