interface CognitoUserPoolConfigProperty

Language	Type name
.NET	Amazon.CDK.AWS.AppSync.CfnGraphQLApi.CognitoUserPoolConfigProperty
Java	software.amazon.awscdk.services.appsync.CfnGraphQLApi.CognitoUserPoolConfigProperty
Python	aws_cdk.aws_appsync.CfnGraphQLApi.CognitoUserPoolConfigProperty
TypeScript	@aws-cdk/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 * as appsync from '@aws-cdk/aws-appsync';
const cognitoUserPoolConfigProperty: appsync.CfnGraphQLApi.CognitoUserPoolConfigProperty = {
  appIdClientRegex: 'appIdClientRegex',
  awsRegion: 'awsRegion',
  userPoolId: 'userPoolId',
};

Properties

Name	Type	Description
appIdClientRegex?	string	A regular expression for validating the incoming Amazon Cognito user pool app client ID.
awsRegion?	string	The AWS Region in which the user pool was created.
userPoolId?	string	The 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.