AWS::AppSync::Api AuthProvider - AWS CloudFormation
SyntaxProperties
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::AppSync::Api AuthProvider

Describes an authorization provider.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

Properties

AuthType

The authorization type.

Required: Yes

Type: String

Allowed values: AMAZON_COGNITO_USER_POOLS | AWS_IAM | API_KEY | OPENID_CONNECT | AWS_LAMBDA

Update requires: No interruption

CognitoConfig

Describes an Amazon Cognito user pool configuration.

Required: No

Type: CognitoConfig

Update requires: No interruption

LambdaAuthorizerConfig

A LambdaAuthorizerConfig specifies how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AWS AppSync API can have only one AWS Lambda authorizer configured at a time.

Required: No

Type: LambdaAuthorizerConfig

Update requires: No interruption

OpenIDConnectConfig

Describes an OpenID Connect (OIDC) configuration.

Required: No

Type: OpenIDConnectConfig

Update requires: No interruption