CloudFormationAWS::Serverless::Apiが指定されているときに生成される リソース - AWS Serverless Application Model
DomainName プロパティが指定されているUsagePlan プロパティが指定されている

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

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

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

AWS::ApiGateway::RestApi

LogicalId: <api‑LogicalId>

参照可能なプロパティ: 該当なし (この 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

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

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

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

AWS::ApiGateway::DomainName

LogicalId: ApiGatewayDomainName<sha>

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

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

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

の UsagePlanプロパティの Authプロパティを指定すると、 AWS::Serverless::Apiは AWS::ApiGateway::UsagePlan、AWS::ApiGateway::UsagePlanKey、および の CloudFormation リソース AWS SAM を生成します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