Class: AWSCDK::Cognito::CfnUserPool::RecoveryOptionProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Cognito::CfnUserPool::RecoveryOptionProperty

Defined in:

cognito/cfn_user_pool.rb

Overview

A recovery option for a user.

The AccountRecoverySettingType data type is an array of this object. Each RecoveryOptionType has a priority property that determines whether it is a primary or secondary option.

For example, if verified_email has a priority of 1 and verified_phone_number has a priority of 2 , your user pool sends account-recovery messages to a verified email address but falls back to an SMS message if the user has a verified phone number. The admin_only option prevents self-service account recovery.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-recoveryoption.html

Instance Attribute Summary

• #name ⇒ String^? readonly

  The recovery method that this object sets a recovery option for.

• #priority ⇒ Numeric^? readonly

  Your priority preference for using the specified attribute in account recovery.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(name: nil, priority: nil) ⇒ RecoveryOptionProperty constructor

  A new instance of RecoveryOptionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(name: nil, priority: nil) ⇒ RecoveryOptionProperty

Returns a new instance of RecoveryOptionProperty.

Parameters:

• name (String, nil) (defaults to: nil) —

  The recovery method that this object sets a recovery option for.

• priority (Numeric, nil) (defaults to: nil) —

  Your priority preference for using the specified attribute in account recovery.

# File 'cognito/cfn_user_pool.rb', line 1861

def initialize(name: nil, priority: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @priority = priority
  Jsii::Type.check_type(@priority, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "priority") unless @priority.nil?
end

Instance Attribute Details

#name ⇒ String^? (readonly)

The recovery method that this object sets a recovery option for.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-recoveryoption.html#cfn-cognito-userpool-recoveryoption-name

# File 'cognito/cfn_user_pool.rb', line 1872

def name
  @name
end

#priority ⇒ Numeric^? (readonly)

Your priority preference for using the specified attribute in account recovery.

The highest priority is 1 .

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-recoveryoption.html#cfn-cognito-userpool-recoveryoption-priority

# File 'cognito/cfn_user_pool.rb', line 1879

def priority
  @priority
end

Class Method Details

.jsii_properties ⇒ Object

# File 'cognito/cfn_user_pool.rb', line 1881

def self.jsii_properties
  {
    :name => "name",
    :priority => "priority",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'cognito/cfn_user_pool.rb', line 1888

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