AWS CloudFormation 指定AWS::Serverless::Api时生成的资源 - AWS Serverless Application Model
DomainName 属性已指定UsagePlan 属性已指定
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅中国的 AWS 服务入门。

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

AWS CloudFormation 指定AWS::Serverless::Api时生成的资源

当 AWS::Serverless::Api 已经指明, AWS 无服务器应用程序模型 (人AWS SAM)始终生成以下 AWS CloudFormation 资源: AWS::ApiGateway::RestApi,一个 AWS::ApiGateway::Stage和 AWS::ApiGateway::Deployment.

AWS::ApiGateway::RestApi

LogicalId: <api‑LogicalId>

可参考属性: 不适用(您必须使用 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::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