翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
ApiStateMachineAuth
特定の API、パス、およびメソッドに対して、イベントレベルで認可を設定します。
構文
AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、以下の構文を使用します。
YAML
ApiKeyRequired:BooleanAuthorizationScopes:ListAuthorizer:StringResourcePolicy:ResourcePolicyStatement
プロパティ
-
ApiKeyRequired -
この API、パス、およびメソッドの API キーが必要です。
タイプ: ブール
必須: いいえ
CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。
-
この API、パス、およびメソッドに適用する認可スコープです。
指定するスコープは、
DefaultAuthorizerプロパティが適用するスコープ (指定されている場合) を上書きします。タイプ: リスト
必須: いいえ
CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。
-
特定のステートマシンの
Authorizerです。API のグローバルオーソライザーが指定されているときにこのステートマシンを公開したい場合は、
AuthorizerをNONEに設定してグローバルオーソライザーを上書きします。タイプ: 文字列
必須: いいえ
CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。
-
ResourcePolicy -
API とパスのリソースポリシーを設定します。
必須: いいえ
CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。
例
Statemachine-Auth
以下の例は、ステートマシンレベルで認可を指定します。
YAML
Auth: ApiKeyRequired: true Authorizer: NONE
