HttpApiAuth

Configure a autorização para controlar o acesso à sua API HTTP do Amazon API Gateway.

Para obter mais informações sobre como configurar o acesso às APIs HTTP, consulte Como controlar e gerenciar o acesso a uma API HTTP no API Gateway no Guia do desenvolvedor do API Gateway.

Sintaxe

Para declarar essa entidade em seu modelo AWS Serverless Application Model (AWS SAM), use a sintaxe a seguir.

YAML

  Authorizers: OAuth2Authorizer | LambdaAuthorizer
  DefaultAuthorizer: String
  EnableIamAuthorizer: Boolean

Propriedades

Authorizers

O autorizador usado para controlar o acesso à sua API do API Gateway.

Tipo: OAuth2Authorizer | LambdaAuthorizer

Obrigatório: não

Padrão: nenhum

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

Notas adicionais: AWS SAM adiciona os autorizadores à definição da OpenAPI.

DefaultAuthorizer

Especifique o autorizador padrão a ser usado para autorizar chamadas de API para sua API do API Gateway. Você pode especificar o AWS_IAM como autorizador padrão se o EnableIamAuthorizer estiver definido como true. Caso contrário, especifique um autorizador que você definiu no Authorizers.

Tipo: string

Obrigatório: não

Padrão: nenhum

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

EnableIamAuthorizer

Especifique se deseja usar a autorização do IAM para a rota da API.

Tipo: booliano

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

Exemplos

Autorizador OAuth 2.0

Exemplo de autorizador do OAuth 2.0

YAML

Auth:
  Authorizers:
    OAuth2Authorizer:
      AuthorizationScopes:
        - scope1
        - scope2
      JwtConfiguration:
        issuer: "https://www.example.com/v1/connect/oauth2"
        audience:
          - MyApi
      IdentitySource: "$request.querystring.param"
  DefaultAuthorizer: OAuth2Authorizer

autorizador do IAM

Exemplo de autorizador do IAM

YAML

Auth:
  EnableIamAuthorizer: true
  DefaultAuthorizer: AWS_IAM