Package software.amazon.awscdk.services.cognito

Interface CfnUserPoolProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:16.642Z")
@Stability(Stable)
public interface CfnUserPoolProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnUserPool.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 Object userPoolTags;
 CfnUserPoolProps cfnUserPoolProps = CfnUserPoolProps.builder()
         .accountRecoverySetting(AccountRecoverySettingProperty.builder()
                 .recoveryMechanisms(List.of(RecoveryOptionProperty.builder()
                         .name("name")
                         .priority(123)
                         .build()))
                 .build())
         .adminCreateUserConfig(AdminCreateUserConfigProperty.builder()
                 .allowAdminCreateUserOnly(false)
                 .inviteMessageTemplate(InviteMessageTemplateProperty.builder()
                         .emailMessage("emailMessage")
                         .emailSubject("emailSubject")
                         .smsMessage("smsMessage")
                         .build())
                 .unusedAccountValidityDays(123)
                 .build())
         .aliasAttributes(List.of("aliasAttributes"))
         .autoVerifiedAttributes(List.of("autoVerifiedAttributes"))
         .deletionProtection("deletionProtection")
         .deviceConfiguration(DeviceConfigurationProperty.builder()
                 .challengeRequiredOnNewDevice(false)
                 .deviceOnlyRememberedOnUserPrompt(false)
                 .build())
         .emailAuthenticationMessage("emailAuthenticationMessage")
         .emailAuthenticationSubject("emailAuthenticationSubject")
         .emailConfiguration(EmailConfigurationProperty.builder()
                 .configurationSet("configurationSet")
                 .emailSendingAccount("emailSendingAccount")
                 .from("from")
                 .replyToEmailAddress("replyToEmailAddress")
                 .sourceArn("sourceArn")
                 .build())
         .emailVerificationMessage("emailVerificationMessage")
         .emailVerificationSubject("emailVerificationSubject")
         .enabledMfas(List.of("enabledMfas"))
         .lambdaConfig(LambdaConfigProperty.builder()
                 .createAuthChallenge("createAuthChallenge")
                 .customEmailSender(CustomEmailSenderProperty.builder()
                         .lambdaArn("lambdaArn")
                         .lambdaVersion("lambdaVersion")
                         .build())
                 .customMessage("customMessage")
                 .customSmsSender(CustomSMSSenderProperty.builder()
                         .lambdaArn("lambdaArn")
                         .lambdaVersion("lambdaVersion")
                         .build())
                 .defineAuthChallenge("defineAuthChallenge")
                 .kmsKeyId("kmsKeyId")
                 .postAuthentication("postAuthentication")
                 .postConfirmation("postConfirmation")
                 .preAuthentication("preAuthentication")
                 .preSignUp("preSignUp")
                 .preTokenGeneration("preTokenGeneration")
                 .preTokenGenerationConfig(PreTokenGenerationConfigProperty.builder()
                         .lambdaArn("lambdaArn")
                         .lambdaVersion("lambdaVersion")
                         .build())
                 .userMigration("userMigration")
                 .verifyAuthChallengeResponse("verifyAuthChallengeResponse")
                 .build())
         .mfaConfiguration("mfaConfiguration")
         .policies(PoliciesProperty.builder()
                 .passwordPolicy(PasswordPolicyProperty.builder()
                         .minimumLength(123)
                         .passwordHistorySize(123)
                         .requireLowercase(false)
                         .requireNumbers(false)
                         .requireSymbols(false)
                         .requireUppercase(false)
                         .temporaryPasswordValidityDays(123)
                         .build())
                 .signInPolicy(SignInPolicyProperty.builder()
                         .allowedFirstAuthFactors(List.of("allowedFirstAuthFactors"))
                         .build())
                 .build())
         .schema(List.of(SchemaAttributeProperty.builder()
                 .attributeDataType("attributeDataType")
                 .developerOnlyAttribute(false)
                 .mutable(false)
                 .name("name")
                 .numberAttributeConstraints(NumberAttributeConstraintsProperty.builder()
                         .maxValue("maxValue")
                         .minValue("minValue")
                         .build())
                 .required(false)
                 .stringAttributeConstraints(StringAttributeConstraintsProperty.builder()
                         .maxLength("maxLength")
                         .minLength("minLength")
                         .build())
                 .build()))
         .smsAuthenticationMessage("smsAuthenticationMessage")
         .smsConfiguration(SmsConfigurationProperty.builder()
                 .externalId("externalId")
                 .snsCallerArn("snsCallerArn")
                 .snsRegion("snsRegion")
                 .build())
         .smsVerificationMessage("smsVerificationMessage")
         .userAttributeUpdateSettings(UserAttributeUpdateSettingsProperty.builder()
                 .attributesRequireVerificationBeforeUpdate(List.of("attributesRequireVerificationBeforeUpdate"))
                 .build())
         .usernameAttributes(List.of("usernameAttributes"))
         .usernameConfiguration(UsernameConfigurationProperty.builder()
                 .caseSensitive(false)
                 .build())
         .userPoolAddOns(UserPoolAddOnsProperty.builder()
                 .advancedSecurityAdditionalFlows(AdvancedSecurityAdditionalFlowsProperty.builder()
                         .customAuthMode("customAuthMode")
                         .build())
                 .advancedSecurityMode("advancedSecurityMode")
                 .build())
         .userPoolName("userPoolName")
         .userPoolTags(userPoolTags)
         .userPoolTier("userPoolTier")
         .verificationMessageTemplate(VerificationMessageTemplateProperty.builder()
                 .defaultEmailOption("defaultEmailOption")
                 .emailMessage("emailMessage")
                 .emailMessageByLink("emailMessageByLink")
                 .emailSubject("emailSubject")
                 .emailSubjectByLink("emailSubjectByLink")
                 .smsMessage("smsMessage")
                 .build())
         .webAuthnRelyingPartyId("webAuthnRelyingPartyId")
         .webAuthnUserVerification("webAuthnUserVerification")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPoolProps.Builder	A builder for CfnUserPoolProps
static final class	CfnUserPoolProps.Jsii$Proxy	An implementation for CfnUserPoolProps

Method Summary

Modifier and Type	Method	Description
static CfnUserPoolProps.Builder	builder()
default Object	getAccountRecoverySetting()	The available verified method a user can use to recover their password when they call ForgotPassword .
default Object	getAdminCreateUserConfig()	The settings for administrator creation of users in a user pool.
default List<String>	getAliasAttributes()	Attributes supported as an alias for this user pool.
default List<String>	getAutoVerifiedAttributes()	The attributes that you want your user pool to automatically verify.
default String	getDeletionProtection()	When active, DeletionProtection prevents accidental deletion of your user pool.
default Object	getDeviceConfiguration()	The device-remembering configuration for a user pool.
default String	getEmailAuthenticationMessage()
default String	getEmailAuthenticationSubject()
default Object	getEmailConfiguration()	The email configuration of your user pool.
default String	getEmailVerificationMessage()	This parameter is no longer used.
default String	getEmailVerificationSubject()	This parameter is no longer used.
default List<String>	getEnabledMfas()	Set enabled MFA options on a specified user pool.
default Object	getLambdaConfig()	A collection of user pool Lambda triggers.
default String	getMfaConfiguration()	Displays the state of multi-factor authentication (MFA) as on, off, or optional.
default Object	getPolicies()	A list of user pool policies.
default Object	getSchema()	An array of attributes for the new user pool.
default String	getSmsAuthenticationMessage()	The contents of the SMS authentication message.
default Object	getSmsConfiguration()	The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service.
default String	getSmsVerificationMessage()	This parameter is no longer used.
default Object	getUserAttributeUpdateSettings()	The settings for updates to user attributes.
default List<String>	getUsernameAttributes()	Specifies whether a user can use an email address or phone number as a username when they sign up.
default Object	getUsernameConfiguration()	Sets the case sensitivity option for sign-in usernames.
default Object	getUserPoolAddOns()	Contains settings for activation of threat protection, including the operating mode and additional authentication types.
default String	getUserPoolName()	A friendly name for your user pool.
default Object	getUserPoolTags()	The tag keys and values to assign to the user pool.
default String	getUserPoolTier()	The user pool feature plan , or tier.
default Object	getVerificationMessageTemplate()	The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
default String	getWebAuthnRelyingPartyId()	Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.
default String	getWebAuthnUserVerification()	When required , users can only register and sign in users with passkeys that are capable of user verification .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccountRecoverySetting

@Stability(Stable)
@Nullable
default Object getAccountRecoverySetting()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-accountrecoverysetting

getAdminCreateUserConfig

@Stability(Stable)
@Nullable
default Object getAdminCreateUserConfig()

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.

This data type is a request and response parameter of API_CreateUserPool and API_UpdateUserPool , and a response parameter of API_DescribeUserPool .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-admincreateuserconfig

getAliasAttributes

@Stability(Stable)
@Nullable
default List<String> getAliasAttributes()

Attributes supported as an alias for this user pool.

For more information about alias attributes, see Customizing sign-in attributes .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-aliasattributes

getAutoVerifiedAttributes

@Stability(Stable)
@Nullable
default List<String> getAutoVerifiedAttributes()

The attributes that you want your user pool to automatically verify.

For more information, see Verifying contact information at sign-up .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-autoverifiedattributes

getDeletionProtection

@Stability(Stable)
@Nullable
default String getDeletionProtection()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-deletionprotection

getDeviceConfiguration

@Stability(Stable)
@Nullable
default Object getDeviceConfiguration()

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 . 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 infor

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-deviceconfiguration

getEmailAuthenticationMessage

@Stability(Stable)
@Nullable
default String getEmailAuthenticationMessage()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailauthenticationmessage

getEmailAuthenticationSubject

@Stability(Stable)
@Nullable
default String getEmailAuthenticationSubject()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailauthenticationsubject

getEmailConfiguration

@Stability(Stable)
@Nullable
default Object getEmailConfiguration()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailconfiguration

getEmailVerificationMessage

@Stability(Stable)
@Nullable
default String getEmailVerificationMessage()

This parameter is no longer used.

See VerificationMessageTemplateType .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailverificationmessage

getEmailVerificationSubject

@Stability(Stable)
@Nullable
default String getEmailVerificationSubject()

This parameter is no longer used.

See VerificationMessageTemplateType .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailverificationsubject

getEnabledMfas

@Stability(Stable)
@Nullable
default List<String> getEnabledMfas()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-enabledmfas

getLambdaConfig

@Stability(Stable)
@Nullable
default Object getLambdaConfig()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-lambdaconfig

getMfaConfiguration

@Stability(Stable)
@Nullable
default String getMfaConfiguration()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-mfaconfiguration

getPolicies

@Stability(Stable)
@Nullable
default Object getPolicies()

A list of user pool policies. Contains the policy that sets password-complexity requirements.

This data type is a request and response parameter of API_CreateUserPool and API_UpdateUserPool , and a response parameter of API_DescribeUserPool .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-policies

getSchema

@Stability(Stable)
@Nullable
default Object getSchema()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-schema

getSmsAuthenticationMessage

@Stability(Stable)
@Nullable
default String getSmsAuthenticationMessage()

The contents of the SMS authentication message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsauthenticationmessage

getSmsConfiguration

@Stability(Stable)
@Nullable
default Object getSmsConfiguration()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsconfiguration

getSmsVerificationMessage

@Stability(Stable)
@Nullable
default String getSmsVerificationMessage()

This parameter is no longer used.

See VerificationMessageTemplateType .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsverificationmessage

getUserAttributeUpdateSettings

@Stability(Stable)
@Nullable
default Object getUserAttributeUpdateSettings()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userattributeupdatesettings

getUsernameAttributes

@Stability(Stable)
@Nullable
default List<String> getUsernameAttributes()

Specifies whether a user can use an email address or phone number as a username when they sign up.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameattributes

getUsernameConfiguration

@Stability(Stable)
@Nullable
default Object getUsernameConfiguration()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameconfiguration

getUserPoolAddOns

@Stability(Stable)
@Nullable
default Object getUserPoolAddOns()

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 . To activate this setting, your user pool must be on the Plus tier .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooladdons

getUserPoolName

@Stability(Stable)
@Nullable
default String getUserPoolName()

A friendly name for your user pool.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpoolname

getUserPoolTags

@Stability(Stable)
@Nullable
default Object getUserPoolTags()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooltags

getUserPoolTier

@Stability(Stable)
@Nullable
default String getUserPoolTier()

The user pool feature plan , 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooltier

getVerificationMessageTemplate

@Stability(Stable)
@Nullable
default Object getVerificationMessageTemplate()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-verificationmessagetemplate

getWebAuthnRelyingPartyId

@Stability(Stable)
@Nullable
default String getWebAuthnRelyingPartyId()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-webauthnrelyingpartyid

getWebAuthnUserVerification

@Stability(Stable)
@Nullable
default String getWebAuthnUserVerification()

When required , users can only register and sign in users with passkeys that are capable of user verification . When preferred , your user pool doesn't require the use of authenticators with user verification but encourages it.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-webauthnuserverification

builder

@Stability(Stable)
static CfnUserPoolProps.Builder builder()

Returns:

a CfnUserPoolProps.Builder of CfnUserPoolProps