Skip to content
v2.278.0

CognitoUserPoolConfigProperty Struct ​

Describes an Amazon Cognito user pool configuration.

Example ​

ts
// 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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appsync as appsync

cognito_user_pool_config_property = appsync.CfnGraphQLApi.CognitoUserPoolConfigProperty(
    app_id_client_regex="appIdClientRegex",
    aws_region="awsRegion",
    user_pool_id="userPoolId"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.appsync.*;

CognitoUserPoolConfigProperty cognitoUserPoolConfigProperty = CognitoUserPoolConfigProperty.builder()
        .appIdClientRegex("appIdClientRegex")
        .awsRegion("awsRegion")
        .userPoolId("userPoolId")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppSync;

var cognitoUserPoolConfigProperty = new CognitoUserPoolConfigProperty {
    AppIdClientRegex = "appIdClientRegex",
    AwsRegion = "awsRegion",
    UserPoolId = "userPoolId"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cognitoUserPoolConfigProperty := &CognitoUserPoolConfigProperty{
	AppIdClientRegex: jsii.String("appIdClientRegex"),
	AwsRegion: jsii.String("awsRegion"),
	UserPoolId: jsii.String("userPoolId"),
}

Properties ​

appIdClientRegexoptionalstringapp_id_client_regexoptionalstrappIdClientRegexoptionalStringAppIdClientRegexoptionalstringAppIdClientRegexoptional*string #
A regular expression for validating the incoming Amazon Cognito user pool app client ID.

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

awsRegionoptionalstringaws_regionoptionalstrawsRegionoptionalStringAwsRegionoptionalstringAwsRegionoptional*string #
The AWS Region in which the user pool was created.
userPoolIdoptionalstringuser_pool_idoptionalstruserPoolIdoptionalStringUserPoolIdoptionalstringUserPoolIdoptional*string #
The user pool ID.