AWS CloudFormation ressources générées lorsque cela AWS::Serverless::Api est spécifié - AWS Serverless Application Model
DomainNamela propriété est spécifiéeUsagePlanla propriété est spécifiée

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

AWS CloudFormation ressources générées lorsque cela AWS::Serverless::Api est spécifié

Lorsqu'un AWS::Serverless::Api est spécifié, AWS Serverless Application Model (AWS SAM) génère toujours une AWS CloudFormation ressource AWS::ApiGateway::RestApi de base. En outre, il génère toujours une ressource AWS::ApiGateway::Stage et AWS::ApiGateway::Deployment.

AWS::ApiGateway::RestApi

LogicalId: <api‑LogicalId>

Propriété référençable : N/A (vous devez utiliser le LogicalId pour référencer cette AWS CloudFormation ressource)

AWS::ApiGateway::Stage

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

<stage‑name> est la chaîne sur laquelle la propriété StageName est définie. Par exemple, si vous définissez StageName sur Gamma, le LogicalId est MyRestApiGammaStage.

Propriété référençable :<api‑LogicalId>.Stage

AWS::ApiGateway::Deployment

LogicalId: <api‑LogicalId>Deployment<sha>

<sha> est une valeur de hachage unique qui est générée lors de la création de la pile. Par exemple, MyRestApiDeployment926eeb5ff1.

Propriété référençable :<api‑LogicalId>.Deployment

En plus de ces AWS CloudFormation ressources, lorsqu'elles AWS::Serverless::Api sont spécifiées, cela AWS SAM génère des AWS CloudFormation ressources supplémentaires pour les scénarios suivants.

DomainNamela propriété est spécifiée

Lorsque la DomainName propriété de la Domain propriété de an AWS::Serverless::Api est spécifiée, AWS SAM génère la AWS::ApiGateway::DomainName AWS CloudFormation ressource.

AWS::ApiGateway::DomainName

LogicalId: ApiGatewayDomainName<sha>

<sha> est une valeur de hachage unique qui est générée lors de la création de la pile. Par exemple : ApiGatewayDomainName926eeb5ff1.

Propriété référençable :<api‑LogicalId>.DomainName

UsagePlanla propriété est spécifiée

Lorsque la UsagePlan propriété de la Auth propriété de an AWS::Serverless::Api est spécifiée, AWS SAM génère les AWS CloudFormation ressources suivantes : AWS::ApiGateway::UsagePlanAWS::ApiGateway::UsagePlanKey, etAWS::ApiGateway::ApiKey.

AWS::ApiGateway::UsagePlan

LogicalId: <api‑LogicalId>UsagePlan

Propriété référençable :<api‑LogicalId>.UsagePlan

AWS::ApiGateway::UsagePlanKey

LogicalId: <api‑LogicalId>UsagePlanKey

Propriété référençable :<api‑LogicalId>.UsagePlanKey

AWS::ApiGateway::ApiKey

LogicalId: <api‑LogicalId>ApiKey

Propriété référençable :<api‑LogicalId>.ApiKey