interface CognitoUserPoolConfigProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AppSync.CfnGraphQLApi.CognitoUserPoolConfigProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnGraphQLApi_CognitoUserPoolConfigProperty |
![]() | software.amazon.awscdk.services.appsync.CfnGraphQLApi.CognitoUserPoolConfigProperty |
![]() | aws_cdk.aws_appsync.CfnGraphQLApi.CognitoUserPoolConfigProperty |
![]() | 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
Name | Type | Description |
---|---|---|
app | string | A regular expression for validating the incoming Amazon Cognito user pool app client ID. |
aws | string | The AWS Region in which the user pool was created. |
user | 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.