ApiFunctionAuth
特定の API、パス、およびメソッドに対して、イベントレベルで認証を設定します。
構文
AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、以下の構文を使用します。
YAML
ApiKeyRequired:
Boolean
AuthorizationScopes:List
Authorizer:String
InvokeRole:String
ResourcePolicy:ResourcePolicyStatement
プロパティ
-
ApiKeyRequired
-
この API、パス、およびメソッドの API キーが必要です。
タイプ: ブール
必須: いいえ
AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS CloudFormation に同等のものはありません。
-
AuthorizationScopes
-
この API、パス、およびメソッドに適用する認証スコープです。
指定するスコープは、
DefaultAuthorizer
プロパティが適用するスコープ (指定されている場合) を上書きします。タイプ: リスト
必須: いいえ
AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS CloudFormation に同等のものはありません。
-
Authorizer
-
特定の関数用の
Authorizer
です。API でグローバルオーソライザーを指定しており、特定の関数を公開する場合は、
Authorizer
をNONE
に設定して上書きします。型: 文字列
必須: いいえ
AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS CloudFormation に同等のものはありません。
-
InvokeRole
-
InvokeRole
認証に使用するAWS_IAM
を指定します。型: 文字列
必須: いいえ
デフォルト:
CALLER_CREDENTIALS
AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS CloudFormation に同等のものはありません。
追加のメモ:
CALLER_CREDENTIALS
はarn:aws:iam::*:user/*
にマップします。これは、発信者の認証情報を使用してエンドポイントを呼び出します。 -
ResourcePolicy
-
この API のパスのためのリソースポリシーを設定します。
必須: いいえ
AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS CloudFormation に同等のものはありません。
例
Function-Auth
以下の例は、関数レベルで認証を指定します。
YAML
Auth: ApiKeyRequired: true Authorizer: NONE