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>

可參考屬性：N/A （您必須使用 LogicalId 來參考此 CloudFormation 資源）

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指定 時， 還會為下列案例 AWS SAM 產生其他 CloudFormation 資源。

已指定 DomainName 屬性

AWS::Serverless::Api 指定 DomainName的 Domain 屬性時， AWS SAM 會產生 AWS::ApiGateway::DomainName CloudFormation 資源。

AWS::ApiGateway::DomainName

LogicalId: ApiGatewayDomainName<sha>

<sha> 是建立堆疊時產生的唯一雜湊值。例如：ApiGatewayDomainName926eeb5ff1。

可參考屬性： <api‑LogicalId>.DomainName

已指定 UsagePlan 屬性

AWS::Serverless::Api 指定 UsagePlan的 Auth 屬性時， AWS SAM 會產生下列 CloudFormation 資源：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