aws-cdk-lib.aws_appsync.CfnGraphQLApi.CognitoUserPoolConfigProperty

interface CognitoUserPoolConfigProperty

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

Describes an Amazon Cognito user pool configuration.

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 cognitoUserPoolConfigProperty: appsync.CfnGraphQLApi.CognitoUserPoolConfigProperty = {
  appIdClientRegex: 'appIdClientRegex',
  awsRegion: 'awsRegion',
  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.
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.


userPoolId?

Type: string (optional)

The user pool ID.