AuthProvider - AWS Serverless Application Model
構文プロパティ

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

必須: いいえ

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

OpenIDConnect

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

タイプ: OpenIDConnectConfig

必須: いいえ

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

Type

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

許可される値のリストと説明については、「AWS AppSync Developer Guide」の「Authorization and authentication」を参照してください。

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

タイプ: 文字列

必須: はい

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

UserPool

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

タイプ: UserPoolConfig

必須: いいえ

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