View a markdown version of this page

WebSocketApiAuth - AWS Serverless Application Model
SyntaxePropriétésExemples

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

WebSocketApiAuth

Configurez l'autorisation pour contrôler l'accès à votre API Amazon WebSocket API Gateway.

Pour plus d'informations sur la configuration de l'accès à WebSocket APIs, consultez la section Contrôle de l'accès à WebSocket APIs dans le Guide du développeur d'API Gateway.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.

YAML

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

Propriétés

AuthArn

L'ARN de la fonction Lambda à utiliser pour l'autorisation. Obligatoire quand AuthType c'est le casCUSTOM.

Type : chaîne

Obligatoire : Conditionnelle

CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

AuthType

Type d'autorisation. Les valeurs valides sont NONE, AWS_IAM ou CUSTOM.

  • NONE- Aucune autorisation

  • AWS_IAM- Autorisation IAM

  • CUSTOM- Autorisateur Lambda

Type : chaîne

Obligatoire : oui

CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

IdentitySource

Source d'identité pour laquelle l'autorisation est demandée. Par exemple, route.request.header.Authorization.

Type : liste

Obligatoire : non

CloudFormation compatibilité : cette propriété est transmise directement à la IdentitySource propriété d'une AWS::ApiGatewayV2::Authorizer ressource.

InvokeRole

L'ARN du rôle IAM assumé par API Gateway lors de l'appel de la fonction d'autorisation. Si ce n'est pas spécifié, crée AWS SAM automatiquement une autorisation basée sur les ressources qui permet à API Gateway d'invoquer la fonction d'autorisation.

Type : chaîne

Obligatoire : non

CloudFormation compatibilité : cette propriété est transmise directement à la AuthorizerCredentialsArn propriété d'une AWS::ApiGatewayV2::Authorizer ressource.

Name

Nom du mécanisme d'autorisation.

Type : chaîne

Obligatoire : non

CloudFormation compatibilité : cette propriété est transmise directement à la Name propriété d'une AWS::ApiGatewayV2::Authorizer ressource.

Exemples

Autorisateur Lambda

L'exemple suivant configure un autorisateur Lambda pour une API. WebSocket 

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

Autorisation IAM

L'exemple suivant configure l'autorisation IAM pour une WebSocket API.

Auth:
  AuthType: AWS_IAM