Package software.amazon.awscdk.services.cognito

Class CfnUserPoolProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.cognito.CfnUserPoolProps.Jsii$Proxy
All Implemented Interfaces:
CfnUserPoolProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnUserPoolProps
@Stability(Stable) @Internal public static final class CfnUserPoolProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnUserPoolProps
An implementation for CfnUserPoolProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(CfnUserPoolProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnUserPoolProps.Builder.

  • Method Details

    • getAccountRecoverySetting

      public final Object getAccountRecoverySetting()
      Description copied from interface: CfnUserPoolProps
      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.

      Specified by:
      getAccountRecoverySetting in interface CfnUserPoolProps

    • getAdminCreateUserConfig

      public final Object getAdminCreateUserConfig()
      Description copied from interface: CfnUserPoolProps
      The configuration for creating a new user profile.
      Specified by:
      getAdminCreateUserConfig in interface CfnUserPoolProps

    • getAliasAttributes

      public final List<String> getAliasAttributes()
      Description copied from interface: CfnUserPoolProps
      Attributes supported as an alias for this user pool. Possible values: phone_number , email , or preferred_username .

      This user pool property cannot be updated.

      Specified by:
      getAliasAttributes in interface CfnUserPoolProps

    • getAutoVerifiedAttributes

      public final List<String> getAutoVerifiedAttributes()
      Description copied from interface: CfnUserPoolProps
      The attributes to be auto-verified.

      Possible values: email , phone_number .

      Specified by:
      getAutoVerifiedAttributes in interface CfnUserPoolProps

    • getDeletionProtection

      public final String getDeletionProtection()
      Description copied from interface: CfnUserPoolProps
      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.

      Specified by:
      getDeletionProtection in interface CfnUserPoolProps

    • getDeviceConfiguration

      public final Object getDeviceConfiguration()
      Description copied from interface: CfnUserPoolProps
      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.

      Specified by:
      getDeviceConfiguration in interface CfnUserPoolProps

    • getEmailConfiguration

      public final Object getEmailConfiguration()
      Description copied from interface: CfnUserPoolProps
      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.

      Specified by:
      getEmailConfiguration in interface CfnUserPoolProps

    • getEmailVerificationMessage

      public final String getEmailVerificationMessage()
      Description copied from interface: CfnUserPoolProps
      This parameter is no longer used.

      See VerificationMessageTemplateType .

      Specified by:
      getEmailVerificationMessage in interface CfnUserPoolProps

    • getEmailVerificationSubject

      public final String getEmailVerificationSubject()
      Description copied from interface: CfnUserPoolProps
      This parameter is no longer used.

      See VerificationMessageTemplateType .

      Specified by:
      getEmailVerificationSubject in interface CfnUserPoolProps

    • getEnabledMfas

      public final List<String> getEnabledMfas()
      Description copied from interface: CfnUserPoolProps
      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

      Specified by:
      getEnabledMfas in interface CfnUserPoolProps

    • getLambdaConfig

      public final Object getLambdaConfig()
      Description copied from interface: CfnUserPoolProps
      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 .

      Specified by:
      getLambdaConfig in interface CfnUserPoolProps

    • getMfaConfiguration

      public final String getMfaConfiguration()
      Description copied from interface: CfnUserPoolProps
      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.
      Specified by:
      getMfaConfiguration in interface CfnUserPoolProps

    • getPolicies

      public final Object getPolicies()
      Description copied from interface: CfnUserPoolProps
      The policy associated with a user pool.
      Specified by:
      getPolicies in interface CfnUserPoolProps

    • getSchema

      public final Object getSchema()
      Description copied from interface: CfnUserPoolProps
      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.

      Specified by:
      getSchema in interface CfnUserPoolProps

    • getSmsAuthenticationMessage

      public final String getSmsAuthenticationMessage()
      Description copied from interface: CfnUserPoolProps
      A string representing the SMS authentication message.
      Specified by:
      getSmsAuthenticationMessage in interface CfnUserPoolProps

    • getSmsConfiguration

      public final Object getSmsConfiguration()
      Description copied from interface: CfnUserPoolProps
      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 .

      Specified by:
      getSmsConfiguration in interface CfnUserPoolProps

    • getSmsVerificationMessage

      public final String getSmsVerificationMessage()
      Description copied from interface: CfnUserPoolProps
      This parameter is no longer used.

      See VerificationMessageTemplateType .

      Specified by:
      getSmsVerificationMessage in interface CfnUserPoolProps

    • getUserAttributeUpdateSettings

      public final Object getUserAttributeUpdateSettings()
      Description copied from interface: CfnUserPoolProps
      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 .

      Specified by:
      getUserAttributeUpdateSettings in interface CfnUserPoolProps

    • getUsernameAttributes

      public final List<String> getUsernameAttributes()
      Description copied from interface: CfnUserPoolProps
      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.

      Specified by:
      getUsernameAttributes in interface CfnUserPoolProps

    • getUsernameConfiguration

      public final Object getUsernameConfiguration()
      Description copied from interface: CfnUserPoolProps
      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.

      Specified by:
      getUsernameConfiguration in interface CfnUserPoolProps

    • getUserPoolAddOns

      public final Object getUserPoolAddOns()
      Description copied from interface: CfnUserPoolProps
      Enables advanced security risk detection.

      Set the key AdvancedSecurityMode to the value "AUDIT".

      Specified by:
      getUserPoolAddOns in interface CfnUserPoolProps

    • getUserPoolName

      public final String getUserPoolName()
      Description copied from interface: CfnUserPoolProps
      A string used to name the user pool.
      Specified by:
      getUserPoolName in interface CfnUserPoolProps

    • getUserPoolTags

      public final Object getUserPoolTags()
      Description copied from interface: CfnUserPoolProps
      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.

      Specified by:
      getUserPoolTags in interface CfnUserPoolProps

    • getVerificationMessageTemplate

      public final Object getVerificationMessageTemplate()
      Description copied from interface: CfnUserPoolProps
      The template for the verification message that the user sees when the app requests permission to access the user's information.
      Specified by:
      getVerificationMessageTemplate in interface CfnUserPoolProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object