# UserPoolConfig

Configuration for Cognito user-pools in AppSync.

- Source: [`aws-appsync/lib/graphqlapi.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-appsync/lib/graphqlapi.ts#L73)
- Type last changed: v2.60.0 · 12 Jan 2023

## 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';
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

- `appIdClientRegex`: string = None — the optional app id regex.

- `defaultAction`: [UserPoolDefaultAction](/cdk/api/v2/docs/aws-cdk-lib.aws_appsync.UserPoolDefaultAction.html) = ALLOW — Default auth action.

- `userPool`: [IUserPool](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.IUserPool.html) (required) — The Cognito user pool to use as identity source.