Auth - AWS Serverless Application Model
구문속성예

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

Auth

귀하의 GraphQL API에 대한 권한 부여를 구성합니다.

구문

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

YAML

Additional:
- AuthProvider
LambdaAuthorizer: LambdaAuthorizerConfig
OpenIDConnect: OpenIDConnectConfig
Type: String
UserPool: UserPoolConfig

속성

Additional

귀하의 GraphQLAPI에 대한 추가 인증 유형 목록.

유형: 목록 AuthProvider

필수 항목 여부: 아니요

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

LambdaAuthorizer

Lambda 함수 권한 부여자에 대한 선택적 권한 부여 구성을 지정합니다. Type이 AWS_LAMBDA로 지정된 경우 이 선택적 속성을 구성할 수 있습니다.

유형: LambdaAuthorizerConfig

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::AppSync::GraphQLApi 리소스의 LambdaAuthorizerConfig 속성으로 직접 전달됩니다.

OpenIDConnect

귀하의 OpenID Connect 규정 준수 서비스를 위한 선택적 권한 부여 구성을 지정합니다. Type이 OPENID_CONNECT로 지정된 경우 이 선택적 속성을 구성할 수 있습니다.

유형: 오픈ID ConnectConfig

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::AppSync::GraphQLApi 리소스의 OpenIDConnectConfig 속성으로 직접 전달됩니다.

Type

애플리케이션과 AWS AppSync GraphQL API 간의 기본 인증 유형입니다.

허용된 값의 목록과 설명은 AWS AppSync 개발자 안내서의 권한 부여 및 인증을 참조하세요.

Lambda 권한 부여자 AWS_LAMBDA () AWS SAM 를 지정하면 API와 Lambda 함수 간에 권한을 프로비저닝하는 (IAM) 정책을 생성합니다 AWS Identity and Access Management . GraphQL

타입: 문자열

필수 항목 여부: 예

AWS CloudFormation 호환성: 이 속성은 리소스의 속성으로 직접 전달됩니다. AuthenticationType AWS::AppSync::GraphQLApi

UserPool

Amazon Cognito 사용자 풀을 사용하기 위한 선택적 권한 부여 구성을 지정합니다. Type이 AMAZON_COGNITO_USER_POOLS로 지정된 경우 이 선택적 속성을 구성할 수 있습니다.

유형: UserPoolConfig

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::AppSync::GraphQLApi 리소스의 UserPoolConfig 속성으로 직접 전달됩니다.

예

기본 및 추가 권한 부여 유형을 구성합니다.

이 예시에서는 먼저 Lambda 권한 부여자를 GraphQL API의 기본 권한 부여 유형으로 구성합니다. 

AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyGraphQLAPI:
    Type: AWS::Serverless::GraphQLApi
    Properties:
      Auth:
        Type: AWS_LAMBDA
        LambdaAuthorizer:
          AuthorizerUri: !GetAtt Authorizer1.Arn
          AuthorizerResultTtlInSeconds: 10
          IdentityValidationExpression: hello

다음으로 AWS SAM 템플릿에 다음을 추가하여 GraphQL API에 대한 추가 권한 부여 유형을 구성합니다. 

        Additional:
        - Type: AWS_IAM
        - Type: API_KEY
        - Type: OPENID_CONNECT
          OpenIDConnect:
            AuthTTL: 10
            ClientId: myId
            IatTTL: 10
            Issuer: prod

그러면 다음과 같은 AWS SAM 템플릿이 생성됩니다.

AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyGraphQLAPI:
    Type: AWS::Serverless::GraphQLApi
    Properties:
      Auth:
        Type: AWS_LAMBDA
        LambdaAuthorizer:
          AuthorizerUri: !GetAtt Authorizer1.Arn
          AuthorizerResultTtlInSeconds: 10
          IdentityValidationExpression: hello
        Additional:
        - Type: AWS_IAM
        - Type: API_KEY
        - Type: OPENID_CONNECT
          OpenIDConnect:
            AuthTTL: 10
            ClientId: myId
            IatTTL: 10
            Issuer: prod