aws-cdk-lib.aws_appsync.CfnGraphQLApi.UserPoolConfigProperty

interface UserPoolConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.AppSync.CfnGraphQLApi.UserPoolConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnGraphQLApi_UserPoolConfigProperty
Javasoftware.amazon.awscdk.services.appsync.CfnGraphQLApi.UserPoolConfigProperty
Pythonaws_cdk.aws_appsync.CfnGraphQLApi.UserPoolConfigProperty
TypeScript aws-cdk-lib » aws_appsync » CfnGraphQLApi » UserPoolConfigProperty

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const userPoolConfigProperty: appsync.CfnGraphQLApi.UserPoolConfigProperty = {
  appIdClientRegex: 'appIdClientRegex',
  awsRegion: 'awsRegion',
  defaultAction: 'defaultAction',
  userPoolId: 'userPoolId',
};

Properties

NameTypeDescription
appIdClientRegex?stringA regular expression for validating the incoming Amazon Cognito user pool app client ID.
awsRegion?stringThe AWS Region in which the user pool was created.
defaultAction?stringThe 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.
userPoolId?stringThe user pool ID.

appIdClientRegex?

Type: string (optional)

A regular expression for validating the incoming Amazon Cognito user pool app client ID.

If this value isn't set, no filtering is applied.


awsRegion?

Type: string (optional)

The AWS Region in which the user pool was created.


defaultAction?

Type: string (optional)

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 .


userPoolId?

Type: string (optional)

The user pool ID.