Package software.amazon.awscdk.services.cognito

Class CfnUserPool

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.cognito.CfnUserPool

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:06.311Z")
@Stability(Stable)
public class CfnUserPool
extends CfnResource
implements IInspectable, ITaggable

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.services.cognito.*;
 Object userPoolTags;
 CfnUserPool cfnUserPool = CfnUserPool.Builder.create(this, "MyCfnUserPool")
         .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())
                 .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)
         .verificationMessageTemplate(VerificationMessageTemplateProperty.builder()
                 .defaultEmailOption("defaultEmailOption")
                 .emailMessage("emailMessage")
                 .emailMessageByLink("emailMessageByLink")
                 .emailSubject("emailSubject")
                 .emailSubjectByLink("emailSubjectByLink")
                 .smsMessage("smsMessage")
                 .build())
         .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	CfnUserPool.AccountRecoverySettingProperty	The available verified method a user can use to recover their password when they call ForgotPassword .
static interface	CfnUserPool.AdminCreateUserConfigProperty	The settings for administrator creation of users in a user pool.
static interface	CfnUserPool.AdvancedSecurityAdditionalFlowsProperty	Example:
static final class	CfnUserPool.Builder	A fluent builder for CfnUserPool.
static interface	CfnUserPool.CustomEmailSenderProperty	The configuration of a custom email sender Lambda trigger.
static interface	CfnUserPool.CustomSMSSenderProperty	The configuration of a custom SMS sender Lambda trigger.
static interface	CfnUserPool.DeviceConfigurationProperty	The device-remembering configuration for a user pool.
static interface	CfnUserPool.EmailConfigurationProperty	The email configuration of your user pool.
static interface	CfnUserPool.InviteMessageTemplateProperty	The template for the welcome message to new users.
static interface	CfnUserPool.LambdaConfigProperty	A collection of user pool Lambda triggers.
static interface	CfnUserPool.NumberAttributeConstraintsProperty	The minimum and maximum values of an attribute that is of the number type, for example custom:age .
static interface	CfnUserPool.PasswordPolicyProperty	The password policy settings for a user pool, including complexity, history, and length requirements.
static interface	CfnUserPool.PoliciesProperty	A list of user pool policies.
static interface	CfnUserPool.PreTokenGenerationConfigProperty	The properties of a pre token generation Lambda trigger.
static interface	CfnUserPool.RecoveryOptionProperty	A recovery option for a user.
static interface	CfnUserPool.SchemaAttributeProperty	A list of the user attributes and their properties in your user pool.
static interface	CfnUserPool.SmsConfigurationProperty	User pool configuration for delivery of SMS messages with Amazon Simple Notification Service.
static interface	CfnUserPool.StringAttributeConstraintsProperty	The minimum and maximum length values of an attribute that is of the string type, for example custom:department .
static interface	CfnUserPool.UserAttributeUpdateSettingsProperty	The settings for updates to user attributes.
static interface	CfnUserPool.UsernameConfigurationProperty	Case sensitivity of the username input for the selected sign-in option.
static interface	CfnUserPool.UserPoolAddOnsProperty	User pool add-ons.
static interface	CfnUserPool.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.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnUserPool(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserPool(software.amazon.jsii.JsiiObjectRef objRef)
	CfnUserPool(software.constructs.Construct scope, String id)
	CfnUserPool(software.constructs.Construct scope, String id, CfnUserPoolProps props)

Method Summary

Modifier and Type	Method	Description
Object	getAccountRecoverySetting()	The available verified method a user can use to recover their password when they call ForgotPassword .
Object	getAdminCreateUserConfig()	The settings for administrator creation of users in a user pool.
List<String>	getAliasAttributes()	Attributes supported as an alias for this user pool.
String	getAttrArn()	The Amazon Resource Name (ARN) of the user pool, such as arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341 .
String	getAttrProviderName()	A friendly name for the IdP.
String	getAttrProviderUrl()	The URL of the provider of the Amazon Cognito user pool, specified as a String .
String	getAttrUserPoolId()	The ID of the user pool.
List<String>	getAutoVerifiedAttributes()	The attributes to be auto-verified.
protected Map<String,Object>	getCfnProperties()
String	getDeletionProtection()	When active, DeletionProtection prevents accidental deletion of your user pool.
Object	getDeviceConfiguration()	The device-remembering configuration for a user pool.
String	getEmailAuthenticationMessage()
String	getEmailAuthenticationSubject()
Object	getEmailConfiguration()	The email configuration of your user pool.
String	getEmailVerificationMessage()	This parameter is no longer used.
String	getEmailVerificationSubject()	This parameter is no longer used.
List<String>	getEnabledMfas()	Set enabled MFA options on a specified user pool.
Object	getLambdaConfig()	A collection of user pool Lambda triggers.
String	getMfaConfiguration()	The multi-factor authentication (MFA) configuration.
Object	getPolicies()	A list of user pool policies.
Object	getSchema()	An array of schema attributes for the new user pool.
String	getSmsAuthenticationMessage()	The contents of the SMS authentication message.
Object	getSmsConfiguration()	The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service.
String	getSmsVerificationMessage()	This parameter is no longer used.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
Object	getUserAttributeUpdateSettings()	The settings for updates to user attributes.
List<String>	getUsernameAttributes()	Specifies whether a user can use an email address or phone number as a username when they sign up.
Object	getUsernameConfiguration()	Case sensitivity on the username input for the selected sign-in option.
Object	getUserPoolAddOns()	User pool add-ons.
String	getUserPoolName()	A string used to name the user pool.
Object	getUserPoolTagsRaw()	The tag keys and values to assign to the user pool.
Object	getVerificationMessageTemplate()	The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccountRecoverySetting(IResolvable value)	The available verified method a user can use to recover their password when they call ForgotPassword .
void	setAccountRecoverySetting(CfnUserPool.AccountRecoverySettingProperty value)	The available verified method a user can use to recover their password when they call ForgotPassword .
void	setAdminCreateUserConfig(IResolvable value)	The settings for administrator creation of users in a user pool.
void	setAdminCreateUserConfig(CfnUserPool.AdminCreateUserConfigProperty value)	The settings for administrator creation of users in a user pool.
void	setAliasAttributes(List<String> value)	Attributes supported as an alias for this user pool.
void	setAutoVerifiedAttributes(List<String> value)	The attributes to be auto-verified.
void	setDeletionProtection(String value)	When active, DeletionProtection prevents accidental deletion of your user pool.
void	setDeviceConfiguration(IResolvable value)	The device-remembering configuration for a user pool.
void	setDeviceConfiguration(CfnUserPool.DeviceConfigurationProperty value)	The device-remembering configuration for a user pool.
void	setEmailAuthenticationMessage(String value)
void	setEmailAuthenticationSubject(String value)
void	setEmailConfiguration(IResolvable value)	The email configuration of your user pool.
void	setEmailConfiguration(CfnUserPool.EmailConfigurationProperty value)	The email configuration of your user pool.
void	setEmailVerificationMessage(String value)	This parameter is no longer used.
void	setEmailVerificationSubject(String value)	This parameter is no longer used.
void	setEnabledMfas(List<String> value)	Set enabled MFA options on a specified user pool.
void	setLambdaConfig(IResolvable value)	A collection of user pool Lambda triggers.
void	setLambdaConfig(CfnUserPool.LambdaConfigProperty value)	A collection of user pool Lambda triggers.
void	setMfaConfiguration(String value)	The multi-factor authentication (MFA) configuration.
void	setPolicies(IResolvable value)	A list of user pool policies.
void	setPolicies(CfnUserPool.PoliciesProperty value)	A list of user pool policies.
void	setSchema(List<Object> value)	An array of schema attributes for the new user pool.
void	setSchema(IResolvable value)	An array of schema attributes for the new user pool.
void	setSmsAuthenticationMessage(String value)	The contents of the SMS authentication message.
void	setSmsConfiguration(IResolvable value)	The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service.
void	setSmsConfiguration(CfnUserPool.SmsConfigurationProperty value)	The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service.
void	setSmsVerificationMessage(String value)	This parameter is no longer used.
void	setUserAttributeUpdateSettings(IResolvable value)	The settings for updates to user attributes.
void	setUserAttributeUpdateSettings(CfnUserPool.UserAttributeUpdateSettingsProperty value)	The settings for updates to user attributes.
void	setUsernameAttributes(List<String> value)	Specifies whether a user can use an email address or phone number as a username when they sign up.
void	setUsernameConfiguration(IResolvable value)	Case sensitivity on the username input for the selected sign-in option.
void	setUsernameConfiguration(CfnUserPool.UsernameConfigurationProperty value)	Case sensitivity on the username input for the selected sign-in option.
void	setUserPoolAddOns(IResolvable value)	User pool add-ons.
void	setUserPoolAddOns(CfnUserPool.UserPoolAddOnsProperty value)	User pool add-ons.
void	setUserPoolName(String value)	A string used to name the user pool.
void	setUserPoolTagsRaw(Object value)	The tag keys and values to assign to the user pool.
void	setVerificationMessageTemplate(IResolvable value)	The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
void	setVerificationMessageTemplate(CfnUserPool.VerificationMessageTemplateProperty value)	The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnUserPool

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

CfnUserPool

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

CfnUserPool

@Stability(Stable)
public CfnUserPool(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnUserPoolProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnUserPool

@Stability(Stable)
public CfnUserPool(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

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

getAttrProviderName

@Stability(Stable)
@NotNull
public String getAttrProviderName()

A friendly name for the IdP.

getAttrProviderUrl

@Stability(Stable)
@NotNull
public String getAttrProviderUrl()

The URL of the provider of the Amazon Cognito user pool, specified as a String .

getAttrUserPoolId

@Stability(Stable)
@NotNull
public String getAttrUserPoolId()

The ID of the user pool.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getAccountRecoverySetting

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

The available verified method a user can use to recover their password when they call ForgotPassword .

setAccountRecoverySetting

@Stability(Stable)
public void setAccountRecoverySetting(@Nullable
 IResolvable value)

The available verified method a user can use to recover their password when they call ForgotPassword .

setAccountRecoverySetting

@Stability(Stable)
public void setAccountRecoverySetting(@Nullable
 CfnUserPool.AccountRecoverySettingProperty value)

The available verified method a user can use to recover their password when they call ForgotPassword .

getAdminCreateUserConfig

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

The settings for administrator creation of users in a user pool.

setAdminCreateUserConfig

@Stability(Stable)
public void setAdminCreateUserConfig(@Nullable
 IResolvable value)

The settings for administrator creation of users in a user pool.

setAdminCreateUserConfig

@Stability(Stable)
public void setAdminCreateUserConfig(@Nullable
 CfnUserPool.AdminCreateUserConfigProperty value)

The settings for administrator creation of users in a user pool.

getAliasAttributes

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

Attributes supported as an alias for this user pool.

setAliasAttributes

@Stability(Stable)
public void setAliasAttributes(@Nullable
 List<String> value)

Attributes supported as an alias for this user pool.

getAutoVerifiedAttributes

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

The attributes to be auto-verified.

setAutoVerifiedAttributes

@Stability(Stable)
public void setAutoVerifiedAttributes(@Nullable
 List<String> value)

The attributes to be auto-verified.

getDeletionProtection

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

When active, DeletionProtection prevents accidental deletion of your user pool.

setDeletionProtection

@Stability(Stable)
public void setDeletionProtection(@Nullable
 String value)

When active, DeletionProtection prevents accidental deletion of your user pool.

getDeviceConfiguration

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

The device-remembering configuration for a user pool.

setDeviceConfiguration

@Stability(Stable)
public void setDeviceConfiguration(@Nullable
 IResolvable value)

The device-remembering configuration for a user pool.

setDeviceConfiguration

@Stability(Stable)
public void setDeviceConfiguration(@Nullable
 CfnUserPool.DeviceConfigurationProperty value)

The device-remembering configuration for a user pool.

getEmailAuthenticationMessage

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

setEmailAuthenticationMessage

@Stability(Stable)
public void setEmailAuthenticationMessage(@Nullable
 String value)

getEmailAuthenticationSubject

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

setEmailAuthenticationSubject

@Stability(Stable)
public void setEmailAuthenticationSubject(@Nullable
 String value)

getEmailConfiguration

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

The email configuration of your user pool.

setEmailConfiguration

@Stability(Stable)
public void setEmailConfiguration(@Nullable
 IResolvable value)

The email configuration of your user pool.

setEmailConfiguration

@Stability(Stable)
public void setEmailConfiguration(@Nullable
 CfnUserPool.EmailConfigurationProperty value)

The email configuration of your user pool.

getEmailVerificationMessage

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

This parameter is no longer used.

setEmailVerificationMessage

@Stability(Stable)
public void setEmailVerificationMessage(@Nullable
 String value)

This parameter is no longer used.

getEmailVerificationSubject

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

This parameter is no longer used.

setEmailVerificationSubject

@Stability(Stable)
public void setEmailVerificationSubject(@Nullable
 String value)

This parameter is no longer used.

getEnabledMfas

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

Set enabled MFA options on a specified user pool.

setEnabledMfas

@Stability(Stable)
public void setEnabledMfas(@Nullable
 List<String> value)

Set enabled MFA options on a specified user pool.

getLambdaConfig

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

A collection of user pool Lambda triggers.

setLambdaConfig

@Stability(Stable)
public void setLambdaConfig(@Nullable
 IResolvable value)

A collection of user pool Lambda triggers.

setLambdaConfig

@Stability(Stable)
public void setLambdaConfig(@Nullable
 CfnUserPool.LambdaConfigProperty value)

A collection of user pool Lambda triggers.

getMfaConfiguration

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

The multi-factor authentication (MFA) configuration.

Valid values include:.

setMfaConfiguration

@Stability(Stable)
public void setMfaConfiguration(@Nullable
 String value)

The multi-factor authentication (MFA) configuration.

Valid values include:.

getPolicies

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

A list of user pool policies.

Contains the policy that sets password-complexity requirements.

setPolicies

@Stability(Stable)
public void setPolicies(@Nullable
 IResolvable value)

A list of user pool policies.

Contains the policy that sets password-complexity requirements.

setPolicies

@Stability(Stable)
public void setPolicies(@Nullable
 CfnUserPool.PoliciesProperty value)

A list of user pool policies.

Contains the policy that sets password-complexity requirements.

getSchema

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

An array of schema attributes for the new user pool.

setSchema

@Stability(Stable)
public void setSchema(@Nullable
 IResolvable value)

An array of schema attributes for the new user pool.

setSchema

@Stability(Stable)
public void setSchema(@Nullable
 List<Object> value)

An array of schema attributes for the new user pool.

getSmsAuthenticationMessage

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

The contents of the SMS authentication message.

setSmsAuthenticationMessage

@Stability(Stable)
public void setSmsAuthenticationMessage(@Nullable
 String value)

The contents of the SMS authentication message.

getSmsConfiguration

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

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service.

setSmsConfiguration

@Stability(Stable)
public void setSmsConfiguration(@Nullable
 IResolvable value)

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service.

setSmsConfiguration

@Stability(Stable)
public void setSmsConfiguration(@Nullable
 CfnUserPool.SmsConfigurationProperty value)

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service.

getSmsVerificationMessage

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

This parameter is no longer used.

setSmsVerificationMessage

@Stability(Stable)
public void setSmsVerificationMessage(@Nullable
 String value)

This parameter is no longer used.

getUserAttributeUpdateSettings

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

The settings for updates to user attributes.

setUserAttributeUpdateSettings

@Stability(Stable)
public void setUserAttributeUpdateSettings(@Nullable
 IResolvable value)

The settings for updates to user attributes.

setUserAttributeUpdateSettings

@Stability(Stable)
public void setUserAttributeUpdateSettings(@Nullable
 CfnUserPool.UserAttributeUpdateSettingsProperty value)

The settings for updates to user attributes.

getUsernameAttributes

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

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

setUsernameAttributes

@Stability(Stable)
public void setUsernameAttributes(@Nullable
 List<String> value)

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

getUsernameConfiguration

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

Case sensitivity on the username input for the selected sign-in option.

setUsernameConfiguration

@Stability(Stable)
public void setUsernameConfiguration(@Nullable
 IResolvable value)

Case sensitivity on the username input for the selected sign-in option.

setUsernameConfiguration

@Stability(Stable)
public void setUsernameConfiguration(@Nullable
 CfnUserPool.UsernameConfigurationProperty value)

Case sensitivity on the username input for the selected sign-in option.

getUserPoolAddOns

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

User pool add-ons.

setUserPoolAddOns

@Stability(Stable)
public void setUserPoolAddOns(@Nullable
 IResolvable value)

User pool add-ons.

setUserPoolAddOns

@Stability(Stable)
public void setUserPoolAddOns(@Nullable
 CfnUserPool.UserPoolAddOnsProperty value)

User pool add-ons.

getUserPoolName

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

A string used to name the user pool.

setUserPoolName

@Stability(Stable)
public void setUserPoolName(@Nullable
 String value)

A string used to name the user pool.

getUserPoolTagsRaw

@Stability(Stable)
@Nullable
public Object getUserPoolTagsRaw()

The tag keys and values to assign to the user pool.

setUserPoolTagsRaw

@Stability(Stable)
public void setUserPoolTagsRaw(@Nullable
 Object value)

The tag keys and values to assign to the user pool.

getVerificationMessageTemplate

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

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

setVerificationMessageTemplate

@Stability(Stable)
public void setVerificationMessageTemplate(@Nullable
 IResolvable value)

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

setVerificationMessageTemplate

@Stability(Stable)
public void setVerificationMessageTemplate(@Nullable
 CfnUserPool.VerificationMessageTemplateProperty value)

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.