LambdaTokenAuthorizer - AWS Serverless Application Model
SintaksPropertiContoh

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

LambdaTokenAuthorizer

Mengonfigurasi Otorisasi Lambda untuk mengendalikan akses ke API Anda dengan fungsi Lambda.

Untuk informasi selengkapnya dan contoh tambahan, lihat Kontrol API akses dengan AWS SAM template Anda.

Sintaks

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

Properti

DisableFunctionDefaultPermissions

Tentukan true untuk AWS SAM mencegah membuat sumber daya secara otomatis untuk memberikan izin antara AWS::Lambda::Permissions sumber AWS::Serverless::Api daya Anda dan fungsi Lambda otorisasi.

Nilai default: false

Tipe: Boolean

Wajib: Tidak

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

FunctionArn

Tentukan fungsi ARN dari fungsi Lambda yang menyediakan otorisasi untuk API.

catatan

AWS SAM akan secara otomatis membuat AWS::Lambda::Permissions sumber daya ketika FunctionArn ditentukan untukAWS::Serverless::Api. Sumber AWS::Lambda::Permissions daya menyediakan izin antara API Anda dan fungsi Lambda otorisasi.

Tipe: String

Wajib: Ya

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

FunctionInvokeRole

Menambahkan kredensi otorisasi ke OpenApi definisi otorisasi Lambda.

Tipe: String

Wajib: Tidak

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

FunctionPayloadType

Properti ini dapat digunakan untuk menentukan tipe Otorisasi Lambda untuk API.

Nilai yang valid: TOKEN atau REQUEST

Tipe: String

Wajib: Tidak

Default: TOKEN

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

Identity

Properti ini dapat digunakan untuk menentukan IdentitySource dalam permintaan masuk untuk otorisasi. Properti ini hanya diperlukan jika properti FunctionPayloadType diatur ke REQUEST.

Jenis: LambdaTokenAuthorizationIdentity

Wajib: Bersyarat

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

Contoh

LambdaTokenAuth

YAML

Authorizers:
  MyLambdaTokenAuth:
    FunctionArn:
      Fn::GetAtt:
        - MyAuthFunction
        - Arn
    Identity:
      Header: MyCustomAuthHeader # OPTIONAL; Default: 'Authorization'
      ValidationExpression: mycustomauthexpression # OPTIONAL
      ReauthorizeEvery: 20 # OPTIONAL; Service Default: 300

BasicLambdaTokenAuth

YAML

Authorizers:
  MyLambdaTokenAuth:
    FunctionArn:
      Fn::GetAtt:
        - MyAuthFunction
        - Arn