Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

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

Konfigurieren Sie die Autorisierung, um den Zugriff auf Ihre Amazon API Gateway WebSocket Gateway-API zu kontrollieren.

Weitere Informationen zur Konfiguration des Zugriffs auf WebSocket APIs finden Sie unter [Steuern des Zugriffs auf WebSocket APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-control-access.html) im *API Gateway Developer Guide*.

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

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

### 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}}
```

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

 `AuthArn`   <a name="sam-websocketapiauth-autharn"></a>
Der ARN der Lambda-Funktion, die für die Autorisierung verwendet werden soll. Erforderlich, wann `AuthType` ist`CUSTOM`.  
*Typ:* Zeichenfolge  
*Required*: Conditional  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `AuthType`   <a name="sam-websocketapiauth-authtype"></a>
Die Art der Autorisierung. Gültige Werte sind `NONE`, `AWS_IAM` oder `CUSTOM`.  
+ `NONE`- Keine Autorisierung
+ `AWS_IAM`- IAM-Autorisierung
+ `CUSTOM`- Lambda-Autorisierer
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `IdentitySource`   <a name="sam-websocketapiauth-identitysource"></a>
Die Identitätsquelle, für die die Autorisierung angefordert wird. Beispiel, `route.request.header.Authorization`.  
*Typ*: Liste  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[IdentitySource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource)` Eigenschaft einer `AWS::ApiGatewayV2::Authorizer` Ressource übergeben.

 `InvokeRole`   <a name="sam-websocketapiauth-invokerole"></a>
Der ARN der IAM-Rolle, die API Gateway beim Aufrufen der Autorisierungsfunktion annimmt. Wenn nicht angegeben, AWS SAM wird automatisch eine ressourcenbasierte Berechtigung erstellt, die es API Gateway ermöglicht, die Autorisierungsfunktion aufzurufen.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[AuthorizerCredentialsArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizercredentialsarn)` Eigenschaft einer Ressource übergeben. `AWS::ApiGatewayV2::Authorizer`

 `Name`   <a name="sam-websocketapiauth-name"></a>
Der Name des Genehmigers.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft wird direkt an die `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-name)` Eigenschaft einer `AWS::ApiGatewayV2::Authorizer` Ressource übergeben.

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

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

Im folgenden Beispiel wird ein Lambda-Authorizer für eine API konfiguriert. WebSocket 

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

### IAM-Autorisierung
<a name="sam-property-websocketapi-websocketapiauth-examples-iam"></a>

Im folgenden Beispiel wird die IAM-Autorisierung für eine API konfiguriert. WebSocket 

```
Auth:
  AuthType: AWS_IAM
```