aws-cdk-lib.aws_appsync.UserPoolConfig

interface UserPoolConfig

LanguageType name
.NETAmazon.CDK.AWS.AppSync.UserPoolConfig
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappsync#UserPoolConfig
Javasoftware.amazon.awscdk.services.appsync.UserPoolConfig
Pythonaws_cdk.aws_appsync.UserPoolConfig
TypeScript (source)aws-cdk-lib » aws_appsync » UserPoolConfig

Configuration for Cognito user-pools in AppSync.

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';
import { aws_cognito as cognito } from 'aws-cdk-lib';

declare const userPool: cognito.UserPool;
const userPoolConfig: appsync.UserPoolConfig = {
  userPool: userPool,

  // the properties below are optional
  appIdClientRegex: 'appIdClientRegex',
  defaultAction: appsync.UserPoolDefaultAction.ALLOW,
};

Properties

NameTypeDescription
userPoolIUserPoolThe Cognito user pool to use as identity source.
appIdClientRegex?stringthe optional app id regex.
defaultAction?UserPoolDefaultActionDefault auth action.

userPool

Type: IUserPool

The Cognito user pool to use as identity source.


appIdClientRegex?

Type: string (optional, default: None)

the optional app id regex.


defaultAction?

Type: UserPoolDefaultAction (optional, default: ALLOW)

Default auth action.