WebSocketApiAuth

Configura l'autorizzazione per controllare l'accesso alla tua API Amazon WebSocket API Gateway.

Per ulteriori informazioni sulla configurazione dell'accesso a WebSocket APIs, consulta Controlling access to WebSocket APIs nella API Gateway Developer Guide.

Sintassi

Per dichiarare questa entità nel tuo modello AWS Serverless Application Model (AWS SAM), usa la seguente sintassi.

YAML

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

Properties

AuthArn

L'ARN della funzione Lambda da utilizzare per l'autorizzazione. Richiesto quando èAuthType. CUSTOM

▬Tipo: stringa

Required: Conditional

CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

AuthType

Il tipo di autorizzazione. I valori validi sono NONE, AWS_IAM o CUSTOM.

• NONE- Nessuna autorizzazione

• AWS_IAM- Autorizzazione IAM

• CUSTOM- Autorizzatore Lambda

▬Tipo: stringa

Obbligatorio: sì

CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un CloudFormation equivalente.

IdentitySource

L'origine di identità per la quale la funzione di autorizzazione è richiesta. Ad esempio, route.request.header.Authorization.

Tipo: elenco

Obbligatorio: no

CloudFormation compatibilità: questa proprietà viene passata direttamente alla IdentitySource proprietà di una AWS::ApiGatewayV2::Authorizer risorsa.

InvokeRole

L'ARN del ruolo IAM che API Gateway assume quando richiama la funzione di autorizzazione. Se non specificato, crea AWS SAM automaticamente un'autorizzazione basata sulle risorse che consente ad API Gateway di richiamare la funzione di autorizzazione.

▬Tipo: stringa

Obbligatorio: no

CloudFormation compatibilità: questa proprietà viene passata direttamente alla proprietà di una risorsa. AuthorizerCredentialsArn AWS::ApiGatewayV2::Authorizer

Name

Il nome dell'autorizzazione.

▬Tipo: stringa

Obbligatorio: no

CloudFormation compatibilità: questa proprietà viene passata direttamente alla Name proprietà di una AWS::ApiGatewayV2::Authorizer risorsa.

Esempi

Autorizzatore Lambda

L'esempio seguente configura un autorizzatore Lambda per un'API. WebSocket

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

Autorizzazione IAM

L'esempio seguente configura l'autorizzazione IAM per un' WebSocket API.

Auth:
  AuthType: AWS_IAM