Class: AWSCDK::Cognito::CfnUserPool::AccountRecoverySettingProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cognito/cfn_user_pool.rb

Overview

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

You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(recovery_mechanisms: nil) ⇒ AccountRecoverySettingProperty

Returns a new instance of AccountRecoverySettingProperty.

Parameters:



954
955
956
957
 
# File 'cognito/cfn_user_pool.rb', line 954

def initialize(recovery_mechanisms: nil)
  @recovery_mechanisms = recovery_mechanisms
  Jsii::Type.check_type(@recovery_mechanisms, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5DZm5Vc2VyUG9vbC5SZWNvdmVyeU9wdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "recoveryMechanisms") unless @recovery_mechanisms.nil?
end

Instance Attribute Details

#recovery_mechanisms ⇒ AWSCDK::IResolvable, ... (readonly)

The list of options and priorities for user message delivery in forgot-password operations.

Sets or displays user pool preferences for email or SMS message priority, whether users should fall back to a second delivery method, and whether passwords should only be reset by administrators.

Returns:

See Also:



965
966
967
 
# File 'cognito/cfn_user_pool.rb', line 965

def recovery_mechanisms
  @recovery_mechanisms
end

Class Method Details

.jsii_properties ⇒ Object 



967
968
969
970
971
 
# File 'cognito/cfn_user_pool.rb', line 967

def self.jsii_properties
  {
    :recovery_mechanisms => "recoveryMechanisms",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



973
974
975
976
977
978
979
 
# File 'cognito/cfn_user_pool.rb', line 973

def to_jsii
  result = {}
  result.merge!({
    "recoveryMechanisms" => @recovery_mechanisms,
  })
  result.compact
end