HttpApi

O objeto que descreve uma fonte de eventos com o tipo HttpAPI.

Se houver uma definição de OpenAPI para o caminho e o método especificados na API, o SAM adicionará a seção de integração e segurança do Lambda (se aplicável) para você.

Se nenhuma definição de OpenAPI para o caminho e o método especificados existir na API, o SAM criará essa definição para você.

Sintaxe

Para declarar esta entidade no modelo do AWS Serverless Application Model (AWS SAM), use a seguinte sintaxe:

YAML

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

Propriedades

ApiId

Identificador de um recurso AWS::Serverless::HttpApi definido neste modelo.

Se não for definido, um recurso AWS::Serverless::HttpApi padrão é criado chamado ServerlessHttpApi usando um documento OpenAPI gerado contendo uma união de todos os caminhos e métodos definidos por eventos de API definidos neste modelo que não especificam um ApiId.

Isso não pode fazer referência a um recurso AWS::Serverless::HttpApi definido em outro modelo.

Tipo: string

Obrigatório: não

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

Auth

Configuração de autenticação para essa Api+Path+Method específica.

Útil para substituir as APIs DefaultAuthorizer ou definir a configuração de autenticação em um caminho individual quando não DefaultAuthorizer é especificado.

Tipo: HttpApiFunctionAuth

Obrigatório: não

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

Method

Método HTTP para o qual essa função é invocada.

Se não Path e Method for especificado, o SAM criará um caminho de API padrão que roteia qualquer solicitação que não seja mapeada para um endpoint diferente para essa função do Lambda. Somente um desses caminhos padrão pode existir por API.

Tipo: string

Obrigatório: não

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

Path

Caminho Uri para o qual essa função é invocada. Deve começar com /.

Se não Path e Method for especificado, o SAM criará um caminho de API padrão que roteia qualquer solicitação que não seja mapeada para um endpoint diferente para essa função do Lambda. Somente um desses caminhos padrão pode existir por API.

Tipo: string

Obrigatório: não

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

PayloadFormatVersion

Especifica o formato da carga enviada para uma integração.

OBSERVAÇÃO: payloadFormatVersion exige que o SAM modifique sua definição de openAPI, então ele só funciona com a openAPI embutida definida na propriedade DefinitionBody.

Tipo: string

Obrigatório: não

Padrão: 2.0

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

RouteSettings

As configurações de rota por rota para essa API HTTP. Para obter mais informações sobre configurações de rotas, consulte AWS::ApiGatewayV2::Stage RouteSettings no Guia do desenvolvedor do API Gateway.

Nota: Se routeSettings forem especificadas tanto no recurso HttpAPI quanto na fonte do evento, mescla-as com as propriedades da fonte AWS SAM do evento que têm precedência.

Type: RouteSettings

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade RouteSettings de um recurso AWS::ApiGatewayV2::Stage.

TimeoutInMillis

Tempo limite personalizado entre 50 e 29.000 milissegundos.

OBSERVAÇÃO: TimeoutinMillis exige que o SAM modifique sua definição de OpenAPI, então ele só funciona com a OpenAPI embutida definida na propriedade DefinitionBody.

Tipo: inteiro

Obrigatório: não

Padrão: 5000

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

Exemplos

Evento HttpAPI padrão

Evento HttpAPI que usa o caminho padrão. Todos os caminhos e métodos não mapeados nessa API serão roteados para esse endpoint.

YAML

Events:
  HttpApiEvent:
    Type: HttpApi

API HTTP

Evento HttpAPI que usa um caminho e um método específicos.

YAML

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

Autorização HttpAPI

Evento HttpAPI que usa um Autorizador.

YAML

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