View a markdown version of this page

WebSocketApiAuth - AWS Serverless Application Model
구문속성예제

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

WebSocketApiAuth

Amazon API Gateway WebSocket API에 대한 액세스를 제어하도록 권한 부여를 구성합니다.

WebSocket APIs에 대한 액세스 구성에 대한 자세한 내용은 API Gateway 개발자 안내서의 WebSocket APIs에 대한 액세스 제어를 참조하세요.

구문

AWS Serverless Application Model (AWS SAM) 템플릿에서이 개체를 선언하려면 다음 구문을 사용합니다.

YAML

AuthArn: String
AuthType: String
IdentitySource: List
InvokeRole: String
Name: String

속성

AuthArn

권한 부여에 사용할 Lambda 함수의 ARN입니다. AuthType가 인 경우 필수입니다CUSTOM.

유형: 문자열

필수 항목 여부: 조건부

CloudFormation 호환성:이 속성은에 고유 AWS SAM 하며 CloudFormation 동등한 속성이 없습니다.

AuthType

권한 부여 유형입니다. 유효한 값은 NONE, AWS_IAM또는 CUSTOM입니다.

  • NONE - 권한 부여 없음

  • AWS_IAM - IAM 권한 부여

  • CUSTOM - Lambda 권한 부여자

유형: 문자열

필수 항목 여부: 예

CloudFormation 호환성:이 속성은에 고유 AWS SAM 하며 CloudFormation 동등한 속성이 없습니다.

IdentitySource

권한 부여가 요청되는 자격 증명 소스입니다. 예를 들어 route.request.header.Authorization입니다.

유형: 목록

필수 항목 여부: 아니요

CloudFormation 호환성:이 속성은 AWS::ApiGatewayV2::Authorizer 리소스의 IdentitySource 속성으로 직접 전달됩니다.

InvokeRole

권한 부여자 함수를 호출할 때 API Gateway가 수임하는 IAM 역할의 ARN입니다. 지정하지 않으면 API Gateway가 권한 부여자 함수를 호출할 수 있는 리소스 기반 권한이 AWS SAM 자동으로 생성됩니다.

유형: 문자열

필수 항목 여부: 아니요

CloudFormation 호환성:이 속성은 AWS::ApiGatewayV2::Authorizer 리소스의 AuthorizerCredentialsArn 속성으로 직접 전달됩니다.

Name

권한 부여자의 이름입니다.

유형: 문자열

필수 항목 여부: 아니요

CloudFormation 호환성:이 속성은 AWS::ApiGatewayV2::Authorizer 리소스의 Name 속성으로 직접 전달됩니다.

예제

Lambda 권한 부여자

다음 예시에서는 WebSocket API에 대한 Lambda 권한 부여자를 구성합니다.

Auth:
  AuthType: CUSTOM
  AuthArn: !GetAtt AuthorizerFunction.Arn
  IdentitySource:
    - route.request.header.Authorization

IAM 권한 부여

다음 예제에서는 WebSocket API에 대한 IAM 권한 부여를 구성합니다.

Auth:
  AuthType: AWS_IAM