Interface CfnUserPoolProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.957Z") @Stability(Stable) public interface CfnUserPoolProps extends
Properties for defining a CfnUserPool.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 Object userPoolTags;
 CfnUserPoolProps cfnUserPoolProps = CfnUserPoolProps.builder()
  • Method Details

    • getAccountRecoverySetting

      @Stability(Stable) @Nullable default Object getAccountRecoverySetting()
      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.

    • getAdminCreateUserConfig

      @Stability(Stable) @Nullable default Object getAdminCreateUserConfig()
      The configuration for creating a new user profile.
    • getAliasAttributes

      @Stability(Stable) @Nullable default List<String> getAliasAttributes()
      Attributes supported as an alias for this user pool. Possible values: phone_number , email , or preferred_username .

      This user pool property cannot be updated.

    • getAutoVerifiedAttributes

      @Stability(Stable) @Nullable default List<String> getAutoVerifiedAttributes()
      The attributes to be auto-verified.

      Possible values: email , phone_number .

    • getDeletionProtection

      @Stability(Stable) @Nullable default String getDeletionProtection()
      When active, DeletionProtection prevents accidental deletion of your user pool.

      Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

      When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

    • getDeviceConfiguration

      @Stability(Stable) @Nullable default Object getDeviceConfiguration()
      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.

    • getEmailConfiguration

      @Stability(Stable) @Nullable default Object getEmailConfiguration()
      The email configuration of your user pool.

      The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.

    • getEmailVerificationMessage

      @Stability(Stable) @Nullable default String getEmailVerificationMessage()
      This parameter is no longer used.

      See VerificationMessageTemplateType .

    • getEmailVerificationSubject

      @Stability(Stable) @Nullable default String getEmailVerificationSubject()
      This parameter is no longer used.

      See VerificationMessageTemplateType .

    • getEnabledMfas

      @Stability(Stable) @Nullable default List<String> getEnabledMfas()
      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

    • getLambdaConfig

      @Stability(Stable) @Nullable default Object getLambdaConfig()
      The Lambda trigger configuration information for the new user pool.

      In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.

      For more information on using the Lambda API to add permission, see AddPermission .

      For adding permission using the AWS CLI , see add-permission .

    • getMfaConfiguration

      @Stability(Stable) @Nullable default String getMfaConfiguration()
      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.
    • getPolicies

      @Stability(Stable) @Nullable default Object getPolicies()
      The policy associated with a user pool.
    • getSchema

      @Stability(Stable) @Nullable default Object getSchema()
      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.

    • getSmsAuthenticationMessage

      @Stability(Stable) @Nullable default String getSmsAuthenticationMessage()
      A string representing the SMS authentication message.
    • getSmsConfiguration

      @Stability(Stable) @Nullable default 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.

      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 .

    • getSmsVerificationMessage

      @Stability(Stable) @Nullable default String getSmsVerificationMessage()
      This parameter is no longer used.

      See VerificationMessageTemplateType .

    • getUserAttributeUpdateSettings

      @Stability(Stable) @Nullable default Object getUserAttributeUpdateSettings()
      The settings for updates to user attributes.

      These settings include the property AttributesRequireVerificationBeforeUpdate , a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers .

    • getUsernameAttributes

      @Stability(Stable) @Nullable default List<String> getUsernameAttributes()
      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.

    • getUsernameConfiguration

      @Stability(Stable) @Nullable default Object getUsernameConfiguration()
      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.

    • getUserPoolAddOns

      @Stability(Stable) @Nullable default Object getUserPoolAddOns()
      Enables advanced security risk detection.

      Set the key AdvancedSecurityMode to the value "AUDIT".

    • getUserPoolName

      @Stability(Stable) @Nullable default String getUserPoolName()
      A string used to name the user pool.
    • getUserPoolTags

      @Stability(Stable) @Nullable default Object getUserPoolTags()
      The tag keys and values to assign to the user pool.

      A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

    • getVerificationMessageTemplate

      @Stability(Stable) @Nullable default Object getVerificationMessageTemplate()
      The template for the verification message that the user sees when the app requests permission to access the user's information.
    • builder

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