AWS CloudFormation が指定されているときに生成される AWS::Serverless::Api リソース

AWS::Serverless::Api を指定すると、 AWS Serverless Application Model （AWS SAM) は常に AWS::ApiGateway::RestApi ベース AWS CloudFormation リソースを生成します。これに加えて、AWS::ApiGateway::Stage と AWS::ApiGateway::Deployment リソースも常に生成します。

AWS::ApiGateway::RestApi

LogicalId: <api‑LogicalId>

参照可能なプロパティ: 該当なし (この AWS CloudFormation リソースを参照するには LogicalId を使用する必要があります）

AWS::ApiGateway::Stage

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

<stage‑name> は、StageName プロパティが設定されている文字列です。例えば、StageName を Gamma に設定とすると、LogicalId が MyRestApiGammaStage になります。

参照可能なプロパティ: <api‑LogicalId>.Stage

AWS::ApiGateway::Deployment

LogicalId: <api‑LogicalId>Deployment<sha>

<sha> は、スタックが作成されるときに生成される一意のハッシュ値です。例えば、MyRestApiDeployment926eeb5ff1 などです。

参照可能なプロパティ: <api‑LogicalId>.Deployment

これらの AWS CloudFormation リソースに加えて、 を指定すると、 AWS::Serverless::Api は次のシナリオで追加の AWS CloudFormation リソース AWS SAM を生成します。

DomainName プロパティが指定されています

の DomainNameプロパティの Domainプロパティを指定すると、 AWS::Serverless::Apiは AWS::ApiGateway::DomainName AWS CloudFormation リソース AWS SAM を生成します。

AWS::ApiGateway::DomainName

LogicalId: ApiGatewayDomainName<sha>

<sha> は、スタックが作成されるときに生成される一意のハッシュ値です。例えば、ApiGatewayDomainName926eeb5ff1 などです。

参照可能なプロパティ: <api‑LogicalId>.DomainName

UsagePlan プロパティが指定されています

の UsagePlanプロパティの Authプロパティを指定すると、 AWS::Serverless::Api AWS CloudFormation は次のリソース AWS SAM を生成します: AWS::ApiGateway::UsagePlan、AWS::ApiGateway::UsagePlanKey、および AWS::ApiGateway::ApiKey。

AWS::ApiGateway::UsagePlan

LogicalId: <api‑LogicalId>UsagePlan

参照可能なプロパティ: <api‑LogicalId>.UsagePlan

AWS::ApiGateway::UsagePlanKey

LogicalId: <api‑LogicalId>UsagePlanKey

参照可能なプロパティ: <api‑LogicalId>.UsagePlanKey

AWS::ApiGateway::ApiKey

LogicalId: <api‑LogicalId>ApiKey

参照可能なプロパティ: <api‑LogicalId>.ApiKey