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>

可參考屬性：N/A (您必須使用LogicalId來參照此 AWS 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

除了這些資 AWS CloudFormation 源之外，如果AWS::Serverless::Api有指定，則會針對下列案例 AWS SAM 產生其他 AWS CloudFormation 資源。

DomainName屬性已指定

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

AWS::ApiGateway::DomainName

LogicalId: ApiGatewayDomainName<sha>

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

可引用的屬性：<api‑LogicalId>.DomainName

UsagePlan屬性已指定

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