AWS AppSync GraphQLApi UserPoolConfig

The UserPoolConfig property type specifies the optional authorization configuration for using Amazon Cognito User Pools with your GraphQL endpoint for an AWS AppSync GraphQL API.

UserPoolConfig is a property of the AWS::AppSync::GraphQLApi property type.

Syntax

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

JSON


{
  "AppIdClientRegex" : String,
  "UserPoolId" : String,
  "AwsRegion" : String,
  "DefaultAction" : String
}

YAML



AppIdClientRegex: String
UserPoolId: String
AwsRegion: String
DefaultAction: String

Properties

AppIdClientRegex

A regular expression for validating the incoming Amazon Cognito User Pool app client ID.

Required: No

Type: String

Update requires: No interruption

UserPoolId

The user pool ID.

Required: No

Type: String

Update requires: No interruption

AwsRegion

The AWS region in which the user pool was created.

Required: No

Type: String

Update requires: No interruption

DefaultAction

The action that you want your GraphQL API to take when a request that uses Amazon Cognito User Pool authentication doesn't match the Amazon Cognito User Pool configuration.

Required: No

Type: String

Update requires: No interruption

AWS AppSync GraphQLApi UserPoolConfig

Syntax

JSON

YAML

Properties

See Also