Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
ApiStateMachineAuth
Mengonfigurasi otorisasi di tingkat peristiwa, untuk API, jalur, dan metode tertentu.
Sintaks
Untuk mendeklarasikan entitas ini dalam template AWS Serverless Application Model (AWS SAM) Anda, gunakan sintaks berikut.
YAML
ApiKeyRequired:BooleanAuthorizationScopes:ListAuthorizer:StringResourcePolicy:ResourcePolicyStatement
Properti
-
ApiKeyRequired -
Memerlukan kunci API untuk API, jalur, dan metode ini.
Tipe: Boolean
Wajib: Tidak
CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.
-
Cakupan otorisasi yang akan diterapkan ke API, path, dan metode ini.
Cakupan yang Anda tentukan akan membatalkan setiap cakupan yang diterapkan oleh properti
DefaultAuthorizerjika Anda telah menentukannya.Tipe: Daftar
Wajib: Tidak
CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.
-
Authorizeruntuk mesin status tertentu.Jika Anda telah menentukan otorisasi global untuk API dan ingin membuat mesin status ini menjadi publik, batalkan otoritas global dengan menetapkan
AuthorizerkeNONE.Tipe: String
Wajib: Tidak
CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.
-
ResourcePolicy -
Konfigurasikan kebijakan sumber daya untuk API dan jalur ini.
Jenis: ResourcePolicyStatement
Wajib: Tidak
CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki CloudFormation padanan.
Contoh
StateMachine-Auth
Contoh berikut menentukan otorisasi di tingkat mesin status.
YAML
Auth: ApiKeyRequired: true Authorizer: NONE