View a markdown version of this page

WebSocketApiAuth - AWS Serverless Application Model
SintaxisPropiedadesEjemplos

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

WebSocketApiAuth

Configure la autorización para controlar el acceso a su API de Amazon WebSocket API Gateway.

Para obtener más información sobre la configuración del acceso a WebSocket APIs, consulte Controlar el acceso a WebSocket APIs en la Guía para desarrolladores de API Gateway.

Sintaxis

Para declarar esta entidad en su plantilla AWS Serverless Application Model (AWS SAM), utilice la siguiente sintaxis.

YAML

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

Propiedades

AuthArn

El ARN de la función Lambda que se utilizará para la autorización. Obligatorio cuando AuthType es. CUSTOM

Tipo: cadena

Obligatorio: condicional

CloudFormation compatibilidad: esta propiedad es exclusiva de AWS SAM y no tiene un CloudFormation equivalente.

AuthType

El tipo de autorización. Los valores válidos son NONE, AWS_IAM o CUSTOM.

  • NONE- Sin autorización

  • AWS_IAM- Autorización de IAM

  • CUSTOM- Autorizador Lambda

Tipo: cadena

Obligatorio: sí

CloudFormation compatibilidad: esta propiedad es exclusiva AWS SAM y no tiene un CloudFormation equivalente.

IdentitySource

Es la fuente de identidad para la que se solicita autorización. Por ejemplo, route.request.header.Authorization.

Tipo: lista

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se pasa directamente a la IdentitySource propiedad de un AWS::ApiGatewayV2::Authorizer recurso.

InvokeRole

El ARN de la función de IAM que asume API Gateway al invocar la función de autorización. Si no se especifica, crea AWS SAM automáticamente un permiso basado en recursos que permite a API Gateway invocar la función de autorización.

Tipo: cadena

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se transfiere directamente a la AuthorizerCredentialsArn propiedad de un recurso. AWS::ApiGatewayV2::Authorizer

Name

El nombre del autorizador.

Tipo: cadena

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se pasa directamente a la Name propiedad de un AWS::ApiGatewayV2::Authorizer recurso.

Ejemplos

Autorizador Lambda

El siguiente ejemplo configura un autorizador Lambda para una API. WebSocket 

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

Autorización de IAM

El siguiente ejemplo configura la autorización de IAM para una API. WebSocket 

Auth:
  AuthType: AWS_IAM