aws-cdk-lib.aws_appsync.UserPoolConfig

UserPoolConfig Struct

Configuration for Cognito user-pools in AppSync.

Source

aws-appsync/lib/graphqlapi.ts

Type last changed

v2.60.0 · 12 Jan 2023

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

appIdClientRegexstringapp_id_client_regexstrappIdClientRegexStringAppIdClientRegexstringAppIdClientRegex*string= None#

the optional app id regex.

defaultActionUserPoolDefaultActiondefault_actionUserPoolDefaultActiondefaultActionUserPoolDefaultActionDefaultActionUserPoolDefaultActionDefaultActionUserPoolDefaultAction= ALLOW#

Default auth action.

userPoolIUserPooluser_poolIUserPooluserPoolIUserPoolUserPoolIUserPoolUserPoolIUserPoolrequired#

The Cognito user pool to use as identity source.