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.

# Api
<a name="sam-property-statemachine-statemachineapi"></a>

El objeto que describe un tipo de fuente de evento de `Api`. Si se define un recurso [AWS::Serverless::Api](sam-resource-api.md), los valores de ruta y método deben corresponder a una operación de la definición de OpenAPI de la API. 

## Sintaxis
<a name="sam-property-statemachine-statemachineapi-syntax"></a>

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

### YAML
<a name="sam-property-statemachine-statemachineapi-syntax.yaml"></a>

```
  [Auth](#sam-statemachine-statemachineapi-auth): ApiStateMachineAuth
  [Method](#sam-statemachine-statemachineapi-method): String
  [Path](#sam-statemachine-statemachineapi-path): String
  [RestApiId](#sam-statemachine-statemachineapi-restapiid): String
  UnescapeMappingTemplate: Boolean
```

## Propiedades
<a name="sam-property-statemachine-statemachineapi-properties"></a>

 `Auth`   <a name="sam-statemachine-statemachineapi-auth"></a>
La configuración de autorización de esta API, ruta y método.  
Usa esta propiedad para anular la configuración `DefaultAuthorizer` de la API para una ruta individual, si no se especifica `DefaultAuthorizer`, o para anular la configuración de `ApiKeyRequired` predeterminada.  
*Tipo:* [ApiStateMachineAuth](sam-property-statemachine-apistatemachineauth.md)  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad es exclusiva de AWS SAM y no tiene un CloudFormation equivalente.

 `Method`   <a name="sam-statemachine-statemachineapi-method"></a>
El método HTTP para el que se invoca esta función.  
*Tipo:* cadena  
*Obligatorio*: sí  
*CloudFormation compatibilidad*: esta propiedad es exclusiva de AWS SAM y no tiene un CloudFormation equivalente.

 `Path`   <a name="sam-statemachine-statemachineapi-path"></a>
La ruta URI para la que se invoca esta función. El valor debe empezar por `/`.  
*Tipo:* cadena  
*Obligatorio*: sí  
*CloudFormation compatibilidad*: esta propiedad es exclusiva de AWS SAM y no tiene un CloudFormation equivalente.

 `RestApiId`   <a name="sam-statemachine-statemachineapi-restapiid"></a>
El identificador de un recurso `RestApi`, que debe contener una operación con la ruta y el método dados. Normalmente, se configura para hacer referencia a un recurso [AWS::Serverless::Api](sam-resource-api.md) definido en esta plantilla.  
Si no define esta propiedad, AWS SAM crea un [AWS::Serverless::Api](sam-resource-api.md) recurso predeterminado a partir de un `OpenApi` documento generado. Ese recurso contiene una unión de todas las rutas y métodos definidos por eventos `Api` de la misma plantilla que no especifican un `RestApiId`.  
Esta propiedad no puede hacer referencia a un recurso [AWS::Serverless::Api](sam-resource-api.md) definido en otra plantilla.  
*Tipo:* cadena  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad es exclusiva AWS SAM y no tiene un CloudFormation equivalente.

 `UnescapeMappingTemplate`   <a name="sam-statemachine-statemachineapi-unescapemappingtemplate"></a>
Evita las comillas simples, sustituyendo `\'` por `'`, en la entrada que se pasa a la máquina de estados. Haga esto cuando la entrada contenga comillas simples.  
Si se establece en `False` y la entrada contiene comillas simples, se producirá un error.
*Tipo*: Booleano  
*Obligatorio*: no  
*Valor predeterminado*: False  
*CloudFormation compatibilidad*: esta propiedad es exclusiva de AWS SAM y no tiene un CloudFormation equivalente.

## Ejemplos
<a name="sam-property-statemachine-statemachineapi--examples"></a>

### ApiEvent
<a name="sam-property-statemachine-statemachineapi--examples--apievent"></a>

A continuación, se muestra un ejemplo de un evento tipo `Api`.

#### YAML
<a name="sam-property-statemachine-statemachineapi--examples--apievent--yaml"></a>

```
Events:
  ApiEvent:
    Type: Api
    Properties:
      Path: /path
      Method: get
```