在指定了 AWS::Serverless::Api 的情况下生成的 AWS CloudFormation 资源 - AWS Serverless Application Model
指定了 DomainName 属性指定了 UsagePlan 属性

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

在指定了 AWS::Serverless::Api 的情况下生成的 AWS CloudFormation 资源

如果指定了 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>

可引用属性：不适用（必须使用 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 属性

如果指定了 AWS::Serverless::Api 的 Domain 属性的 DomainName 属性，AWS SAM 会生成 AWS::ApiGateway::DomainName AWS CloudFormation 资源。

AWS::ApiGateway::DomainName

LogicalId: ApiGatewayDomainName<sha>

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

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

指定了 UsagePlan 属性

如果指定了 AWS::Serverless::Api 的 Auth 属性的 UsagePlan 属性，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