Amazon CloudFormation指定 aws:: Serverless። Api 时生成的资源 - Amazon Serverless Application Model
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

Amazon CloudFormation指定 aws:: Serverless። Api 时生成的资源

当您时AWS::Serverless::Api已指定,Amazon Serverless Application Model(Amazon SAM)总是生成一个AWS::ApiGateway::RestApibaseAmazon CloudFormation资源。此外,它还总是生成一个AWS::ApiGateway::StageAWS::ApiGateway::Deployment资源。

AWS::ApiGateway::RestApi

LogicalId: <api‑LogicalId>

可引用属性:N/A(您必须使用LogicalId引用此Amazon CloudFormation资源)

AWS::ApiGateway::Stage

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

<stage‑name>的字符串是StageName属性设置为。例如,如果您将StageNameGammaLogicalIdMyRestApiGammaStage.

可引用属性:<api‑LogicalId>.Stage

AWS::ApiGateway::Deployment

LogicalId: <api‑LogicalId>Deployment<sha>

<sha>是创建堆栈时生成的唯一哈希值。例如:MyRestApiDeployment926eeb5ff1

可引用属性:<api‑LogicalId>.Deployment

除了这些Amazon CloudFormation资源,当AWS::Serverless::Api指定,Amazon SAM生成额外Amazon CloudFormation资源,以下场景。

指定了 DomainName 属性

当您时DomainName属性Domain属性AWS::Serverless::Api指定,Amazon SAM生成AWS::ApiGateway::DomainName Amazon CloudFormation资源。

AWS::ApiGateway::DomainName

LogicalId: ApiGatewayDomainName<sha>

<sha>是创建堆栈时生成的唯一哈希值。例如:ApiGatewayDomainName926eeb5ff1

可引用属性:<api‑LogicalId>.DomainName

已指定 UsagePlan 属性

当您时UsagePlan属性Auth属性AWS::Serverless::Api指定,Amazon SAM生成以下Amazon 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