Package software.amazon.awscdk.services.cognito

Class CfnUserPoolProps.Builder

java.lang.Object
software.amazon.awscdk.services.cognito.CfnUserPoolProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUserPoolProps>
Enclosing interface:
CfnUserPoolProps
@Stability(Stable) public static final class CfnUserPoolProps.Builder extends Object implements software.amazon.jsii.Builder<CfnUserPoolProps>
A builder for CfnUserPoolProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • accountRecoverySetting

      @Stability(Stable) public CfnUserPoolProps.Builder accountRecoverySetting(IResolvable accountRecoverySetting)
      Sets the value of CfnUserPoolProps.getAccountRecoverySetting()
      Parameters:
      accountRecoverySetting - Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword . 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.
      Returns:
      this

    • accountRecoverySetting

      @Stability(Stable) public CfnUserPoolProps.Builder accountRecoverySetting(CfnUserPool.AccountRecoverySettingProperty accountRecoverySetting)
      Sets the value of CfnUserPoolProps.getAccountRecoverySetting()
      Parameters:
      accountRecoverySetting - Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword . 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.
      Returns:
      this

    • adminCreateUserConfig

      @Stability(Stable) public CfnUserPoolProps.Builder adminCreateUserConfig(IResolvable adminCreateUserConfig)
      Sets the value of CfnUserPoolProps.getAdminCreateUserConfig()
      Parameters:
      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 .

      Returns:
      this

    • adminCreateUserConfig

      @Stability(Stable) public CfnUserPoolProps.Builder adminCreateUserConfig(CfnUserPool.AdminCreateUserConfigProperty adminCreateUserConfig)
      Sets the value of CfnUserPoolProps.getAdminCreateUserConfig()
      Parameters:
      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 .

      Returns:
      this

    • aliasAttributes

      @Stability(Stable) public CfnUserPoolProps.Builder aliasAttributes(List<String> aliasAttributes)
      Sets the value of CfnUserPoolProps.getAliasAttributes()
      Parameters:
      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.

      Returns:
      this

    • autoVerifiedAttributes

      @Stability(Stable) public CfnUserPoolProps.Builder autoVerifiedAttributes(List<String> autoVerifiedAttributes)
      Sets the value of CfnUserPoolProps.getAutoVerifiedAttributes()
      Parameters:
      autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email , phone_number .
      Returns:
      this

    • deletionProtection

      @Stability(Stable) public CfnUserPoolProps.Builder deletionProtection(String deletionProtection)
      Sets the value of CfnUserPoolProps.getDeletionProtection()
      Parameters:
      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 an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

      Returns:
      this

    • deviceConfiguration

      @Stability(Stable) public CfnUserPoolProps.Builder deviceConfiguration(IResolvable deviceConfiguration)
      Sets the value of CfnUserPoolProps.getDeviceConfiguration()
      Parameters:
      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.

      Returns:
      this

    • deviceConfiguration

      @Stability(Stable) public CfnUserPoolProps.Builder deviceConfiguration(CfnUserPool.DeviceConfigurationProperty deviceConfiguration)
      Sets the value of CfnUserPoolProps.getDeviceConfiguration()
      Parameters:
      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.

      Returns:
      this

    • emailAuthenticationMessage

      @Stability(Stable) public CfnUserPoolProps.Builder emailAuthenticationMessage(String emailAuthenticationMessage)
      Sets the value of CfnUserPoolProps.getEmailAuthenticationMessage()
      Parameters:
      emailAuthenticationMessage - the value to be set.
      Returns:
      this

    • emailAuthenticationSubject

      @Stability(Stable) public CfnUserPoolProps.Builder emailAuthenticationSubject(String emailAuthenticationSubject)
      Sets the value of CfnUserPoolProps.getEmailAuthenticationSubject()
      Parameters:
      emailAuthenticationSubject - the value to be set.
      Returns:
      this

    • emailConfiguration

      @Stability(Stable) public CfnUserPoolProps.Builder emailConfiguration(IResolvable emailConfiguration)
      Sets the value of CfnUserPoolProps.getEmailConfiguration()
      Parameters:
      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.
      Returns:
      this

    • emailConfiguration

      @Stability(Stable) public CfnUserPoolProps.Builder emailConfiguration(CfnUserPool.EmailConfigurationProperty emailConfiguration)
      Sets the value of CfnUserPoolProps.getEmailConfiguration()
      Parameters:
      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.
      Returns:
      this

    • emailVerificationMessage

      @Stability(Stable) public CfnUserPoolProps.Builder emailVerificationMessage(String emailVerificationMessage)
      Sets the value of CfnUserPoolProps.getEmailVerificationMessage()
      Parameters:
      emailVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType .
      Returns:
      this

    • emailVerificationSubject

      @Stability(Stable) public CfnUserPoolProps.Builder emailVerificationSubject(String emailVerificationSubject)
      Sets the value of CfnUserPoolProps.getEmailVerificationSubject()
      Parameters:
      emailVerificationSubject - This parameter is no longer used. See VerificationMessageTemplateType .
      Returns:
      this

    • enabledMfas

      @Stability(Stable) public CfnUserPoolProps.Builder enabledMfas(List<String> enabledMfas)
      Sets the value of CfnUserPoolProps.getEnabledMfas()
      Parameters:
      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

      Returns:
      this

    • lambdaConfig

      @Stability(Stable) public CfnUserPoolProps.Builder lambdaConfig(IResolvable lambdaConfig)
      Sets the value of CfnUserPoolProps.getLambdaConfig()
      Parameters:
      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.
      Returns:
      this

    • lambdaConfig

      @Stability(Stable) public CfnUserPoolProps.Builder lambdaConfig(CfnUserPool.LambdaConfigProperty lambdaConfig)
      Sets the value of CfnUserPoolProps.getLambdaConfig()
      Parameters:
      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.
      Returns:
      this

    • mfaConfiguration

      @Stability(Stable) public CfnUserPoolProps.Builder mfaConfiguration(String mfaConfiguration)
      Sets the value of CfnUserPoolProps.getMfaConfiguration()
      Parameters:
      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.
      Returns:
      this

    • policies

      @Stability(Stable) public CfnUserPoolProps.Builder policies(IResolvable policies)
      Sets the value of CfnUserPoolProps.getPolicies()
      Parameters:
      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 .
      Returns:
      this

    • policies

      @Stability(Stable) public CfnUserPoolProps.Builder policies(CfnUserPool.PoliciesProperty policies)
      Sets the value of CfnUserPoolProps.getPolicies()
      Parameters:
      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 .
      Returns:
      this

    • schema

      @Stability(Stable) public CfnUserPoolProps.Builder schema(IResolvable schema)
      Sets the value of CfnUserPoolProps.getSchema()
      Parameters:
      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.

      Returns:
      this

    • schema

      @Stability(Stable) public CfnUserPoolProps.Builder schema(List<? extends Object> schema)
      Sets the value of CfnUserPoolProps.getSchema()
      Parameters:
      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.

      Returns:
      this

    • smsAuthenticationMessage

      @Stability(Stable) public CfnUserPoolProps.Builder smsAuthenticationMessage(String smsAuthenticationMessage)
      Sets the value of CfnUserPoolProps.getSmsAuthenticationMessage()
      Parameters:
      smsAuthenticationMessage - A string representing the SMS authentication message.
      Returns:
      this

    • smsConfiguration

      @Stability(Stable) public CfnUserPoolProps.Builder smsConfiguration(IResolvable smsConfiguration)
      Sets the value of CfnUserPoolProps.getSmsConfiguration()
      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. 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 .
      Returns:
      this

    • smsConfiguration

      @Stability(Stable) public CfnUserPoolProps.Builder smsConfiguration(CfnUserPool.SmsConfigurationProperty smsConfiguration)
      Sets the value of CfnUserPoolProps.getSmsConfiguration()
      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. 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 .
      Returns:
      this

    • smsVerificationMessage

      @Stability(Stable) public CfnUserPoolProps.Builder smsVerificationMessage(String smsVerificationMessage)
      Sets the value of CfnUserPoolProps.getSmsVerificationMessage()
      Parameters:
      smsVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType .
      Returns:
      this

    • userAttributeUpdateSettings

      @Stability(Stable) public CfnUserPoolProps.Builder userAttributeUpdateSettings(IResolvable userAttributeUpdateSettings)
      Sets the value of CfnUserPoolProps.getUserAttributeUpdateSettings()
      Parameters:
      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 .
      Returns:
      this

    • userAttributeUpdateSettings

      @Stability(Stable) public CfnUserPoolProps.Builder userAttributeUpdateSettings(CfnUserPool.UserAttributeUpdateSettingsProperty userAttributeUpdateSettings)
      Sets the value of CfnUserPoolProps.getUserAttributeUpdateSettings()
      Parameters:
      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 .
      Returns:
      this

    • usernameAttributes

      @Stability(Stable) public CfnUserPoolProps.Builder usernameAttributes(List<String> usernameAttributes)
      Sets the value of CfnUserPoolProps.getUsernameAttributes()
      Parameters:
      usernameAttributes - Determines whether email addresses or phone numbers can be specified as user names when a user signs up. Possible values: phone_number or email .

      This user pool property cannot be updated.

      Returns:
      this

    • usernameConfiguration

      @Stability(Stable) public CfnUserPoolProps.Builder usernameConfiguration(IResolvable usernameConfiguration)
      Sets the value of CfnUserPoolProps.getUsernameConfiguration()
      Parameters:
      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.
      Returns:
      this

    • usernameConfiguration

      @Stability(Stable) public CfnUserPoolProps.Builder usernameConfiguration(CfnUserPool.UsernameConfigurationProperty usernameConfiguration)
      Sets the value of CfnUserPoolProps.getUsernameConfiguration()
      Parameters:
      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.
      Returns:
      this

    • userPoolAddOns

      @Stability(Stable) public CfnUserPoolProps.Builder userPoolAddOns(IResolvable userPoolAddOns)
      Sets the value of CfnUserPoolProps.getUserPoolAddOns()
      Parameters:
      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 to ENFORCED .

      For more information, see Adding advanced security to a user pool .

      Returns:
      this

    • userPoolAddOns

      @Stability(Stable) public CfnUserPoolProps.Builder userPoolAddOns(CfnUserPool.UserPoolAddOnsProperty userPoolAddOns)
      Sets the value of CfnUserPoolProps.getUserPoolAddOns()
      Parameters:
      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 to ENFORCED .

      For more information, see Adding advanced security to a user pool .

      Returns:
      this

    • userPoolName

      @Stability(Stable) public CfnUserPoolProps.Builder userPoolName(String userPoolName)
      Sets the value of CfnUserPoolProps.getUserPoolName()
      Parameters:
      userPoolName - A string used to name the user pool.
      Returns:
      this

    • userPoolTags

      @Stability(Stable) public CfnUserPoolProps.Builder userPoolTags(Object userPoolTags)
      Sets the value of CfnUserPoolProps.getUserPoolTags()
      Parameters:
      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.
      Returns:
      this

    • verificationMessageTemplate

      @Stability(Stable) public CfnUserPoolProps.Builder verificationMessageTemplate(IResolvable verificationMessageTemplate)
      Sets the value of CfnUserPoolProps.getVerificationMessageTemplate()
      Parameters:
      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. 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.
      Returns:
      this

    • verificationMessageTemplate

      @Stability(Stable) public CfnUserPoolProps.Builder verificationMessageTemplate(CfnUserPool.VerificationMessageTemplateProperty verificationMessageTemplate)
      Sets the value of CfnUserPoolProps.getVerificationMessageTemplate()
      Parameters:
      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. 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.
      Returns:
      this

    • build

      @Stability(Stable) public CfnUserPoolProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnUserPoolProps>
      Returns:
      a new instance of CfnUserPoolProps
      Throws:
      NullPointerException - if any required attribute was not provided