LambdaAuthorizer

함수를 사용하여 Amazon API Gateway HTTP API에 대한 액세스를 제어하도록 Lambda 권한 부여자를 구성합니다. AWS Lambda

자세한 내용 및 예시는 API Gateway 개발자 안내서의 HTTP API AWS Lambda 권한 부여자 사용을 참조하십시오.

구문

AWS Serverless Application Model (AWS SAM) 템플릿에서 이 엔티티를 선언하려면 다음 구문을 사용하십시오.

YAML

  AuthorizerPayloadFormatVersion: String
  EnableFunctionDefaultPermissions: Boolean
  EnableSimpleResponses: Boolean
  FunctionArn: String
  FunctionInvokeRole: String
  Identity: LambdaAuthorizationIdentity

속성

AuthorizerPayloadFormatVersion

HTTP API Lambda 권한 부여자에게 전송되는 페이로드의 형식을 지정합니다. HTTP API Lambda 권한 부여자에 필요합니다.

이는 OpenAPI 정의의 securitySchemes 섹션에 있는 x-amazon-apigateway-authorizer의 authorizerPayloadFormatVersion 섹션으로 전달됩니다.

유효한 값: 1.0 또는 2.0

타입: 문자열

필수 항목 여부: 예

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

EnableFunctionDefaultPermissions

기본적으로 HTTP API 리소스에는 Lambda 권한 부여자를 호출할 수 있는 권한이 부여되지 않습니다. HTTP API 리소스와 Lambda 권한 부여자 간에 권한을 자동으로 생성하도록 이 속성을 true로 지정합니다.

유형: 부울

필수 항목 여부: 아니요

기본값: false

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

EnableSimpleResponses

Lambda 권한 부여자가 간단한 형식으로 응답을 반환하는지 여부를 지정합니다. 기본적으로 Lambda 권한 부여자는 ( AWS Identity and Access Management IAM) 정책을 반환해야 합니다. 사용하도록 설정되면 Lambda 권한 부여자가 IAM 정책 대신 부울 값을 반환할 수 있습니다.

이는 OpenAPI 정의의 securitySchemes 섹션에 있는 x-amazon-apigateway-authorizer의 enableSimpleResponses 섹션으로 전달됩니다.

유형: 부울

필수 항목 여부: 아니요

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

FunctionArn

API에 대한 인증을 제공하는 Lambda 함수의 Amazon 리소스 이름(ARN)입니다.

이는 OpenAPI 정의의 securitySchemes 섹션에 있는 x-amazon-apigateway-authorizer의 authorizerUri 섹션으로 전달됩니다.

타입: 문자열

필수 항목 여부: 예

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

FunctionInvokeRole

API Gateway가 권한 부여자 함수를 호출하는 데 필요한 보안 인증 정보가 있는 IAM 역할의 ARN입니다. 함수의 리소스 기반 정책이 API Gateway lambda:InvokeFunction 권한을 부여하지 않는 경우, 이 파라미터를 지정합니다.

이는 OpenAPI 정의의 securitySchemes 섹션에 있는 x-amazon-apigateway-authorizer의 authorizerCredentials 섹션으로 전달됩니다.

자세한 내용은 API Gateway 개발자 안내서의 Lambda 권한 부여자 만들기 섹션을 참조하세요.

타입: 문자열

필수 항목 여부: 아니요

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

Identity

권한 부여자에 대한 수신 요청에 IdentitySource를 지정합니다.

이는 OpenAPI 정의의 securitySchemes 섹션에 있는 x-amazon-apigateway-authorizer의 identitySource 섹션으로 전달됩니다.

유형: LambdaAuthorizationIdentity

필수 항목 여부: 아니요

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

예

LambdaAuthorizer

LambdaAuthorizer 예시

YAML

Auth:
  Authorizers:
    MyLambdaAuthorizer:
      AuthorizerPayloadFormatVersion: 2.0
      FunctionArn:
        Fn::GetAtt:
          - MyAuthFunction
          - Arn
      FunctionInvokeRole:
        Fn::GetAtt:
          - LambdaAuthInvokeRole
          - Arn
      Identity:
        Headers:
          - Authorization