WebSocketApiAuth

Amazon API Gateway WebSocket API へのアクセスを制御するための認可を設定します。

WebSocket APIs「API Gateway デベロッパーガイド」のWebSocket APIs」を参照してください。

構文

AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、次の構文を使用します。

YAML

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

プロパティ

AuthArn

認可に使用する Lambda 関数の ARN。AuthType が の場合は必須ですCUSTOM。

タイプ: 文字列

必須: 条件に応じて異なります

CloudFormation 互換性: このプロパティは に固有 AWS SAM であり、 CloudFormation 同等のものはありません。

AuthType

認可のタイプ。有効な値は NONE、AWS_IAM、または CUSTOM です。

• NONE - 認可なし

• AWS_IAM - IAM 認可

• CUSTOM - Lambda オーソライザー

タイプ: 文字列

必須: はい

CloudFormation 互換性: このプロパティは に固有 AWS SAM であり、 CloudFormation 同等のものはありません。

IdentitySource

承認がリクエストされた ID ソースを含みます。例えば、route.request.header.Authorization。

タイプ: リスト

必須: いいえ

CloudFormation 互換性: このプロパティは、 AWS::ApiGatewayV2::Authorizerリソースの IdentitySourceプロパティに直接渡されます。

InvokeRole

オーソライザー関数を呼び出すときに API Gateway が引き受ける IAM ロールの ARN。指定しない場合、API Gateway がオーソライザー関数を呼び出すことを許可するリソースベースのアクセス許可 AWS SAM が自動的に作成されます。

タイプ: 文字列

必須: いいえ

CloudFormation 互換性: このプロパティは、 AWS::ApiGatewayV2::Authorizerリソースの AuthorizerCredentialsArnプロパティに直接渡されます。

Name

認証の名前。

タイプ: 文字列

必須: いいえ

CloudFormation 互換性: このプロパティは、 AWS::ApiGatewayV2::Authorizerリソースの Nameプロパティに直接渡されます。

例

Lambda オーソライザー

次の例では、WebSocket API の Lambda オーソライザーを設定します。

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

IAM 認可

次の例では、WebSocket API の IAM 認可を設定します。

Auth:
  AuthType: AWS_IAM