HttpApiFunctionAuth

イベントレベルでの認可を設定します。

特定の API とパスとメソッドの認証を設定します

構文

AWS Serverless Application Model （AWS SAM) テンプレートでこのエンティティを宣言するには、次の構文を使用します。

YAML

  AuthorizationScopes: List
  Authorizer: String

プロパティ

AuthorizationScopes

この API、パス、およびメソッドに適用する認証スコープです。

ここにリストされているスコープは、DefaultAuthorizer によって適用されたスコープを上書きします (存在する場合)。

タイプ: リスト

必須: いいえ

AWS CloudFormation 互換性: このプロパティは に固有 AWS SAM であり、 AWS CloudFormation 同等のプロパティはありません。

Authorizer

特定の関数用の Authorizer です。IAM 認証を使用するには、AWS_IAM を指定し、テンプレートの Globals セクションで EnableIamAuthorizer に対して true を指定します。

API でグローバルオーソライザーを指定しており、特定の関数を公開する場合は、Authorizer を NONE に設定して上書きします。

タイプ: 文字列

必須: いいえ

AWS CloudFormation 互換性: このプロパティは に固有 AWS SAM であり、 AWS CloudFormation 同等のプロパティはありません。

例

Function-Auth

関数レベルでの認可の指定

YAML

Auth:
  Authorizer: OpenIdAuth
  AuthorizationScopes:
    - scope1
    - scope2

IAM 認証

イベントレベルで IAM 認可を指定します。イベントレベルで AWS_IAM 認証を使用するには、テンプレートの Globals セクションで EnableIamAuthorizer の true を指定する必要もあります。詳細については、「AWS SAM テンプレートの Globals セクション」を参照してください。

YAML

Globals:
  HttpApi:
    Auth:
      EnableIamAuthorizer: true

Resources:
  HttpApiFunctionWithIamAuth:
    Type: AWS::Serverless::Function
    Properties:
      Events:
        ApiEvent:
          Type: HttpApi
          Properties:
            Path: /iam-auth
            Method: GET
            Auth:
              Authorizer: AWS_IAM
      Handler: index.handler
      InlineCode: |
        def handler(event, context):
          return {'body': 'HttpApiFunctionWithIamAuth', 'statusCode': 200}
      Runtime: python3.9