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

# CloudFormation 指定时AWS::Serverless::Api生成的资源
<a name="sam-specification-generated-resources-api"></a>

指定`AWS::Serverless::Api`时， AWS Serverless Application Model (AWS SAM) 始终生成`AWS::ApiGateway::RestApi`基础 CloudFormation 资源。此外，它还总是生成 `AWS::ApiGateway::Stage` 和 `AWS::ApiGateway::Deployment` 资源。

**`AWS::ApiGateway::RestApi`**  
*`LogicalId`: *`{{<api‑LogicalId>}}`  
*可引用的属性：*N/A（必须使用`LogicalId`来引用此 CloudFormation 资源）

**`AWS::ApiGateway::Stage`**  
*`LogicalId`: *`{{<api‑LogicalId>}}{{<stage‑name>}}Stage`  
`{{<stage‑name>}}` 是 `StageName` 属性将被设置为的字符串。例如，您将 `StageName` 设置为 `Gamma`，`LogicalId` 是 `{{MyRestApiGamma}}Stage`。  
*可引用属性：*`{{<api‑LogicalId>}}.Stage`

**`AWS::ApiGateway::Deployment`**  
*`LogicalId`: *`{{<api‑LogicalId>}}Deployment{{<sha>}}`  
`{{<sha>}}` 是在创建堆栈时生成的唯一哈希值。例如 `{{MyRestApi}}Deployment{{926eeb5ff1}}`。  
*可引用属性：*`{{<api‑LogicalId>}}.Deployment`

除了这些 CloudFormation 资源之外，如果`AWS::Serverless::Api`指定了这些资源，还会为以下场景 AWS SAM 生成其他 CloudFormation 资源。

**Topics**
+ [DomainName 属性已指定](#sam-specification-generated-resources-api-domain-name)
+ [UsagePlan 属性已指定](#sam-specification-generated-resources-api-usage-plan)

## DomainName 属性已指定
<a name="sam-specification-generated-resources-api-domain-name"></a>

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

**`AWS::ApiGateway::DomainName`**  
*`LogicalId`: *`ApiGatewayDomainName{{<sha>}}`  
`{{<sha>}}` 是在创建堆栈时生成的唯一哈希值。例如：`ApiGatewayDomainName{{926eeb5ff1}}`。  
*可引用属性：*`{{<api‑LogicalId>}}.DomainName`

## UsagePlan 属性已指定
<a name="sam-specification-generated-resources-api-usage-plan"></a>

指定`UsagePlan`属性的`Auth`属性后， AWS SAM 会生成以下 CloudFormation 资源：`AWS::ApiGateway::UsagePlan``AWS::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`