Package software.amazon.awscdk.cfnpropertymixins.services.cognito

Class CfnUserPoolPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.cognito.CfnUserPoolPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:57.410Z")
@Stability(Stable)
public class CfnUserPoolPropsMixin
extends Mixin
implements software.constructs.IMixin

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 and CreateUserPool .

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cognito.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 Object userPoolTags;
 CfnUserPoolPropsMixin cfnUserPoolPropsMixin = CfnUserPoolPropsMixin.Builder.create(CfnUserPoolMixinProps.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")
                 .inboundFederation(InboundFederationProperty.builder()
                         .lambdaArn("lambdaArn")
                         .lambdaVersion("lambdaVersion")
                         .build())
                 .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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnUserPoolPropsMixin.AccountRecoverySettingProperty	The available verified method a user can use to recover their password when they call ForgotPassword .
static interface	CfnUserPoolPropsMixin.AdminCreateUserConfigProperty	The settings for administrator creation of users in a user pool.
static interface	CfnUserPoolPropsMixin.AdvancedSecurityAdditionalFlowsProperty	Threat protection configuration options for additional authentication types in your user pool, including custom authentication.
static final class	CfnUserPoolPropsMixin.Builder	A fluent builder for CfnUserPoolPropsMixin.
static interface	CfnUserPoolPropsMixin.CustomEmailSenderProperty	The configuration of a custom email sender Lambda trigger.
static interface	CfnUserPoolPropsMixin.CustomSMSSenderProperty	The configuration of a custom SMS sender Lambda trigger.
static interface	CfnUserPoolPropsMixin.DeviceConfigurationProperty	The device-remembering configuration for a user pool.
static interface	CfnUserPoolPropsMixin.EmailConfigurationProperty	The email configuration of your user pool.
static interface	CfnUserPoolPropsMixin.InboundFederationProperty	Example:
static interface	CfnUserPoolPropsMixin.InviteMessageTemplateProperty	The template for the welcome message to new users.
static interface	CfnUserPoolPropsMixin.LambdaConfigProperty	A collection of user pool Lambda triggers.
static interface	CfnUserPoolPropsMixin.NumberAttributeConstraintsProperty	The minimum and maximum values of an attribute that is of the number type, for example custom:age .
static interface	CfnUserPoolPropsMixin.PasswordPolicyProperty	The password policy settings for a user pool, including complexity, history, and length requirements.
static interface	CfnUserPoolPropsMixin.PoliciesProperty	A list of user pool policies.
static interface	CfnUserPoolPropsMixin.PreTokenGenerationConfigProperty	The properties of a pre token generation Lambda trigger.
static interface	CfnUserPoolPropsMixin.RecoveryOptionProperty	A recovery option for a user.
static interface	CfnUserPoolPropsMixin.SchemaAttributeProperty	A list of the user attributes and their properties in your user pool.
static interface	CfnUserPoolPropsMixin.SignInPolicyProperty	The policy for allowed types of authentication in a user pool.
static interface	CfnUserPoolPropsMixin.SmsConfigurationProperty	User pool configuration for delivery of SMS messages with Amazon Simple Notification Service.
static interface	CfnUserPoolPropsMixin.StringAttributeConstraintsProperty	The minimum and maximum length values of an attribute that is of the string type, for example custom:department .
static interface	CfnUserPoolPropsMixin.UserAttributeUpdateSettingsProperty	The settings for updates to user attributes.
static interface	CfnUserPoolPropsMixin.UsernameConfigurationProperty	Case sensitivity of the username input for the selected sign-in option.
static interface	CfnUserPoolPropsMixin.UserPoolAddOnsProperty	User pool add-ons.
static interface	CfnUserPoolPropsMixin.VerificationMessageTemplateProperty	The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnUserPoolPropsMixin(CfnUserPoolMixinProps props)	Create a mixin to apply properties to AWS::Cognito::UserPool.
	CfnUserPoolPropsMixin(CfnUserPoolMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Cognito::UserPool.
protected	CfnUserPoolPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserPoolPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnUserPoolMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnUserPoolPropsMixin

protected CfnUserPoolPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnUserPoolPropsMixin

protected CfnUserPoolPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnUserPoolPropsMixin

@Stability(Stable)
public CfnUserPoolPropsMixin(@NotNull
 CfnUserPoolMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Cognito::UserPool.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnUserPoolPropsMixin

@Stability(Stable)
public CfnUserPoolPropsMixin(@NotNull
 CfnUserPoolMixinProps props)

Create a mixin to apply properties to AWS::Cognito::UserPool.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnUserPoolMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()