WebSocketApiAuth

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

Para obter mais informações sobre como configurar o acesso ao WebSocket APIs, consulte Como controlar o acesso ao WebSocket APIs 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

AuthArn: String
AuthType: String
IdentitySource: List
InvokeRole: String
Name: String

Propriedades

AuthArn

O ARN da função Lambda a ser usada para autorização. Exigido quando AuthType éCUSTOM.

Tipo: string

Obrigatório: Condicional

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

AuthType

O tipo de autorização. Os valores válidos são NONE, AWS_IAM ou CUSTOM.

• NONE- Sem autorização

• AWS_IAM- Autorização do IAM

• CUSTOM- Autorizador Lambda

Tipo: string

Obrigatório: Sim

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

IdentitySource

A origem de identidade para a qual a autorização é solicitada. Por exemplo, .route.request.header.Authorization

Tipo: lista

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é passada diretamente para a IdentitySource propriedade de um AWS::ApiGatewayV2::Authorizer recurso.

InvokeRole

O ARN da função do IAM que o API Gateway assume ao invocar a função autorizadora. Se não for especificado, cria AWS SAM automaticamente uma permissão baseada em recursos que permite que o API Gateway invoque a função do autorizador.

Tipo: string

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é passada diretamente para a AuthorizerCredentialsArn propriedade de um AWS::ApiGatewayV2::Authorizer recurso.

Name

O nome do autorizador.

Tipo: string

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é passada diretamente para a Name propriedade de um AWS::ApiGatewayV2::Authorizer recurso.

Exemplos

Autorizador Lambda

O exemplo a seguir configura um autorizador Lambda para uma API. WebSocket

Auth:
  AuthType: CUSTOM
  AuthArn: !GetAtt AuthorizerFunction.Arn
  IdentitySource:
    - route.request.header.Authorization

Autorização do IAM

O exemplo a seguir configura a autorização do IAM para uma WebSocket API.

Auth:
  AuthType: AWS_IAM