AuthProvider

追加の GraphQL API 認可タイプ用のオプションの認可設定。

構文

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

YAML

LambdaAuthorizer: LambdaAuthorizerConfig
OpenIDConnect: OpenIDConnectConfig
Type: String
UserPool: UserPoolConfig

プロパティ

LambdaAuthorizer

AWS Lambda 関数オーソライザーのオプションの承認設定を指定します。このオプションプロパティは、Type を AWS_LAMBDA として指定する場合に設定できます。

タイプ: LambdaAuthorizerConfig

必須: いいえ

AWS CloudFormation 互換性: このプロパティは、 AWS::AppSync::GraphQLApi AdditionalAuthenticationProvider オブジェクトの LambdaAuthorizerConfigプロパティに直接渡されます。

OpenIDConnect

OpenID Connect 準拠サービスのオプションの認可設定を指定します。このオプションプロパティは、Type を OPENID_CONNECT として指定する場合に設定できます。

タイプ: OpenIDConnectConfig

必須: いいえ

AWS CloudFormation 互換性: このプロパティは、 AWS::AppSync::GraphQLApi AdditionalAuthenticationProvider オブジェクトの OpenIDConnectConfigプロパティに直接渡されます。

Type

アプリケーションと AWS AppSync GraphQL API 間のデフォルトの認可タイプ。

許可される値のリストと説明については、「AWS AppSync デベロッパーガイド」の「認証と認可」を参照してください。

Lambda オーソライザー () を指定するとAWS_LAMBDA、 GraphQL は API と Lambda 関数間のアクセス許可をプロビジョニングする AWS Identity and Access Management (IAM) ポリシー AWS SAM を作成します。

型: 文字列

必須: はい

AWS CloudFormation 互換性: このプロパティは、 AWS::AppSync::GraphQLApi AdditionalAuthenticationProvider オブジェクトの AuthenticationTypeプロパティに直接渡されます。

UserPool

Amazon Cognito ユーザープールを使用するためのオプションの認可設定を指定します。このオプションプロパティは、Type を AMAZON_COGNITO_USER_POOLS として指定する場合に設定できます。

タイプ: UserPoolConfig

必須: いいえ

AWS CloudFormation 互換性: このプロパティは、 AWS::AppSync::GraphQLApi AdditionalAuthenticationProvider オブジェクトの UserPoolConfigプロパティに直接渡されます。