AWS CloudFormation 指定时AWS::Serverless::Api生成的资源 - AWS Serverless Application Model
DomainName属性已指定UsagePlan属性已指定

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

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属性已指定

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

AWS::ApiGateway::DomainName

LogicalId: ApiGatewayDomainName<sha>

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

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

UsagePlan属性已指定

指定UsagePlan属性的Auth属性后， AWS SAM 会生成以下 AWS CloudFormation 资源：AWS::ApiGateway::UsagePlanAWS::ApiGateway::UsagePlanKey、和AWS::ApiGateway::ApiKey。AWS::Serverless::Api

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