

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

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

L'oggetto che descrive un tipo di origine `Api` dell'evento. Se viene definita una [AWS::Serverless::Api](sam-resource-api.md) risorsa, i valori del percorso e del metodo devono corrispondere a un'operazione nella definizione OpenAPI dell'API. 

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

Per dichiarare questa entità nel tuo modello AWS Serverless Application Model (AWS SAM), usa la seguente sintassi.

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

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

 `Auth`   <a name="sam-statemachine-statemachineapi-auth"></a>
La configurazione di autorizzazione per questa API, percorso e metodo.  
Utilizzate questa proprietà per sovrascrivere l'`DefaultAuthorizer`impostazione dell'API per un singolo percorso, quando non `DefaultAuthorizer` è specificato nessuno, o per sovrascrivere l'impostazione predefinita`ApiKeyRequired`.  
*Tipo:* [ApiStateMachineAuth](sam-property-statemachine-apistatemachineauth.md)  
*Obbligatorio:* no  
*CloudFormation compatibilità*: questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

 `Method`   <a name="sam-statemachine-statemachineapi-method"></a>
Il metodo HTTP per cui viene richiamata questa funzione.  
▬*Tipo:* stringa  
*Obbligatorio:* sì  
*CloudFormation compatibilità*: questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

 `Path`   <a name="sam-statemachine-statemachineapi-path"></a>
Il percorso URI per il quale viene richiamata questa funzione. Il valore deve iniziare con`/`.  
▬*Tipo:* stringa  
*Obbligatorio:* sì  
*CloudFormation compatibilità*: questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

 `RestApiId`   <a name="sam-statemachine-statemachineapi-restapiid"></a>
L'identificatore di una `RestApi` risorsa, che deve contenere un'operazione con il percorso e il metodo indicati. In genere, è impostato per fare riferimento a una [AWS::Serverless::Api](sam-resource-api.md) risorsa definita in questo modello.  
Se non definisci questa proprietà, AWS SAM crea una [AWS::Serverless::Api](sam-resource-api.md) risorsa predefinita utilizzando un `OpenApi` documento generato. Tale risorsa contiene un'unione di tutti i percorsi e i metodi definiti dagli `Api` eventi nello stesso modello che non specificano a`RestApiId`.  
Questa proprietà non può fare riferimento a una [AWS::Serverless::Api](sam-resource-api.md) risorsa definita in un altro modello.  
▬*Tipo:* stringa  
*Obbligatorio:* no  
*CloudFormation compatibilità*: questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

 `UnescapeMappingTemplate`   <a name="sam-statemachine-statemachineapi-unescapemappingtemplate"></a>
Rimuove le virgolette singole, sostituendole `\'` con`'`, sull'input passato alla macchina a stati. Da utilizzare quando l'input contiene virgolette singole.  
Se è impostato su `False` e l'input contiene virgolette singole, si verificherà un errore.
*Tipo*: Booleano  
*Obbligatorio:* no  
*Impostazione predefinita*: False  
*CloudFormation compatibilità*: questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

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

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

Di seguito è riportato un esempio di evento di `Api` questo tipo.

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

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