AWS::AppSync::GraphQLApi UserPoolConfig - AWS CloudFormation
SyntaxProperties

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.

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. If this value isn't set, no filtering is applied.

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.

When specifying Amazon Cognito user pools as the default authentication, you must set the value for DefaultAction to ALLOW if specifying AdditionalAuthenticationProviders.

Required: No

Type: String

Update requires: No interruption

UserPoolId

The user pool ID.

Required: No

Type: String

Update requires: No interruption