Class: AWSCDK::Cognito::CfnUserPool::UserAttributeUpdateSettingsProperty

Inherits:

Jsii::Struct

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

Defined in:

cognito/cfn_user_pool.rb

Overview

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 .

See Also:

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

Instance Attribute Summary

• #attributes_require_verification_before_update ⇒ Array<String> readonly

  Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(attributes_require_verification_before_update:) ⇒ UserAttributeUpdateSettingsProperty constructor

  A new instance of UserAttributeUpdateSettingsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(attributes_require_verification_before_update:) ⇒ UserAttributeUpdateSettingsProperty

Returns a new instance of UserAttributeUpdateSettingsProperty.

Parameters:

• attributes_require_verification_before_update (Array<String>) —

  Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute.

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

def initialize(attributes_require_verification_before_update:)
  @attributes_require_verification_before_update = attributes_require_verification_before_update
  Jsii::Type.check_type(@attributes_require_verification_before_update, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "attributesRequireVerificationBeforeUpdate")
end

Instance Attribute Details

#attributes_require_verification_before_update ⇒ Array<String> (readonly)

Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute.

When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.

When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.

Returns:

• (Array<String>)

See Also:

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

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

def attributes_require_verification_before_update
  @attributes_require_verification_before_update
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :attributes_require_verification_before_update => "attributesRequireVerificationBeforeUpdate",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

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