View a markdown version of this page

WebSocketApiAuth - AWS Serverless Application Model
SintaksisSifat-sifatContoh

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

WebSocketApiAuth

Konfigurasikan otorisasi untuk mengontrol akses ke Amazon API Gateway WebSocket API Anda.

Untuk informasi selengkapnya tentang mengonfigurasi akses ke WebSocket APIs, lihat Mengontrol akses ke WebSocket APIs dalam Panduan Pengembang API Gateway.

Sintaksis

Untuk mendeklarasikan entitas ini dalam template AWS Serverless Application Model (AWS SAM) Anda, gunakan sintaks berikut.

YAML

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

Sifat-sifat

AuthArn

ARN dari fungsi Lambda untuk digunakan untuk otorisasi. Diperlukan kapan AuthTypeCUSTOM.

Tipe: String

Wajib: Bersyarat

CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

AuthType

Jenis otorisasi. Nilai yang valid adalah NONE, AWS_IAM, atau CUSTOM.

  • NONE- Tidak ada otorisasi

  • AWS_IAM- Otorisasi IAM

  • CUSTOM- Pengotorisasi Lambda

Tipe: String

Wajib: Ya

CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.

IdentitySource

Sumber identitas yang meminta otorisasi. Misalnya, route.request.header.Authorization.

Tipe: Daftar

Wajib: Tidak

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke IdentitySource properti AWS::ApiGatewayV2::Authorizer sumber daya.

InvokeRole

ARN dari peran IAM yang diasumsikan API Gateway saat menjalankan fungsi otorisasi. Jika tidak ditentukan, AWS SAM secara otomatis membuat izin berbasis sumber daya yang memungkinkan API Gateway menjalankan fungsi otorisasi.

Tipe: String

Wajib: Tidak

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke AuthorizerCredentialsArn properti AWS::ApiGatewayV2::Authorizer sumber daya.

Name

Nama pemberi otorisasi.

Tipe: String

Wajib: Tidak

CloudFormation kompatibilitas: Properti ini diteruskan langsung ke Name properti AWS::ApiGatewayV2::Authorizer sumber daya.

Contoh

Otorisasi Lambda

Contoh berikut mengonfigurasi otorisasi Lambda untuk API. WebSocket 

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

Otorisasi IAM

Contoh berikut mengonfigurasi otorisasi IAM untuk API. WebSocket 

Auth:
  AuthType: AWS_IAM