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á.

# HttpApiDefinition
<a name="sam-property-httpapi-httpapidefinition"></a>

Um documento da OpenAPI que define a API.

## Sintaxe
<a name="sam-property-httpapi-httpapidefinition-syntax"></a>

Para declarar essa entidade em seu modelo AWS Serverless Application Model (AWS SAM), use a sintaxe a seguir.

### YAML
<a name="sam-property-httpapi-httpapidefinition-syntax.yaml"></a>

```
  [Bucket](#sam-httpapi-httpapidefinition-bucket): String
  [Key](#sam-httpapi-httpapidefinition-key): String
  [Version](#sam-httpapi-httpapidefinition-version): String
```

## Propriedades
<a name="sam-property-httpapi-httpapidefinition-properties"></a>

 `Bucket`   <a name="sam-httpapi-httpapidefinition-bucket"></a>
O nome do bucket do Amazon S3 no qual o arquivo do OpenAPI está armazenado.  
*Tipo:* string  
*Obrigatório*: Sim  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-bucket)` propriedade do tipo de `AWS::ApiGatewayV2::Api` `BodyS3Location` dados.

 `Key`   <a name="sam-httpapi-httpapidefinition-key"></a>
A chave do Amazon S3 do arquivo OpenAPI.  
*Tipo:* string  
*Obrigatório*: Sim  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[Key](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-key)` propriedade do tipo de `AWS::ApiGatewayV2::Api` `BodyS3Location` dados.

 `Version`   <a name="sam-httpapi-httpapidefinition-version"></a>
Para objetos com controle de versão, a versão do arquivo OpenAPI.  
*Tipo:* string  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[Version](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-version)` propriedade do tipo de `AWS::ApiGatewayV2::Api` `BodyS3Location` dados.

## Exemplos
<a name="sam-property-httpapi-httpapidefinition--examples"></a>

### Exemplo de definição de Uri
<a name="sam-property-httpapi-httpapidefinition--examples--definition-uri-example"></a>

Exemplo de definição de API

#### YAML
<a name="sam-property-httpapi-httpapidefinition--examples--definition-uri-example--yaml"></a>

```
DefinitionUri:
  Bucket: sam-s3-demo-bucket-name
  Key: mykey-name
  Version: 121212
```