AWS CloudFormation
User Guide (Version )

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.

LogConfig 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, "AwsRegion" : String, "DefaultAction" : String, "UserPoolId" : String }

YAML

AppIdClientRegex: String AwsRegion: String DefaultAction: String UserPoolId: 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

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

UserPoolId

The user pool ID.

Required: No

Type: String

Update requires: No interruption

On this page: