interface CognitoConfigProperty

Language	Type name
.NET	Amazon.CDK.AWS.AppSync.CfnApi.CognitoConfigProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnApi_CognitoConfigProperty
Java	software.amazon.awscdk.services.appsync.CfnApi.CognitoConfigProperty
Python	aws_cdk.aws_appsync.CfnApi.CognitoConfigProperty
TypeScript	aws-cdk-lib » aws_appsync » CfnApi » CognitoConfigProperty

Describes an Amazon Cognito configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-cognitoconfig.html

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 cognitoConfigProperty: appsync.CfnApi.CognitoConfigProperty = {
  awsRegion: 'awsRegion',
  userPoolId: 'userPoolId',

  // the properties below are optional
  appIdClientRegex: 'appIdClientRegex',
};

Properties

Name	Type	Description
awsRegion	string	The AWS Region in which the user pool was created.
userPoolId	string	The user pool ID.
appIdClientRegex?	string	A regular expression for validating the incoming Amazon Cognito user pool app client ID.

---

awsRegion

Type: string

The AWS Region in which the user pool was created.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-cognitoconfig.html#cfn-appsync-api-cognitoconfig-awsregion

---

userPoolId

Type: string

The user pool ID.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-cognitoconfig.html#cfn-appsync-api-cognitoconfig-userpoolid

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-cognitoconfig.html#cfn-appsync-api-cognitoconfig-appidclientregex