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 type.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#admin_create_user_configTypes::AdminCreateUserConfigType

The configuration for AdminCreateUser requests.

Returns:

#alias_attributesArray<String>

Specifies the attributes that are aliased in a user pool.

Returns:

  • (Array<String>)

    Specifies the attributes that are aliased in a user pool.

#auto_verified_attributesArray<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_dateTime

The date the user pool was created.

Returns:

  • (Time)

    The date the user pool was created.

#device_configurationTypes::DeviceConfigurationType

The device configuration.

Returns:

#email_configurationTypes::EmailConfigurationType

The email configuration.

Returns:

#email_configuration_failureString

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_messageString

The contents of the email verification message.

Returns:

  • (String)

    The contents of the email verification message.

#email_verification_subjectString

The subject of the email verification message.

Returns:

  • (String)

    The subject of the email verification message.

#estimated_number_of_usersInteger

A number estimating the size of the user pool.

Returns:

  • (Integer)

    A number estimating the size of the user pool.

#idString

The ID of the user pool.

Returns:

  • (String)

    The ID of the user pool.

#lambda_configTypes::LambdaConfigType

A container for the AWS Lambda triggers associated with a user pool.

Returns:

#last_modified_dateTime

The date the user pool was last modified.

Returns:

  • (Time)

    The date the user pool was last modified.

#mfa_configurationString

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:.

#nameString

The name of the user pool.

Returns:

  • (String)

    The name of the user pool.

#policiesTypes::UserPoolPolicyType

A container for the policies associated with a user pool.

Returns:

#schema_attributesArray<Types::SchemaAttributeType>

A container with the schema attributes of a user pool.

Returns:

#sms_authentication_messageString

The contents of the SMS authentication message.

Returns:

  • (String)

    The contents of the SMS authentication message.

#sms_configurationTypes::SmsConfigurationType

The SMS configuration.

Returns:

#sms_configuration_failureString

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_messageString

The contents of the SMS verification message.

Returns:

  • (String)

    The contents of the SMS verification message.

#statusString

The status of a user pool.

Possible values:

  • Enabled
  • Disabled

Returns:

  • (String)

    The status of a user pool.

#user_pool_tagsHash<String,String>

The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool

Returns:

  • (Hash<String,String>)

    The cost allocation tags for the user pool.

#username_attributesArray<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.

#verification_message_templateTypes::VerificationMessageTemplateType

The template for verification messages.

Returns: