Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

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

Un documento de OpenAPI que define la API.

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

Para declarar esta entidad en tu plantilla AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis.

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

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

 `Bucket`   <a name="sam-httpapi-httpapidefinition-bucket"></a>
Nombre del bucket de Amazon S3 donde se almacena el archivo OpenAPI.  
*Tipo:* cadena  
*Obligatorio*: sí  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-bucket)` propiedad del tipo de `AWS::ApiGatewayV2::Api` `BodyS3Location` datos.

 `Key`   <a name="sam-httpapi-httpapidefinition-key"></a>
La clave de Amazon S3 del archivo de OpenAPI.  
*Tipo:* cadena  
*Obligatorio*: sí  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[Key](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-key)` propiedad del tipo de `AWS::ApiGatewayV2::Api` `BodyS3Location` datos.

 `Version`   <a name="sam-httpapi-httpapidefinition-version"></a>
Para objetos con control de versiones, la versión del archivo de OpenAPI.  
*Tipo:* cadena  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[Version](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-version)` propiedad del tipo de `AWS::ApiGatewayV2::Api` `BodyS3Location` datos.

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

### Ejemplo de definición de Uri
<a name="sam-property-httpapi-httpapidefinition--examples--definition-uri-example"></a>

Ejemplo de definición 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
```