You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::UserPoolType

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

A container for information about the user pool.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#account_recovery_setting ⇒ Types::AccountRecoverySettingType

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

Returns:

  • (Types::AccountRecoverySettingType) —

    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword.

#admin_create_user_config ⇒ Types::AdminCreateUserConfigType

The configuration for AdminCreateUser requests.

Returns:

#alias_attributes ⇒ Array<String>

Specifies the attributes that are aliased in a user pool.

Returns:

  • (Array<String>) —

    Specifies the attributes that are aliased in a user pool.

#arn ⇒ String

The Amazon Resource Name (ARN) for the user pool.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) for the user pool.

#auto_verified_attributes ⇒ Array<String>

Specifies the attributes that are auto-verified in a user pool.

Returns:

  • (Array<String>) —

    Specifies the attributes that are auto-verified in a user pool.

#creation_date ⇒ Time

The date the user pool was created.

Returns:

  • (Time) —

    The date the user pool was created.

#custom_domain ⇒ String

A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. For example: auth.example.com.

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

Returns:

  • (String) —

    A custom domain name that you provide to Amazon Cognito.

#device_configuration ⇒ Types::DeviceConfigurationType

The device configuration.

Returns:

#domain ⇒ String

Holds the domain prefix if the user pool has a domain associated with it.

Returns:

  • (String) —

    Holds the domain prefix if the user pool has a domain associated with it.

#email_configuration ⇒ Types::EmailConfigurationType

The email configuration.

Returns:

#email_configuration_failure ⇒ String

The reason why the email configuration cannot send the messages to your users.

Returns:

  • (String) —

    The reason why the email configuration cannot send the messages to your users.

#email_verification_message ⇒ String

The contents of the email verification message.

Returns:

  • (String) —

    The contents of the email verification message.

#email_verification_subject ⇒ String

The subject of the email verification message.

Returns:

  • (String) —

    The subject of the email verification message.

#estimated_number_of_users ⇒ Integer

A number estimating the size of the user pool.

Returns:

  • (Integer) —

    A number estimating the size of the user pool.

#id ⇒ String

The ID of the user pool.

Returns:

  • (String) —

    The ID of the user pool.

#lambda_config ⇒ Types::LambdaConfigType

The AWS Lambda triggers associated with the user pool.

Returns:

#last_modified_date ⇒ Time

The date the user pool was last modified.

Returns:

  • (Time) —

    The date the user pool was last modified.

#mfa_configuration ⇒ String

Can be one of the following values:

  • OFF - MFA tokens are not required and cannot be specified during user registration.

  • ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.

  • OPTIONAL - Users have the option when registering to create an MFA token.

    Possible values:

    • OFF
    • ON
    • OPTIONAL

Returns:

  • (String) —

    Can be one of the following values:.

#name ⇒ String

The name of the user pool.

Returns:

  • (String) —

    The name of the user pool.

#policies ⇒ Types::UserPoolPolicyType

The policies associated with the user pool.

Returns:

#schema_attributes ⇒ Array<Types::SchemaAttributeType>

A container with the schema attributes of a user pool.

Returns:

#sms_authentication_message ⇒ String

The contents of the SMS authentication message.

Returns:

  • (String) —

    The contents of the SMS authentication message.

#sms_configuration ⇒ Types::SmsConfigurationType

The SMS configuration.

Returns:

#sms_configuration_failure ⇒ String

The reason why the SMS configuration cannot send the messages to your users.

Returns:

  • (String) —

    The reason why the SMS configuration cannot send the messages to your users.

#sms_verification_message ⇒ String

The contents of the SMS verification message.

Returns:

  • (String) —

    The contents of the SMS verification message.

#status ⇒ String

The status of a user pool.

Possible values:

  • Enabled
  • Disabled

Returns:

  • (String) —

    The status of a user pool.

#user_pool_add_ons ⇒ Types::UserPoolAddOnsType

The user pool add-ons.

Returns:

#user_pool_tags ⇒ Hash<String,String>

The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

Returns:

  • (Hash<String,String>) —

    The tags that are assigned to the user pool.

#username_attributes ⇒ Array<String>

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Returns:

  • (Array<String>) —

    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

#username_configuration ⇒ Types::UsernameConfigurationType

You can choose to enable case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either \"username\" or \"Username\". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

Returns:

#verification_message_template ⇒ Types::VerificationMessageTemplateType

The template for verification messages.

Returns: