本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 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>

`AWS::Serverless::Api` 指定 `DomainName`的 `Domain` 屬性時， AWS SAM 會產生 `AWS::ApiGateway::DomainName` CloudFormation 資源。

**`AWS::ApiGateway::DomainName`**  
*`LogicalId`: *`ApiGatewayDomainName{{<sha>}}`  
`{{<sha>}}` 是建立堆疊時產生的唯一雜湊值。例如：`ApiGatewayDomainName{{926eeb5ff1}}`。  
*可參考屬性： *`{{<api‑LogicalId>}}.DomainName`

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

`AWS::Serverless::Api` 指定 `UsagePlan`的 `Auth` 屬性時， AWS SAM 會產生下列 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`