Class: Aws::CognitoIdentityProvider::Types::AccountRecoverySettingType

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::AccountRecoverySettingType

Defined in:

gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The settings for user message delivery in forgot-password operations. Contains preference for email or SMS message delivery of password reset codes, or for admin-only password reset.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #recovery_mechanisms ⇒ Array<Types::RecoveryOptionType>

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

Instance Attribute Details

#recovery_mechanisms ⇒ Array<Types::RecoveryOptionType>

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:

• (Array<Types::RecoveryOptionType>)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 37

class AccountRecoverySettingType < Struct.new(
  :recovery_mechanisms)
  SENSITIVE = []
  include Aws::Structure
end