Class CfnUserPool.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUserPool>
- Enclosing class:
CfnUserPool
CfnUserPool
.-
Method Summary
Modifier and TypeMethodDescriptionaccountRecoverySetting
(IResolvable accountRecoverySetting) Use this setting to define which verified available method a user can use to recover their password when they callForgotPassword
.accountRecoverySetting
(CfnUserPool.AccountRecoverySettingProperty accountRecoverySetting) Use this setting to define which verified available method a user can use to recover their password when they callForgotPassword
.adminCreateUserConfig
(IResolvable adminCreateUserConfig) The settings for administrator creation of users in a user pool.adminCreateUserConfig
(CfnUserPool.AdminCreateUserConfigProperty adminCreateUserConfig) The settings for administrator creation of users in a user pool.aliasAttributes
(List<String> aliasAttributes) Attributes supported as an alias for this user pool.autoVerifiedAttributes
(List<String> autoVerifiedAttributes) The attributes to be auto-verified.build()
static CfnUserPool.Builder
deletionProtection
(String deletionProtection) When active,DeletionProtection
prevents accidental deletion of your user pool.deviceConfiguration
(IResolvable deviceConfiguration) The device-remembering configuration for a user pool.deviceConfiguration
(CfnUserPool.DeviceConfigurationProperty deviceConfiguration) The device-remembering configuration for a user pool.emailAuthenticationMessage
(String emailAuthenticationMessage) emailAuthenticationSubject
(String emailAuthenticationSubject) emailConfiguration
(IResolvable emailConfiguration) The email configuration of your user pool.emailConfiguration
(CfnUserPool.EmailConfigurationProperty emailConfiguration) The email configuration of your user pool.emailVerificationMessage
(String emailVerificationMessage) This parameter is no longer used.emailVerificationSubject
(String emailVerificationSubject) This parameter is no longer used.enabledMfas
(List<String> enabledMfas) Enables MFA on a specified user pool.lambdaConfig
(IResolvable lambdaConfig) A collection of user pool Lambda triggers.lambdaConfig
(CfnUserPool.LambdaConfigProperty lambdaConfig) A collection of user pool Lambda triggers.mfaConfiguration
(String mfaConfiguration) The multi-factor authentication (MFA) configuration.policies
(IResolvable policies) A list of user pool policies.policies
(CfnUserPool.PoliciesProperty policies) A list of user pool policies.The schema attributes for the new user pool.schema
(IResolvable schema) The schema attributes for the new user pool.smsAuthenticationMessage
(String smsAuthenticationMessage) A string representing the SMS authentication message.smsConfiguration
(IResolvable smsConfiguration) 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.smsConfiguration
(CfnUserPool.SmsConfigurationProperty smsConfiguration) 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.smsVerificationMessage
(String smsVerificationMessage) This parameter is no longer used.userAttributeUpdateSettings
(IResolvable userAttributeUpdateSettings) The settings for updates to user attributes.userAttributeUpdateSettings
(CfnUserPool.UserAttributeUpdateSettingsProperty userAttributeUpdateSettings) The settings for updates to user attributes.usernameAttributes
(List<String> usernameAttributes) Determines whether email addresses or phone numbers can be specified as user names when a user signs up.usernameConfiguration
(IResolvable usernameConfiguration) You can choose to set case sensitivity on the username input for the selected sign-in option.usernameConfiguration
(CfnUserPool.UsernameConfigurationProperty usernameConfiguration) You can choose to set case sensitivity on the username input for the selected sign-in option.userPoolAddOns
(IResolvable userPoolAddOns) User pool add-ons.userPoolAddOns
(CfnUserPool.UserPoolAddOnsProperty userPoolAddOns) User pool add-ons.userPoolName
(String userPoolName) A string used to name the user pool.userPoolTags
(Object userPoolTags) The tag keys and values to assign to the user pool.verificationMessageTemplate
(IResolvable verificationMessageTemplate) The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.verificationMessageTemplate
(CfnUserPool.VerificationMessageTemplateProperty verificationMessageTemplate) The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
-
Method Details
-
create
@Stability(Stable) public static CfnUserPool.Builder create(software.constructs.Construct scope, 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.- Returns:
- a new instance of
CfnUserPool.Builder
.
-
accountRecoverySetting
@Stability(Stable) public CfnUserPool.Builder accountRecoverySetting(IResolvable accountRecoverySetting) Use this setting to define which verified available method a user can use to recover their password when they callForgotPassword
.It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
- Parameters:
accountRecoverySetting
- Use this setting to define which verified available method a user can use to recover their password when they callForgotPassword
. This parameter is required.- Returns:
this
- See Also:
-
accountRecoverySetting
@Stability(Stable) public CfnUserPool.Builder accountRecoverySetting(CfnUserPool.AccountRecoverySettingProperty accountRecoverySetting) Use this setting to define which verified available method a user can use to recover their password when they callForgotPassword
.It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
- Parameters:
accountRecoverySetting
- Use this setting to define which verified available method a user can use to recover their password when they callForgotPassword
. This parameter is required.- Returns:
this
- See Also:
-
adminCreateUserConfig
@Stability(Stable) public CfnUserPool.Builder adminCreateUserConfig(IResolvable adminCreateUserConfig) 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 CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .
- Parameters:
adminCreateUserConfig
- The settings for administrator creation of users in a user pool. This parameter is required.- Returns:
this
- See Also:
-
adminCreateUserConfig
@Stability(Stable) public CfnUserPool.Builder adminCreateUserConfig(CfnUserPool.AdminCreateUserConfigProperty adminCreateUserConfig) 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 CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .
- Parameters:
adminCreateUserConfig
- The settings for administrator creation of users in a user pool. This parameter is required.- Returns:
this
- See Also:
-
aliasAttributes
Attributes supported as an alias for this user pool. Possible values: phone_number , email , or preferred_username .This user pool property cannot be updated.
- Parameters:
aliasAttributes
- Attributes supported as an alias for this user pool. Possible values: phone_number , email , or preferred_username . This parameter is required.- Returns:
this
- See Also:
-
autoVerifiedAttributes
@Stability(Stable) public CfnUserPool.Builder autoVerifiedAttributes(List<String> autoVerifiedAttributes) The attributes to be auto-verified.Possible values: email , phone_number .
- Parameters:
autoVerifiedAttributes
- The attributes to be auto-verified. This parameter is required.- Returns:
this
- See Also:
-
deletionProtection
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 anInvalidParameterException
error. To delete a protected user pool, send a newDeleteUserPool
request after you deactivate deletion protection in anUpdateUserPool
API request.- Parameters:
deletionProtection
- When active,DeletionProtection
prevents accidental deletion of your user pool. This parameter is required.- Returns:
this
- See Also:
-
deviceConfiguration
The device-remembering configuration for a 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.- Parameters:
deviceConfiguration
- The device-remembering configuration for a user pool. This parameter is required.- Returns:
this
- See Also:
-
deviceConfiguration
@Stability(Stable) public CfnUserPool.Builder deviceConfiguration(CfnUserPool.DeviceConfigurationProperty deviceConfiguration) The device-remembering configuration for a 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.- Parameters:
deviceConfiguration
- The device-remembering configuration for a user pool. This parameter is required.- Returns:
this
- See Also:
-
emailAuthenticationMessage
@Stability(Stable) public CfnUserPool.Builder emailAuthenticationMessage(String emailAuthenticationMessage) - Parameters:
emailAuthenticationMessage
- This parameter is required.- Returns:
this
- See Also:
-
emailAuthenticationSubject
@Stability(Stable) public CfnUserPool.Builder emailAuthenticationSubject(String emailAuthenticationSubject) - Parameters:
emailAuthenticationSubject
- This parameter is required.- Returns:
this
- See Also:
-
emailConfiguration
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.
- Parameters:
emailConfiguration
- The email configuration of your user pool. This parameter is required.- Returns:
this
- See Also:
-
emailConfiguration
@Stability(Stable) public CfnUserPool.Builder emailConfiguration(CfnUserPool.EmailConfigurationProperty emailConfiguration) 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.
- Parameters:
emailConfiguration
- The email configuration of your user pool. This parameter is required.- Returns:
this
- See Also:
-
emailVerificationMessage
@Stability(Stable) public CfnUserPool.Builder emailVerificationMessage(String emailVerificationMessage) This parameter is no longer used.- Parameters:
emailVerificationMessage
- This parameter is no longer used. This parameter is required.- Returns:
this
- See Also:
-
emailVerificationSubject
@Stability(Stable) public CfnUserPool.Builder emailVerificationSubject(String emailVerificationSubject) This parameter is no longer used.- Parameters:
emailVerificationSubject
- This parameter is no longer used. This parameter is required.- Returns:
this
- See Also:
-
enabledMfas
Enables MFA 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. Once SMS_MFA is enabled, SMS_MFA can only be disabled by setting MfaConfiguration to “OFF”. Can be one of the following values:
SMS_MFA
- Enables SMS MFA for the user pool. SMS_MFA can only be enabled if SMS configuration is provided.SOFTWARE_TOKEN_MFA
- Enables software token MFA for the user pool.
Allowed values:
SMS_MFA
|SOFTWARE_TOKEN_MFA
- Parameters:
enabledMfas
- Enables MFA on a specified user pool. This parameter is required.- Returns:
this
- See Also:
-
lambdaConfig
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.
- Parameters:
lambdaConfig
- A collection of user pool Lambda triggers. This parameter is required.- Returns:
this
- See Also:
-
lambdaConfig
@Stability(Stable) public CfnUserPool.Builder lambdaConfig(CfnUserPool.LambdaConfigProperty lambdaConfig) 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.
- Parameters:
lambdaConfig
- A collection of user pool Lambda triggers. This parameter is required.- Returns:
this
- See Also:
-
mfaConfiguration
The multi-factor authentication (MFA) configuration. Valid values include:.OFF
MFA won't be used for any users.ON
MFA is required for all users to sign in.OPTIONAL
MFA will be required only for individual users who have an MFA factor activated.
- Parameters:
mfaConfiguration
- The multi-factor authentication (MFA) configuration. Valid values include:. This parameter is required.- Returns:
this
- See Also:
-
policies
A list of user pool policies. Contains the policy that sets password-complexity requirements.This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .
- Parameters:
policies
- A list of user pool policies. Contains the policy that sets password-complexity requirements. This parameter is required.- Returns:
this
- See Also:
-
policies
A list of user pool policies. Contains the policy that sets password-complexity requirements.This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .
- Parameters:
policies
- A list of user pool policies. Contains the policy that sets password-complexity requirements. This parameter is required.- Returns:
this
- See Also:
-
schema
The schema attributes for the new user pool. These attributes can be standard or custom attributes.During a user pool update, you can add new schema attributes but you cannot modify or delete an existing schema attribute.
- Parameters:
schema
- The schema attributes for the new user pool. These attributes can be standard or custom attributes. This parameter is required.- Returns:
this
- See Also:
-
schema
The schema attributes for the new user pool. These attributes can be standard or custom attributes.During a user pool update, you can add new schema attributes but you cannot modify or delete an existing schema attribute.
- Parameters:
schema
- The schema attributes for the new user pool. These attributes can be standard or custom attributes. This parameter is required.- Returns:
this
- See Also:
-
smsAuthenticationMessage
@Stability(Stable) public CfnUserPool.Builder smsAuthenticationMessage(String smsAuthenticationMessage) A string representing the SMS authentication message.- Parameters:
smsAuthenticationMessage
- A string representing the SMS authentication message. This parameter is required.- Returns:
this
- See Also:
-
smsConfiguration
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.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 .
- Parameters:
smsConfiguration
- 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. This parameter is required.- Returns:
this
- See Also:
-
smsConfiguration
@Stability(Stable) public CfnUserPool.Builder smsConfiguration(CfnUserPool.SmsConfigurationProperty smsConfiguration) 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.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 .
- Parameters:
smsConfiguration
- 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. This parameter is required.- Returns:
this
- See Also:
-
smsVerificationMessage
This parameter is no longer used.- Parameters:
smsVerificationMessage
- This parameter is no longer used. This parameter is required.- Returns:
this
- See Also:
-
userAttributeUpdateSettings
@Stability(Stable) public CfnUserPool.Builder userAttributeUpdateSettings(IResolvable userAttributeUpdateSettings) 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 .- Parameters:
userAttributeUpdateSettings
- The settings for updates to user attributes. This parameter is required.- Returns:
this
- See Also:
-
userAttributeUpdateSettings
@Stability(Stable) public CfnUserPool.Builder userAttributeUpdateSettings(CfnUserPool.UserAttributeUpdateSettingsProperty userAttributeUpdateSettings) 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 .- Parameters:
userAttributeUpdateSettings
- The settings for updates to user attributes. This parameter is required.- Returns:
this
- See Also:
-
usernameAttributes
Determines whether email addresses or phone numbers can be specified as user names when a user signs up.Possible values:
phone_number
oremail
.This user pool property cannot be updated.
- Parameters:
usernameAttributes
- Determines whether email addresses or phone numbers can be specified as user names when a user signs up. This parameter is required.- Returns:
this
- See Also:
-
usernameConfiguration
@Stability(Stable) public CfnUserPool.Builder usernameConfiguration(IResolvable usernameConfiguration) You can choose to set case sensitivity on the username input for the selected sign-in option.For example, when this is set to
False
, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set.- Parameters:
usernameConfiguration
- You can choose to set case sensitivity on the username input for the selected sign-in option. This parameter is required.- Returns:
this
- See Also:
-
usernameConfiguration
@Stability(Stable) public CfnUserPool.Builder usernameConfiguration(CfnUserPool.UsernameConfigurationProperty usernameConfiguration) You can choose to set case sensitivity on the username input for the selected sign-in option.For example, when this is set to
False
, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set.- Parameters:
usernameConfiguration
- You can choose to set case sensitivity on the username input for the selected sign-in option. This parameter is required.- Returns:
this
- See Also:
-
userPoolAddOns
User pool add-ons.Contains settings for activation of advanced security features. To log user security information but take no action, set to
AUDIT
. To configure automatic security responses to risky traffic to your user pool, set toENFORCED
.For more information, see Adding advanced security to a user pool .
- Parameters:
userPoolAddOns
- User pool add-ons. This parameter is required.- Returns:
this
- See Also:
-
userPoolAddOns
@Stability(Stable) public CfnUserPool.Builder userPoolAddOns(CfnUserPool.UserPoolAddOnsProperty userPoolAddOns) User pool add-ons.Contains settings for activation of advanced security features. To log user security information but take no action, set to
AUDIT
. To configure automatic security responses to risky traffic to your user pool, set toENFORCED
.For more information, see Adding advanced security to a user pool .
- Parameters:
userPoolAddOns
- User pool add-ons. This parameter is required.- Returns:
this
- See Also:
-
userPoolName
A string used to name the user pool.- Parameters:
userPoolName
- A string used to name the user pool. This parameter is required.- Returns:
this
- See Also:
-
userPoolTags
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.
- Parameters:
userPoolTags
- The tag keys and values to assign to the user pool. This parameter is required.- Returns:
this
- See Also:
-
verificationMessageTemplate
@Stability(Stable) public CfnUserPool.Builder verificationMessageTemplate(IResolvable verificationMessageTemplate) 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. ForCONFIRM_WITH_LINK
, specify anEmailMessageByLink
and leaveEmailMessage
blank. ForCONFIRM_WITH_CODE
, specify anEmailMessage
and leaveEmailMessageByLink
blank. When you supply both parameters with either choice, Amazon Cognito returns an error.- Parameters:
verificationMessageTemplate
- The template for the verification message that your user pool delivers to users who set an email address or phone number attribute. This parameter is required.- Returns:
this
- See Also:
-
verificationMessageTemplate
@Stability(Stable) public CfnUserPool.Builder verificationMessageTemplate(CfnUserPool.VerificationMessageTemplateProperty verificationMessageTemplate) 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. ForCONFIRM_WITH_LINK
, specify anEmailMessageByLink
and leaveEmailMessage
blank. ForCONFIRM_WITH_CODE
, specify anEmailMessage
and leaveEmailMessageByLink
blank. When you supply both parameters with either choice, Amazon Cognito returns an error.- Parameters:
verificationMessageTemplate
- The template for the verification message that your user pool delivers to users who set an email address or phone number attribute. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnUserPool>
- Returns:
- a newly built instance of
CfnUserPool
.
-