HttpApi

L'oggetto che descrive un'origine evento con tipo HttpAPI.

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

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

Sintassi

Per dichiarare questa entità nel tuoAWS Serverless Application Model(AWS SAM) template, utilizzare la seguente sintassi.

YAML

  ApiId: String
  Auth: HttpApiFunctionAuth
  Method: String
  Path: String
  PayloadFormatVersion: String
  RouteSettings: RouteSettings
  TimeoutInMillis: Integer

Proprietà

ApiId

Identificatore di unAWS::Serverless::HttpApirisorsa definita in questo modello.

Se non definito, un valore predefinitoAWS::Serverless::HttpApila risorsa viene creata chiamataServerlessHttpApiutilizzando un documento OpenAPI 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 aAWS::Serverless::HttpApirisorsa definita in un altro modello.

Type: Stringa

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa struttura è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

Auth

Configurazione di autenticazione per questo metodo API+Path+Path.

Utile per sovrascrivere le APIDefaultAuthorizero impostazione della configurazione di autenticazione su un singolo percorso quando noDefaultAuthorizerè specificato.

Type: http://apifunction.auth

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa struttura è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

Method

Metodo HTTP per il quale viene richiamata questa funzione.

Se noPatheMethodsono specificati, SAM creerà un percorso API predefinito che instrada qualsiasi richiesta che non mappi a un endpoint diverso rispetto a questa funzione Lambda. Solo uno di questi percorsi predefiniti può esistere per API.

Type: Stringa

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa struttura è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

Path

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

Se noPatheMethodsono specificati, SAM creerà un percorso API predefinito che instrada qualsiasi richiesta che non mappi a un endpoint diverso rispetto a questa funzione Lambda. Solo uno di questi percorsi predefiniti può esistere per API.

Type: Stringa

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa struttura è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

PayloadFormatVersion

Specifica il formato del payload inviato a un'integrazione.

NOTA: PayloadFormatVersion richiede che SAM modifichi la definizione OpenAPI, quindi funziona solo con OpenAPI in linea definita nelDefinitionBodyproprietà.

Type: Stringa

Campo obbligatorio: No

Default: 2.0

AWS CloudFormationcompatibilità: Questa struttura è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

RouteSettings

Le impostazioni del percorso per percorso per questa API HTTP. Per ulteriori informazioni sulle impostazioni di instradamento, consultaRouteSettings di AWS::ApiGatewayV2::StagenellaGuida per sviluppatori di API Gateway.

Nota: Se le impostazioni RouteSettings sono specificate sia nella risorsa HttpAPI che nell'origine evento,AWS SAMli unisce con le proprietà dell'origine evento che hanno la precedenza.

Type: RouteSettings

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà viene trasmessa direttamente alRouteSettingsproprietà di unAWS::ApiGatewayV2::Stagerisorsa.

TimeoutInMillis

Timeout personalizzato tra 50 e 29.000 millisecondi.

NOTA: TimeoutInMillis richiede che SAM modifichi la tua definizione OpenAPI, quindi funziona solo con OpenAPI in linea definita nelDefinitionBodyproprietà.

Type: Numero intero

Campo obbligatorio: No

Default: 5000

AWS CloudFormationcompatibilità: Questa struttura è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

Esempi

Evento HTTPAPI predefiniti

HttpAPI Event che utilizza il percorso predefinito. Tutti i percorsi e i metodi non mappati su questa API indirizzeranno a questo endpoint.

YAML

Events:
  HttpApiEvent:
    Type: HttpApi

HTTP Papi

Evento HttpAPI che utilizza un percorso e un metodo specifici.

YAML

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

Autorizzazione HttpAPI

Evento HttpAPI che utilizza un Authorizer.

YAML

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