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을 지정하고, 템플릿의 true 섹션에서 EnableIamAuthorizer에 관하여 Globals를 지정하십시오.

API에서 글로벌 권한 부여자를 지정한 상태에서 특정 함수를 공개하려면 Authorizer을 NONE로 설정하여 변경하십시오.

타입: 문자열

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 AWS CloudFormation 이에 상응하는 속성이 없습니다.

예

함수-권한 부여

함수 수준에서 권한 부여

YAML

Auth:
  Authorizer: OpenIdAuth
  AuthorizationScopes:
    - scope1
    - scope2

IAM 권한 부여

이벤트 수준에서 IAM 권한 부여를 지정합니다. 이벤트 수준에서 AWS_IAM 권한 부여를 사용하려면 템플릿의 true 섹션에서 EnableIamAuthorizer에 관하여 Globals를 지정해야 합니다. 자세한 내용은 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