interface CognitoConfigProperty

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.AppSync.CfnApiPropsMixin.CognitoConfigProperty
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsappsync#CfnApiPropsMixin_CognitoConfigProperty
Java	software.amazon.awscdk.cfnpropertymixins.services.appsync.CfnApiPropsMixin.CognitoConfigProperty
Python	aws_cdk.cfn_property_mixins.aws_appsync.CfnApiPropsMixin.CognitoConfigProperty
TypeScript	@aws-cdk/cfn-property-mixins » aws_appsync » CfnApiPropsMixin » 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/cfn-property-mixins';
const cognitoConfigProperty: appsync.CfnApiPropsMixin.CognitoConfigProperty = {
  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.

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

---

awsRegion?

Type: string (optional)

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 (optional)

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