LambdaAuthorizer

Konfigurasikan otorisasi Lambda untuk mengontrol akses ke API HTTP Amazon API Gateway Anda dengan suatu fungsi. AWS Lambda

Untuk informasi dan contoh selengkapnya, lihat Bekerja dengan AWS Lambda otorisasi untuk API HTTP di Panduan Pengembang API Gateway.

Sintaks

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

YAML

  AuthorizerPayloadFormatVersion: String
  EnableFunctionDefaultPermissions: Boolean
  EnableSimpleResponses: Boolean
  FunctionArn: String
  FunctionInvokeRole: String
  Identity: LambdaAuthorizationIdentity

Properti

AuthorizerPayloadFormatVersion

Menentukan format muatan yang dikirim ke pemberi otorisasi Lambda API HTTP. Diperlukan untuk Otorisasi Lambda API HTTP.

Ini dilewatkan ke bagian authorizerPayloadFormatVersion dari x-amazon-apigateway-authorizer di bagian securitySchemes dari ketentuan OpenAPI.

Nilai yang valid: 1.0 atau 2.0

Tipe: String

Wajib: Ya

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

EnableFunctionDefaultPermissions

Secara default, sumber daya HTTP API tidak diberikan izin untuk memanggil otorisasi Lambda. Tentukan properti ini true untuk secara otomatis membuat izin antara sumber daya HTTP API dan otorisasi Lambda Anda.

Tipe: Boolean

Wajib: Tidak

Nilai default: false

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

EnableSimpleResponses

Menentukan apakah pemberi otorisasi Lambda mengembalikan respons dalam format sederhana. Secara default, otorisasi Lambda harus mengembalikan kebijakan AWS Identity and Access Management (IAM). Jika diaktifkan, Otorisasi Lambda dapat mengembalikan nilai boolean bukan kebijakan IAM.

Ini diteruskan ke bagian enableSimpleResponses dari x-amazon-apigateway-authorizer di bagian securitySchemes dari ketentuan OpenAPI.

Tipe: Boolean

Wajib: Tidak

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

FunctionArn

Amazon Resource Name (ARN) dari fungsi Lambda yang menyediakan otorisasi untuk API.

Ini dilewatkan ke bagian authorizerUri dari x-amazon-apigateway-authorizer di bagian securitySchemes dari ketentuan OpenAPI.

Tipe: String

Wajib: Ya

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

FunctionInvokeRole

ARN IAM role yang memiliki kredensial yang diperlukan untuk API Gateway untuk memanggil fungsi otorisasi. Tentukan parameter ini jika kebijakan berbasis sumber daya fungsi Anda tidak memberikan izin lambda:InvokeFunction API Gateway.

Ini diteruskan ke bagian authorizerCredentials dari x-amazon-apigateway-authorizer di bagian securitySchemes dari ketentuan OpenAPI.

Untuk informasi lebih lanjut, lihat Buat otorisasi Lambda di Panduan Developer API Gateway.

Tipe: String

Wajib: Tidak

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

Identity

Menentukan IdentitySource dalam permintaan masuk untuk otorisasi.

Ini diteruskan ke bagian identitySource dari x-amazon-apigateway-authorizer di bagian securitySchemes dari ketentuan OpenAPI.

Jenis: LambdaAuthorizationIdentity

Wajib: Tidak

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

Contoh

LambdaAuthorizer

LambdaAuthorizer contoh

YAML

Auth:
  Authorizers:
    MyLambdaAuthorizer:
      AuthorizerPayloadFormatVersion: 2.0
      FunctionArn:
        Fn::GetAtt:
          - MyAuthFunction
          - Arn
      FunctionInvokeRole:
        Fn::GetAtt:
          - LambdaAuthInvokeRole
          - Arn
      Identity:
        Headers:
          - Authorization