Api

Filtrar visualização

All

O objeto que descreve um tipo de origem do evento Api. Se um recurso AWS::Serverless::Api for definido, os valores do caminho e do método devem corresponder a uma operação na definição de OpenAPI da API.

Sintaxe

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

YAML

  Auth: ApiStateMachineAuth
  Method: String
  Path: String
  RestApiId: String
  UnescapeMappingTemplate: Boolean

Propriedades

Auth

A configuração de autorização para essa API, caminho e método.

Use essa propriedade para substituir a configuração DefaultAuthorizer da API para um caminho individual, quando nenhum DefaultAuthorizer for especificado, ou para substituir a configuração padrão ApiKeyRequired.

Tipo: ApiStateMachineAuth

Obrigatório: não

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

Method

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

Tipo: string

Obrigatório: Sim

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

Path

O caminho do URI para o qual esta função é invocada. O valor deve começar com /.

Tipo: string

Obrigatório: Sim

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

RestApiId

O identificador de um recurso RestApi, que deve conter uma operação com o caminho e o método fornecidos. Normalmente, isso é definido para fazer referência a um recurso AWS::Serverless::Api definido nesse modelo.

Se você não definir essa propriedade, o AWS SAM cria um recurso AWS::Serverless::Api padrão usando um documento OpenApi gerado. Esse recurso contém uma união de todos os caminhos e métodos definidos por eventos Api no mesmo modelo que não especificam um arquivo RestApiId.

Esta propriedade não pode fazer referência a um recurso AWS::Serverless::Api definido em outro modelo.

Tipo: string

Obrigatório: não

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

UnescapeMappingTemplate

Elimina aspas simples, substituindo \' por ', na entrada que é passada para a máquina de estado. Use quando sua entrada contiver aspas simples.

nota

Se definido como False e sua entrada contiver aspas simples, ocorrerá um erro.

Tipo: booliano

Obrigatório: não

Padrão: False

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

Exemplos

ApiEvent

A seguir está um exemplo de um evento do tipo Api.

YAML

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