

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# CloudFormation recursos gerados quando AWS::Serverless::Api é especificado
<a name="sam-specification-generated-resources-api"></a>

Quando um `AWS::Serverless::Api` é especificado, AWS Serverless Application Model (AWS SAM) sempre gera um CloudFormation recurso `AWS::ApiGateway::RestApi` básico. Além disso, ele sempre gera um `AWS::ApiGateway::Stage` e um recurso `AWS::ApiGateway::Deployment`.

**`AWS::ApiGateway::RestApi`**  
*`LogicalId`: *`{{<api‑LogicalId>}}`  
*Propriedade referenciável:* N/A (você deve usar o `LogicalId` para referenciar este recurso) CloudFormation 

**`AWS::ApiGateway::Stage`**  
*`LogicalId`: *`{{<api‑LogicalId>}}{{<stage‑name>}}Stage`  
`{{<stage‑name>}}` é a string para a qual a propriedade `StageName` está definida. Por exemplo, se você definir `StageName` como `Gamma`, será `LogicalId``{{MyRestApiGamma}}Stage`.  
*Propriedade referenciável:* `{{<api‑LogicalId>}}.Stage`

**`AWS::ApiGateway::Deployment`**  
*`LogicalId`: *`{{<api‑LogicalId>}}Deployment{{<sha>}}`  
O `{{<sha>}}` é um valor de hash exclusivo que é gerado quando a pilha é criada. Por exemplo, `{{MyRestApi}}Deployment{{926eeb5ff1}}`.  
*Propriedade referenciável:* `{{<api‑LogicalId>}}.Deployment`

Além desses CloudFormation recursos, quando `AWS::Serverless::Api` especificado, AWS SAM gera CloudFormation recursos adicionais para os seguintes cenários.

**Topics**
+ [DomainName propriedade é especificada](#sam-specification-generated-resources-api-domain-name)
+ [UsagePlan propriedade é especificada](#sam-specification-generated-resources-api-usage-plan)

## DomainName propriedade é especificada
<a name="sam-specification-generated-resources-api-domain-name"></a>

Quando a `DomainName` propriedade da `Domain` propriedade de an `AWS::Serverless::Api` é especificada, AWS SAM gera o `AWS::ApiGateway::DomainName` CloudFormation recurso.

**`AWS::ApiGateway::DomainName`**  
*`LogicalId`: *`ApiGatewayDomainName{{<sha>}}`  
O `{{<sha>}}` é um valor de hash exclusivo que é gerado quando a pilha é criada. Por exemplo: `ApiGatewayDomainName{{926eeb5ff1}}`.  
*Propriedade referenciável:* `{{<api‑LogicalId>}}.DomainName`

## UsagePlan propriedade é especificada
<a name="sam-specification-generated-resources-api-usage-plan"></a>

Quando a `UsagePlan` propriedade da `Auth` propriedade de um `AWS::Serverless::Api` é especificada, AWS SAM gera os seguintes CloudFormation recursos: `AWS::ApiGateway::UsagePlan``AWS::ApiGateway::UsagePlanKey`, `AWS::ApiGateway::ApiKey` e.

**`AWS::ApiGateway::UsagePlan`**  
*`LogicalId`: *`{{<api‑LogicalId>}}UsagePlan`  
*Propriedade referenciável:* `{{<api‑LogicalId>}}.UsagePlan`

**`AWS::ApiGateway::UsagePlanKey`**  
*`LogicalId`: *`{{<api‑LogicalId>}}UsagePlanKey`  
*Propriedade referenciável:* `{{<api‑LogicalId>}}.UsagePlanKey`

**`AWS::ApiGateway::ApiKey`**  
*`LogicalId`: *`{{<api‑LogicalId>}}ApiKey`  
*Propriedade referenciável:* `{{<api‑LogicalId>}}.ApiKey`