

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

# WebSocketApiAuth
<a name="sam-property-websocketapi-websocketapiauth"></a>

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](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-control-access.html) nella *API Gateway Developer Guide*.

## Sintassi
<a name="sam-property-websocketapi-websocketapiauth-syntax"></a>

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

### YAML
<a name="sam-property-websocketapi-websocketapiauth-syntax.yaml"></a>

```
[AuthArn](#sam-websocketapiauth-autharn): {{String}}
[AuthType](#sam-websocketapiauth-authtype): {{String}}
[IdentitySource](#sam-websocketapiauth-identitysource): {{List}}
[InvokeRole](#sam-websocketapiauth-invokerole): {{String}}
[Name](#sam-websocketapiauth-name): {{String}}
```

## Properties
<a name="sam-property-websocketapi-websocketapiauth-properties"></a>

 `AuthArn`   <a name="sam-websocketapiauth-autharn"></a>
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`   <a name="sam-websocketapiauth-authtype"></a>
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`   <a name="sam-websocketapiauth-identitysource"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource)` proprietà di una `AWS::ApiGatewayV2::Authorizer` risorsa.

 `InvokeRole`   <a name="sam-websocketapiauth-invokerole"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizercredentialsarn)` `AWS::ApiGatewayV2::Authorizer`

 `Name`   <a name="sam-websocketapiauth-name"></a>
Il nome dell'autorizzazione.  
▬*Tipo:* stringa  
*Obbligatorio:* no  
*CloudFormation compatibilità*: questa proprietà viene passata direttamente alla `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-name)` proprietà di una `AWS::ApiGatewayV2::Authorizer` risorsa.

## Esempi
<a name="sam-property-websocketapi-websocketapiauth-examples"></a>

### Autorizzatore Lambda
<a name="sam-property-websocketapi-websocketapiauth-examples-lambda"></a>

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
<a name="sam-property-websocketapi-websocketapiauth-examples-iam"></a>

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

```
Auth:
  AuthType: AWS_IAM
```