AWS::Serverless::Api が指定された場合、生成される AWS CloudFormation リソース - AWS Serverless Application Model
DomainName プロパティが指定されているUsagePlan プロパティが指定されている

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS::Serverless::Api が指定された場合、生成される AWS CloudFormation リソース

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 SAM が以下のシナリオのために追加の AWS CloudFormation リソースを生成します。

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

AWS::Serverless::Api の Domain プロパティの DomainName プロパティが指定されている場合、AWS SAM は AWS::ApiGateway::DomainName AWS CloudFormation リソースを生成します。

AWS::ApiGateway::DomainName

LogicalId: ApiGatewayDomainName<sha>

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

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

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

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

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