# CfnUserPool

The `AWS::Cognito::UserPool` resource creates an Amazon Cognito user pool.

For more information on working with Amazon Cognito user pools, see [Amazon Cognito User Pools](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html) and [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) .

> If you don't specify a value for a parameter, Amazon Cognito sets it to a default value.

Extends: Construct › CfnElement › CfnRefElement › CfnResource › CfnUserPool
Implements: IInspectable, ITaggable, IEnvironmentAware, IUserPoolRef, IConstruct, IDependable

- CloudFormation: [`AWS::Cognito::UserPool`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-cognito-userpool.html)
- Source: Generated code
- Type last changed: v2.262.0 · 22 Jul 2026

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';

declare const userPoolTags: any;
const cfnUserPool = new cognito.CfnUserPool(this, 'MyCfnUserPool', /* all optional props */ {
  accountRecoverySetting: {
    recoveryMechanisms: [{
      name: 'name',
      priority: 123,
    }],
  },
  adminCreateUserConfig: {
    allowAdminCreateUserOnly: false,
    inviteMessageTemplate: {
      emailMessage: 'emailMessage',
      emailSubject: 'emailSubject',
      smsMessage: 'smsMessage',
    },
    unusedAccountValidityDays: 123,
  },
  aliasAttributes: ['aliasAttributes'],
  autoVerifiedAttributes: ['autoVerifiedAttributes'],
  deletionProtection: 'deletionProtection',
  deviceConfiguration: {
    challengeRequiredOnNewDevice: false,
    deviceOnlyRememberedOnUserPrompt: false,
  },
  emailAuthenticationMessage: 'emailAuthenticationMessage',
  emailAuthenticationSubject: 'emailAuthenticationSubject',
  emailConfiguration: {
    configurationSet: 'configurationSet',
    emailSendingAccount: 'emailSendingAccount',
    from: 'from',
    replyToEmailAddress: 'replyToEmailAddress',
    sourceArn: 'sourceArn',
  },
  emailVerificationMessage: 'emailVerificationMessage',
  emailVerificationSubject: 'emailVerificationSubject',
  enabledMfas: ['enabledMfas'],
  issuerConfiguration: {
    type: 'type',
  },
  keyConfiguration: {
    keyType: 'keyType',
    kmsKeyArn: 'kmsKeyArn',
  },
  lambdaConfig: {
    createAuthChallenge: 'createAuthChallenge',
    customEmailSender: {
      lambdaArn: 'lambdaArn',
      lambdaVersion: 'lambdaVersion',
    },
    customMessage: 'customMessage',
    customSmsSender: {
      lambdaArn: 'lambdaArn',
      lambdaVersion: 'lambdaVersion',
    },
    defineAuthChallenge: 'defineAuthChallenge',
    inboundFederation: {
      lambdaArn: 'lambdaArn',
      lambdaVersion: 'lambdaVersion',
    },
    kmsKeyId: 'kmsKeyId',
    postAuthentication: 'postAuthentication',
    postConfirmation: 'postConfirmation',
    preAuthentication: 'preAuthentication',
    preSignUp: 'preSignUp',
    preTokenGeneration: 'preTokenGeneration',
    preTokenGenerationConfig: {
      lambdaArn: 'lambdaArn',
      lambdaVersion: 'lambdaVersion',
    },
    userMigration: 'userMigration',
    verifyAuthChallengeResponse: 'verifyAuthChallengeResponse',
  },
  mfaConfiguration: 'mfaConfiguration',
  policies: {
    passwordPolicy: {
      minimumLength: 123,
      passwordHistorySize: 123,
      requireLowercase: false,
      requireNumbers: false,
      requireSymbols: false,
      requireUppercase: false,
      temporaryPasswordValidityDays: 123,
    },
    signInPolicy: {
      allowedFirstAuthFactors: ['allowedFirstAuthFactors'],
    },
  },
  schema: [{
    attributeDataType: 'attributeDataType',
    developerOnlyAttribute: false,
    mutable: false,
    name: 'name',
    numberAttributeConstraints: {
      maxValue: 'maxValue',
      minValue: 'minValue',
    },
    required: false,
    stringAttributeConstraints: {
      maxLength: 'maxLength',
      minLength: 'minLength',
    },
  }],
  smsAuthenticationMessage: 'smsAuthenticationMessage',
  smsConfiguration: {
    eumsSms: {
      callerArn: 'callerArn',

      // the properties below are optional
      configurationSetName: 'configurationSetName',
      externalId: 'externalId',
      inEntityId: 'inEntityId',
      inTemplateId: 'inTemplateId',
      originationIdentity: 'originationIdentity',
      region: 'region',
    },
    externalId: 'externalId',
    snsCallerArn: 'snsCallerArn',
    snsRegion: 'snsRegion',
  },
  smsVerificationMessage: 'smsVerificationMessage',
  userAttributeUpdateSettings: {
    attributesRequireVerificationBeforeUpdate: ['attributesRequireVerificationBeforeUpdate'],
  },
  usernameAttributes: ['usernameAttributes'],
  usernameConfiguration: {
    caseSensitive: false,
  },
  userPoolAddOns: {
    advancedSecurityAdditionalFlows: {
      customAuthMode: 'customAuthMode',
    },
    advancedSecurityMode: 'advancedSecurityMode',
  },
  userPoolName: 'userPoolName',
  userPoolTags: userPoolTags,
  userPoolTier: 'userPoolTier',
  verificationMessageTemplate: {
    defaultEmailOption: 'defaultEmailOption',
    emailMessage: 'emailMessage',
    emailMessageByLink: 'emailMessageByLink',
    emailSubject: 'emailSubject',
    emailSubjectByLink: 'emailSubjectByLink',
    smsMessage: 'smsMessage',
  },
  webAuthnFactorConfiguration: 'webAuthnFactorConfiguration',
  webAuthnRelyingPartyId: 'webAuthnRelyingPartyId',
  webAuthnUserVerification: 'webAuthnUserVerification',
});
```

## Initializer

```ts
new CfnUserPool(scope: Construct, id: string, props?: CfnUserPoolProps)
```

## Construct Props

- `accountRecoverySetting`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.AccountRecoverySettingProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.AccountRecoverySettingProperty.html) — The available verified method a user can use to recover their password when they call `ForgotPassword` .

  You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

- `adminCreateUserConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.AdminCreateUserConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.AdminCreateUserConfigProperty.html) — The settings for administrator creation of users in a user pool.

  Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.

- `aliasAttributes`: string[] — Attributes supported as an alias for this user pool.

  For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) .

- `autoVerifiedAttributes`: string[] — The attributes that you want your user pool to automatically verify.

  For more information, see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) .

- `deletionProtection`: string — When active, `DeletionProtection` prevents accidental deletion of your user pool.

  Before you can delete a user pool that you have protected against deletion, you
  must deactivate this feature.

  When you try to delete a protected user pool in a `DeleteUserPool` API request, Amazon Cognito returns an `InvalidParameterException` error. To delete a protected user pool, send a new `DeleteUserPool` request after you deactivate deletion protection in an `UpdateUserPool` API request.

- `deviceConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.DeviceConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.DeviceConfigurationProperty.html) — The device-remembering configuration for a user pool.

  Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool.

  > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more information, see [Working with devices](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) .

- `emailAuthenticationMessage`: string

- `emailAuthenticationSubject`: string

- `emailConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.EmailConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.EmailConfigurationProperty.html) — The email configuration of your user pool.

  The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.

- `emailVerificationMessage`: string — This parameter is no longer used.

  See [VerificationMessageTemplateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html) .

- `emailVerificationSubject`: string — This parameter is no longer used.

  See [VerificationMessageTemplateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html) .

- `enabledMfas`: string[] — Set enabled MFA options on a specified user pool.

  To disable all MFAs after it has been enabled, set `MfaConfiguration` to `OFF` and remove EnabledMfas. MFAs can only be all disabled if `MfaConfiguration` is `OFF` . After you enable `SMS_MFA` , you can only disable it by setting `MfaConfiguration` to `OFF` . Can be one of the following values:

  - `SMS_MFA` - Enables MFA with SMS for the user pool. To select this option, you must also provide values for `SmsConfiguration` .
  - `SOFTWARE_TOKEN_MFA` - Enables software token MFA for the user pool.
  - `EMAIL_OTP` - Enables MFA with email for the user pool. To select this option, you must provide values for `EmailConfiguration` and within those, set `EmailSendingAccount` to `DEVELOPER` .

  Allowed values: `SMS_MFA` | `SOFTWARE_TOKEN_MFA` | `EMAIL_OTP`

- `issuerConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.IssuerConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.IssuerConfigurationProperty.html)

- `keyConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.KeyConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.KeyConfigurationProperty.html)

- `lambdaConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.LambdaConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.LambdaConfigProperty.html) — A collection of user pool Lambda triggers.

  Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.

- `mfaConfiguration`: string — Displays the state of multi-factor authentication (MFA) as on, off, or optional.

  When `ON` , all users must set up MFA before they can sign in. When `OPTIONAL` , your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose `OPTIONAL` .

  When `MfaConfiguration` is `OPTIONAL` , managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.

- `policies`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.PoliciesProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.PoliciesProperty.html) — A list of user pool policies.

  Contains the policy that sets password-complexity requirements.

- `schema`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.SchemaAttributeProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.SchemaAttributeProperty.html)[] — An array of attributes for the new user pool.

  You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) .

- `smsAuthenticationMessage`: string — The contents of the SMS authentication message.

- `smsConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.SmsConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.SmsConfigurationProperty.html) — The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service.

  To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) .

- `smsVerificationMessage`: string — This parameter is no longer used.

  See [VerificationMessageTemplateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html) .

- `userAttributeUpdateSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.UserAttributeUpdateSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.UserAttributeUpdateSettingsProperty.html) — The settings for updates to user attributes.

  These settings include the property `AttributesRequireVerificationBeforeUpdate` ,
  a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For
  more information, see [Verifying updates to email addresses and phone numbers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates) .

- `usernameAttributes`: string[] — Specifies whether a user can use an email address or phone number as a username when they sign up.

- `usernameConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.UsernameConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.UsernameConfigurationProperty.html) — Sets the case sensitivity option for sign-in usernames.

  When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.

  When `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users.

  This configuration is immutable after you set it.

- `userPoolAddOns`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.UserPoolAddOnsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.UserPoolAddOnsProperty.html) — Contains settings for activation of threat protection, including the operating mode and additional authentication types.

  To log user security information but take no action, set to `AUDIT` . To configure automatic security responses to potentially unwanted traffic to your user pool, set to `ENFORCED` .

  For more information, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html) . To activate this setting, your user pool must be on the [Plus tier](https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html) .

- `userPoolName`: string — A friendly name for your user pool.

- `userPoolTags`: any — The tag keys and values to assign to the user pool.

  A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

- `userPoolTier`: string — The user pool [feature plan](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html) , or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to `ESSENTIALS` .

- `verificationMessageTemplate`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.VerificationMessageTemplateProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.VerificationMessageTemplateProperty.html) — The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

  Set the email message type that corresponds to your `DefaultEmailOption` selection. For `CONFIRM_WITH_LINK` , specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE` , specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error.

- `webAuthnFactorConfiguration`: string

- `webAuthnRelyingPartyId`: string — Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.

  Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain:

  - The user pool is configured for passkey authentication.
  - The user pool has a custom domain, whether or not it also has a prefix domain.
  - Your application performs authentication with managed login or the classic hosted UI.

- `webAuthnUserVerification`: string — When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it.

## Properties

- `accountRecoverySetting`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.AccountRecoverySettingProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.AccountRecoverySettingProperty.html) — The available verified method a user can use to recover their password when they call `ForgotPassword` .

- `adminCreateUserConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.AdminCreateUserConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.AdminCreateUserConfigProperty.html) — The settings for administrator creation of users in a user pool.

- `aliasAttributes`: string[] — Attributes supported as an alias for this user pool.

- `attrArn`: string — The Amazon Resource Name (ARN) of the user pool, such as `arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341` .

- `attrProviderName`: string — A friendly name for the IdP.

- `attrProviderUrl`: string — The URL of the provider of the Amazon Cognito user pool, specified as a `String` .

- `attrUserPoolId`: string — The ID of the user pool.

- `autoVerifiedAttributes`: string[] — The attributes that you want your user pool to automatically verify.

- `CFN_RESOURCE_TYPE_NAME`: string (static) — The CloudFormation resource type name for this resource class.

- `cfnOptions`: [ICfnResourceOptions](/cdk/api/v2/docs/aws-cdk-lib.ICfnResourceOptions.html) — Options for this resource, such as condition, update policy etc.

- `cfnResourceType`: string — AWS resource type.

- `creationStack`: string[]

- `deletionProtection`: string — When active, `DeletionProtection` prevents accidental deletion of your user pool.

- `deviceConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.DeviceConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.DeviceConfigurationProperty.html) — The device-remembering configuration for a user pool.

- `emailAuthenticationMessage`: string

- `emailAuthenticationSubject`: string

- `emailConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.EmailConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.EmailConfigurationProperty.html) — The email configuration of your user pool.

- `emailVerificationMessage`: string — This parameter is no longer used.

- `emailVerificationSubject`: string — This parameter is no longer used.

- `enabledMfas`: string[] — Set enabled MFA options on a specified user pool.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html)

- `issuerConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.IssuerConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.IssuerConfigurationProperty.html)

- `keyConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.KeyConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.KeyConfigurationProperty.html)

- `lambdaConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.LambdaConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.LambdaConfigProperty.html) — A collection of user pool Lambda triggers.

- `logicalId`: string — The logical ID for this CloudFormation stack element.

  The logical ID of the element
  is calculated from the path of the resource node in the construct tree.

  To override this value, use `overrideLogicalId(newLogicalId)`.

- `mfaConfiguration`: string — Displays the state of multi-factor authentication (MFA) as on, off, or optional.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `policies`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.PoliciesProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.PoliciesProperty.html) — A list of user pool policies.

- `ref`: string — Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

  If, by any chance, the intrinsic reference of a resource is not a string, you could
  coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.

- `schema`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.SchemaAttributeProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.SchemaAttributeProperty.html)[] — An array of attributes for the new user pool.

- `smsAuthenticationMessage`: string — The contents of the SMS authentication message.

- `smsConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.SmsConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.SmsConfigurationProperty.html) — The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service.

- `smsVerificationMessage`: string — This parameter is no longer used.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this element is defined.

  CfnElements must be defined within a stack scope (directly or indirectly).

- `tags`: [TagManager](/cdk/api/v2/docs/aws-cdk-lib.TagManager.html) — Tag Manager which manages the tags for this resource.

- `userAttributeUpdateSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.UserAttributeUpdateSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.UserAttributeUpdateSettingsProperty.html) — The settings for updates to user attributes.

- `usernameAttributes`: string[] — Specifies whether a user can use an email address or phone number as a username when they sign up.

- `usernameConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.UsernameConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.UsernameConfigurationProperty.html) — Sets the case sensitivity option for sign-in usernames.

- `userPoolAddOns`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.UserPoolAddOnsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.UserPoolAddOnsProperty.html) — Contains settings for activation of threat protection, including the operating mode and additional authentication types.

- `userPoolName`: string — A friendly name for your user pool.

- `userPoolRef`: [UserPoolReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_cognito.UserPoolReference.html) — A reference to a UserPool resource.

- `userPoolTagsRaw`: any — The tag keys and values to assign to the user pool.

- `userPoolTier`: string — The user pool [feature plan](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html) , or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to `ESSENTIALS` .

- `verificationMessageTemplate`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnUserPool.VerificationMessageTemplateProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnUserPool.VerificationMessageTemplateProperty.html) — The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

- `webAuthnFactorConfiguration`: string

- `webAuthnRelyingPartyId`: string — Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.

- `webAuthnUserVerification`: string — When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it.

## Methods

- `addDeletionOverride(path: string): void` — Syntactic sugar for `addOverride(path, undefined)`.

  **Parameters**

  - `path` — The path of the value to delete.

- `addDependency(target: CfnResource): void` — Use `addResourceDependency` instead.

  This method has been renamed to `addResourceDependency` to more clearly
  set it apart from `construct.node.addDependency`. See the documentation
  of that function for more details.

- `addDependsOn(target: CfnResource): void` — Use `addResourceDependency` instead.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method has been renamed to `addResourceDependency`, which makes it
  more clear that this method operates at a different level from the
  construct-level `construct.node.addDependency()` mechanism.

- `addMetadata(key: string, value: any): void` — Add a value to the CloudFormation Resource Metadata.

- `addOverride(path: string, value: any): void` — Adds an override to the synthesized CloudFormation resource.

  To add a
  property override, either use `addPropertyOverride` or prefix `path` with
  "Properties." (i.e. `Properties.TopicName`).

  If the override is nested, separate each nested level using a dot (.) in the path parameter.
  If there is an array as part of the nesting, specify the index in the path.

  To include a literal `.` in the property name, prefix with a `\`. In most
  programming languages you will need to write this as `"\\."` because the
  `\` itself will need to be escaped.

  For example,
  ```typescript
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
  ```
  would add the overrides
  ```json
  "Properties": {
    "GlobalSecondaryIndexes": [
      {
        "Projection": {
          "NonKeyAttributes": [ "myattribute" ]
          ...
        }
        ...
      },
      {
        "ProjectionType": "INCLUDE"
        ...
      },
    ]
    ...
  }
  ```

  The `value` argument to `addOverride` will not be processed or translated
  in any way. Pass raw JSON values in here with the correct capitalization
  for CloudFormation. If you pass CDK classes or structs, they will be
  rendered with lowercased key names, and CloudFormation will reject the
  template.

  **Parameters**

  - `path` — - The path of the property, you can use dot notation to override values in complex types.
  - `value` — - The value.

- `addPropertyDeletionOverride(propertyPath: string): void` — Adds an override that deletes the value of a property from the resource definition.

  **Parameters**

  - `propertyPath` — The path to the property.

- `addPropertyOverride(propertyPath: string, value: any): void` — Adds an override to a resource property.

  Syntactic sugar for `addOverride("Properties.<...>", value)`.

  **Parameters**

  - `propertyPath` — The path of the property.
  - `value` — The value.

- `addResourceDependency(target: CfnResource, reason?: string): void` — Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method only adds dependencies between L1 resources. If you are
  looking for a generic construct-to-construct dependency mechanism that works
  for all constructs including L2s, use `construct.node.addDependency` instead.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Sets the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  strength instead of the global default from the consuming stack's context.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void` — Sets the deletion policy of the resource based on the removal policy specified.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
  cases, a snapshot can be taken of the resource prior to deletion
  (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
  can be found in the following link:

- `arnForUserPool(resource: IUserPoolRef): string` (static)

- `cfnPropertyName(cdkPropertyName: string): string`

- `fromUserPoolArn(scope: Construct, id: string, arn: string): IUserPoolRef` (static) — Creates a new IUserPoolRef from an ARN.

- `fromUserPoolId(scope: Construct, id: string, userPoolId: string): IUserPoolRef` (static) — Creates a new IUserPoolRef from a userPoolId.

- `getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference` — Returns a token for an runtime attribute of this resource.

  Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
  in case there is no generated attribute.

  **Parameters**

  - `attributeName` — The name of the attribute.

- `getMetadata(key: string): any` — Retrieve a value value from the CloudFormation Resource Metadata.

- `inspect(inspector: TreeInspector): void` — Examines the CloudFormation resource and discloses attributes.

  **Parameters**

  - `inspector` — tree inspector to collect and process attributes.

- `isCfnElement(x: any): boolean` (static) — Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

  Uses duck-typing instead of `instanceof` to allow stack elements from different
  versions of this library to be included in the same stack.

  **Returns:** The construct as a stack element or undefined if it is not a stack element.

- `isCfnResource(x: any): boolean` (static) — Check whether the given object is a CfnResource.

- `isCfnUserPool(x: any): boolean` (static) — Checks whether the given object is a CfnUserPool.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `obtainDependencies(): Stack | CfnResource[]` — Retrieves an array of resources and stacks this resource depends on.

  For resources depended on directly, returns the `CfnResource` object. For
  dependencies on other stacks, returns the `Stack` object. The order of the
  array is not guaranteed.

- `overrideLogicalId(newLogicalId: string): void` — Overrides the auto-generated logical ID with a specific ID.

  **Parameters**

  - `newLogicalId` — The new logical ID to use for this stack element.

- `removeDependency(target: CfnResource): void` — Use `removeResourceDependency` instead

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `removeResourceDependency(target: CfnResource): void` — Indicates that this resource no longer depends on another resource.

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `replaceDependency(target: CfnResource, newTarget: CfnResource): void` — Replaces one dependency with another.

  **Parameters**

  - `target` — The dependency to replace.
  - `newTarget` — The new dependency to add.

- `toString(): string` — Returns a string representation of this construct.

  **Returns:** a string representation of this resource

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.