Class: Aws::Types::UserPoolType

Inherits:

Object

• Object
• Aws::Types::UserPoolType

Defined in:

sig/types.rbs

Constant Summary

SENSITIVE =

Returns:

• ([])

Instance Attribute Summary

• #account_recovery_setting ⇒ Types::AccountRecoverySettingType

  Returns the value of attribute account_recovery_setting.

• #admin_create_user_config ⇒ Types::AdminCreateUserConfigType

  Returns the value of attribute admin_create_user_config.

• #alias_attributes ⇒ ::Array[("phone_number" | "email" | "preferred_username")]

  Returns the value of attribute alias_attributes.

• #arn ⇒ ::String

  Returns the value of attribute arn.

• #auto_verified_attributes ⇒ ::Array[("phone_number" | "email")]

  Returns the value of attribute auto_verified_attributes.

• #creation_date ⇒ ::Time

  Returns the value of attribute creation_date.

• #custom_domain ⇒ ::String

  Returns the value of attribute custom_domain.

• #deletion_protection ⇒ "ACTIVE", "INACTIVE"

  Returns the value of attribute deletion_protection.

• #device_configuration ⇒ Types::DeviceConfigurationType

  Returns the value of attribute device_configuration.

• #domain ⇒ ::String

  Returns the value of attribute domain.

• #email_configuration ⇒ Types::EmailConfigurationType

  Returns the value of attribute email_configuration.

• #email_configuration_failure ⇒ ::String

  Returns the value of attribute email_configuration_failure.

• #email_verification_message ⇒ ::String

  Returns the value of attribute email_verification_message.

• #email_verification_subject ⇒ ::String

  Returns the value of attribute email_verification_subject.

• #estimated_number_of_users ⇒ ::Integer

  Returns the value of attribute estimated_number_of_users.

• #id ⇒ ::String

  Returns the value of attribute id.

• #issuer_configuration ⇒ Types::IssuerConfigurationType

  Returns the value of attribute issuer_configuration.

• #key_configuration ⇒ Types::KeyConfigurationType

  Returns the value of attribute key_configuration.

• #lambda_config ⇒ Types::LambdaConfigType

  Returns the value of attribute lambda_config.

• #last_modified_date ⇒ ::Time

  Returns the value of attribute last_modified_date.

• #mfa_configuration ⇒ "OFF", ...

  Returns the value of attribute mfa_configuration.

• #name ⇒ ::String

  Returns the value of attribute name.

• #policies ⇒ Types::UserPoolPolicyType

  Returns the value of attribute policies.

• #schema_attributes ⇒ ::Array[Types::SchemaAttributeType]

  Returns the value of attribute schema_attributes.

• #sms_authentication_message ⇒ ::String

  Returns the value of attribute sms_authentication_message.

• #sms_configuration ⇒ Types::SmsConfigurationType

  Returns the value of attribute sms_configuration.

• #sms_configuration_failure ⇒ ::String

  Returns the value of attribute sms_configuration_failure.

• #sms_verification_message ⇒ ::String

  Returns the value of attribute sms_verification_message.

• #status ⇒ "Enabled", "Disabled"

  Returns the value of attribute status.

• #user_attribute_update_settings ⇒ Types::UserAttributeUpdateSettingsType

  Returns the value of attribute user_attribute_update_settings.

• #user_pool_add_ons ⇒ Types::UserPoolAddOnsType

  Returns the value of attribute user_pool_add_ons.

• #user_pool_tags ⇒ ::Hash[::String, ::String]

  Returns the value of attribute user_pool_tags.

• #user_pool_tier ⇒ "LITE", ...

  Returns the value of attribute user_pool_tier.

• #username_attributes ⇒ ::Array[("phone_number" | "email")]

  Returns the value of attribute username_attributes.

• #username_configuration ⇒ Types::UsernameConfigurationType

  Returns the value of attribute username_configuration.

• #verification_message_template ⇒ Types::VerificationMessageTemplateType

  Returns the value of attribute verification_message_template.

Instance Attribute Details

#account_recovery_setting ⇒ Types::AccountRecoverySettingType

Returns the value of attribute account_recovery_setting.

Returns:

• (Types::AccountRecoverySettingType)

# File 'sig/types.rbs', line 2557

def account_recovery_setting
  @account_recovery_setting
end

#admin_create_user_config ⇒ Types::AdminCreateUserConfigType

Returns the value of attribute admin_create_user_config.

Returns:

• (Types::AdminCreateUserConfigType)

# File 'sig/types.rbs', line 2553

def admin_create_user_config
  @admin_create_user_config
end

#alias_attributes ⇒ ::Array[("phone_number" | "email" | "preferred_username")]

Returns the value of attribute alias_attributes.

Returns:

• (::Array[("phone_number" | "email" | "preferred_username")])

# File 'sig/types.rbs', line 2535

def alias_attributes
  @alias_attributes
end

#arn ⇒ ::String

Returns the value of attribute arn.

Returns:

• (::String)

# File 'sig/types.rbs', line 2556

def arn
  @arn
end

#auto_verified_attributes ⇒ ::Array[("phone_number" | "email")]

Returns the value of attribute auto_verified_attributes.

Returns:

• (::Array[("phone_number" | "email")])

# File 'sig/types.rbs', line 2534

def auto_verified_attributes
  @auto_verified_attributes
end

#creation_date ⇒ ::Time

Returns the value of attribute creation_date.

Returns:

• (::Time)

# File 'sig/types.rbs', line 2532

def creation_date
  @creation_date
end

#custom_domain ⇒ ::String

Returns the value of attribute custom_domain.

Returns:

• (::String)

# File 'sig/types.rbs', line 2552

def custom_domain
  @custom_domain
end

#deletion_protection ⇒ "ACTIVE", "INACTIVE"

Returns the value of attribute deletion_protection.

Returns:

• ("ACTIVE", "INACTIVE")

# File 'sig/types.rbs', line 2528

def deletion_protection
  @deletion_protection
end

#device_configuration ⇒ Types::DeviceConfigurationType

Returns the value of attribute device_configuration.

Returns:

• (Types::DeviceConfigurationType)

# File 'sig/types.rbs', line 2544

def device_configuration
  @device_configuration
end

#domain ⇒ ::String

Returns the value of attribute domain.

Returns:

• (::String)

# File 'sig/types.rbs', line 2551

def domain
  @domain
end

#email_configuration ⇒ Types::EmailConfigurationType

Returns the value of attribute email_configuration.

Returns:

• (Types::EmailConfigurationType)

# File 'sig/types.rbs', line 2546

def email_configuration
  @email_configuration
end

#email_configuration_failure ⇒ ::String

Returns the value of attribute email_configuration_failure.

Returns:

• (::String)

# File 'sig/types.rbs', line 2550

def email_configuration_failure
  @email_configuration_failure
end

#email_verification_message ⇒ ::String

Returns the value of attribute email_verification_message.

Returns:

• (::String)

# File 'sig/types.rbs', line 2538

def email_verification_message
  @email_verification_message
end

#email_verification_subject ⇒ ::String

Returns the value of attribute email_verification_subject.

Returns:

• (::String)

# File 'sig/types.rbs', line 2539

def email_verification_subject
  @email_verification_subject
end

#estimated_number_of_users ⇒ ::Integer

Returns the value of attribute estimated_number_of_users.

Returns:

• (::Integer)

# File 'sig/types.rbs', line 2545

def estimated_number_of_users
  @estimated_number_of_users
end

#id ⇒ ::String

Returns the value of attribute id.

Returns:

• (::String)

# File 'sig/types.rbs', line 2525

def id
  @id
end

#issuer_configuration ⇒ Types::IssuerConfigurationType

Returns the value of attribute issuer_configuration.

Returns:

• (Types::IssuerConfigurationType)

# File 'sig/types.rbs', line 2560

def issuer_configuration
  @issuer_configuration
end

#key_configuration ⇒ Types::KeyConfigurationType

Returns the value of attribute key_configuration.

Returns:

• (Types::KeyConfigurationType)

# File 'sig/types.rbs', line 2559

def key_configuration
  @key_configuration
end

#lambda_config ⇒ Types::LambdaConfigType

Returns the value of attribute lambda_config.

Returns:

• (Types::LambdaConfigType)

# File 'sig/types.rbs', line 2529

def lambda_config
  @lambda_config
end

#last_modified_date ⇒ ::Time

Returns the value of attribute last_modified_date.

Returns:

• (::Time)

# File 'sig/types.rbs', line 2531

def last_modified_date
  @last_modified_date
end

#mfa_configuration ⇒ "OFF", ...

Returns the value of attribute mfa_configuration.

Returns:

• ("OFF", "ON", "OPTIONAL")

# File 'sig/types.rbs', line 2543

def mfa_configuration
  @mfa_configuration
end

#name ⇒ ::String

Returns the value of attribute name.

Returns:

• (::String)

# File 'sig/types.rbs', line 2526

def name
  @name
end

#policies ⇒ Types::UserPoolPolicyType

Returns the value of attribute policies.

Returns:

• (Types::UserPoolPolicyType)

# File 'sig/types.rbs', line 2527

def policies
  @policies
end

#schema_attributes ⇒ ::Array[Types::SchemaAttributeType]

Returns the value of attribute schema_attributes.

Returns:

• (::Array[Types::SchemaAttributeType])

# File 'sig/types.rbs', line 2533

def schema_attributes
  @schema_attributes
end

#sms_authentication_message ⇒ ::String

Returns the value of attribute sms_authentication_message.

Returns:

• (::String)

# File 'sig/types.rbs', line 2541

def sms_authentication_message
  @sms_authentication_message
end

#sms_configuration ⇒ Types::SmsConfigurationType

Returns the value of attribute sms_configuration.

Returns:

• (Types::SmsConfigurationType)

# File 'sig/types.rbs', line 2547

def sms_configuration
  @sms_configuration
end

#sms_configuration_failure ⇒ ::String

Returns the value of attribute sms_configuration_failure.

Returns:

• (::String)

# File 'sig/types.rbs', line 2549

def sms_configuration_failure
  @sms_configuration_failure
end

#sms_verification_message ⇒ ::String

Returns the value of attribute sms_verification_message.

Returns:

• (::String)

# File 'sig/types.rbs', line 2537

def sms_verification_message
  @sms_verification_message
end

#status ⇒ "Enabled", "Disabled"

Returns the value of attribute status.

Returns:

• ("Enabled", "Disabled")

# File 'sig/types.rbs', line 2530

def status
  @status
end

#user_attribute_update_settings ⇒ Types::UserAttributeUpdateSettingsType

Returns the value of attribute user_attribute_update_settings.

Returns:

• (Types::UserAttributeUpdateSettingsType)

# File 'sig/types.rbs', line 2542

def user_attribute_update_settings
  @user_attribute_update_settings
end

#user_pool_add_ons ⇒ Types::UserPoolAddOnsType

Returns the value of attribute user_pool_add_ons.

Returns:

• (Types::UserPoolAddOnsType)

# File 'sig/types.rbs', line 2554

def user_pool_add_ons
  @user_pool_add_ons
end

#user_pool_tags ⇒ ::Hash[::String, ::String]

Returns the value of attribute user_pool_tags.

Returns:

• (::Hash[::String, ::String])

# File 'sig/types.rbs', line 2548

def user_pool_tags
  @user_pool_tags
end

#user_pool_tier ⇒ "LITE", ...

Returns the value of attribute user_pool_tier.

Returns:

• ("LITE", "ESSENTIALS", "PLUS")

# File 'sig/types.rbs', line 2558

def user_pool_tier
  @user_pool_tier
end

#username_attributes ⇒ ::Array[("phone_number" | "email")]

Returns the value of attribute username_attributes.

Returns:

• (::Array[("phone_number" | "email")])

# File 'sig/types.rbs', line 2536

def username_attributes
  @username_attributes
end

#username_configuration ⇒ Types::UsernameConfigurationType

Returns the value of attribute username_configuration.

Returns:

• (Types::UsernameConfigurationType)

# File 'sig/types.rbs', line 2555

def username_configuration
  @username_configuration
end

#verification_message_template ⇒ Types::VerificationMessageTemplateType

Returns the value of attribute verification_message_template.

Returns:

• (Types::VerificationMessageTemplateType)

# File 'sig/types.rbs', line 2540

def verification_message_template
  @verification_message_template
end