HttpApi - AWS Serverless Application Model
SintassiProprietàEsempi

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

HttpApi

L'oggetto che descrive un'origine di eventi con tipo HttpApi.

Se nell'API esiste una OpenApi definizione per il percorso e il metodo specificati, SAM aggiungerà automaticamente la sezione sull'integrazione e la sicurezza Lambda (se applicabile).

Se nell'API non esiste alcuna OpenApi definizione per il percorso e il metodo specificati, SAM creerà questa definizione per te.

Sintassi

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

Proprietà

ApiId

Identificatore di una AWS::Serverless::HttpApi risorsa definita in questo modello.

Se non è definita, viene creata una AWS::Serverless::HttpApi risorsa predefinita chiamata ServerlessHttpApi utilizzando un OpenApi documento generato contenente un'unione di tutti i percorsi e i metodi definiti dagli eventi Api definiti in questo modello che non specificano unApiId.

Questo non può fare riferimento a una AWS::Serverless::HttpApi risorsa definita in un altro modello.

Tipo: Stringa

Required: No

CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

Auth

Configurazione di autenticazione per questo specifico metodo Api+Path+.

Utile per sovrascrivere le API DefaultAuthorizer o impostare la configurazione di autenticazione su un percorso individuale quando non è specificato. DefaultAuthorizer

Tipo: HttpApiFunctionAuth

Required: No

CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un equivalente. CloudFormation

Method

Metodo HTTP per il quale viene richiamata questa funzione.

Se non Method viene specificato alcun Path e, SAM creerà un percorso API predefinito che indirizza qualsiasi richiesta che non sia mappata a un endpoint diverso per questa funzione Lambda. Può esistere solo uno di questi percorsi predefiniti per API.

Tipo: Stringa

Required: No

CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

Path

Percorso Uri per il quale viene richiamata questa funzione. Deve iniziare con/.

Se non Method viene specificato alcun Path e, SAM creerà un percorso API predefinito che indirizza qualsiasi richiesta che non sia mappata a un endpoint diverso per questa funzione Lambda. Può esistere solo uno di questi percorsi predefiniti per API.

Tipo: Stringa

Required: No

CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

PayloadFormatVersion

Specifica il formato del payload inviato a un'integrazione.

NOTA: PayloadFormatVersion richiede che SAM modifichi la definizione di OpenAPI, quindi funziona solo con inline OpenApi definito nella proprietà. DefinitionBody

Tipo: Stringa

Required: No

Predefinito: 2.0

CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

RouteSettings

Le impostazioni del percorso per percorso per questa API HTTP. Per ulteriori informazioni sulle impostazioni del percorso, consulta AWS::ApiGatewayV2::Stage RouteSettingsla Guida per gli sviluppatori di API Gateway.

Nota: se RouteSettings sono specificate sia nella HttpApi risorsa che nell'origine dell'evento, le AWS SAM unisce alle proprietà dell'origine dell'evento che hanno la precedenza.

Tipo: RouteSettings

Required: No

CloudFormation compatibilità: questa proprietà viene passata direttamente alla RouteSettings proprietà di una AWS::ApiGatewayV2::Stage risorsa.

TimeoutInMillis

Timeout personalizzato tra 50 e 29.000 millisecondi.

NOTA: TimeoutInMillis richiede che SAM modifichi la definizione di OpenAPI, quindi funziona solo con inline OpenApi definito nella proprietà. DefinitionBody

Tipo: integer

Required: No

Valore predefinito: 5000

CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

Esempi

HttpApi Evento predefinito

HttpApi Evento che utilizza il percorso predefinito. Tutti i percorsi e i metodi non mappati su questa API verranno indirizzati a questo endpoint.

YAML

Events:
  HttpApiEvent:
    Type: HttpApi

HttpApi

HttpApi Evento che utilizza un percorso e un metodo specifici.

YAML

Events:
  HttpApiEvent:
    Type: HttpApi
    Properties:
      Path: /
      Method: GET

HttpApi Autorizzazione

HttpApi Evento che utilizza un Authorizer.

YAML

Events:
  HttpApiEvent:
    Type: HttpApi
    Properties:
      Path: /authenticated
      Method: GET
      Auth:
        Authorizer: OpenIdAuth
        AuthorizationScopes:
          - scope1
          - scope2