class Aws::CognitoIdentityProvider::Types::UserPoolType

A container for information about the user pool.

@!attribute [rw] id

The ID of the user pool.
@return [String]

@!attribute [rw] name

The name of the user pool.
@return [String]

@!attribute [rw] policies

The policies associated with the user pool.
@return [Types::UserPoolPolicyType]

@!attribute [rw] lambda_config

The Lambda triggers associated with the user pool.
@return [Types::LambdaConfigType]

@!attribute [rw] status

The status of a user pool.
@return [String]

@!attribute [rw] last_modified_date

The date the user pool was last modified.
@return [Time]

@!attribute [rw] creation_date

The date the user pool was created.
@return [Time]

@!attribute [rw] schema_attributes

A container with the schema attributes of a user pool.
@return [Array<Types::SchemaAttributeType>]

@!attribute [rw] auto_verified_attributes

Specifies the attributes that are auto-verified in a user pool.
@return [Array<String>]

@!attribute [rw] alias_attributes

Specifies the attributes that are aliased in a user pool.
@return [Array<String>]

@!attribute [rw] username_attributes

Specifies whether email addresses or phone numbers can be specified
as usernames when a user signs up.
@return [Array<String>]

@!attribute [rw] sms_verification_message

The contents of the SMS verification message.
@return [String]

@!attribute [rw] email_verification_message

The contents of the email verification message.
@return [String]

@!attribute [rw] email_verification_subject

The subject of the email verification message.
@return [String]

@!attribute [rw] verification_message_template

The template for verification messages.
@return [Types::VerificationMessageTemplateType]

@!attribute [rw] sms_authentication_message

The contents of the SMS authentication message.
@return [String]

@!attribute [rw] mfa_configuration

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.
@return [String]

@!attribute [rw] device_configuration

The device configuration.
@return [Types::DeviceConfigurationType]

@!attribute [rw] estimated_number_of_users

A number estimating the size of the user pool.
@return [Integer]

@!attribute [rw] email_configuration

The email configuration.
@return [Types::EmailConfigurationType]

@!attribute [rw] sms_configuration

The SMS configuration.
@return [Types::SmsConfigurationType]

@!attribute [rw] user_pool_tags

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.
@return [Hash<String,String>]

@!attribute [rw] sms_configuration_failure

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

This message might include comma-separated values to describe why
your SMS configuration can't send messages to user pool end users.

* InvalidSmsRoleAccessPolicyException - The IAM role which Cognito
  uses to send SMS messages is not properly configured. For more
  information, see [SmsConfigurationType][1].

* SNSSandbox - The account is in SNS Sandbox and messages won’t
  reach unverified end users. This parameter won’t get populated
  with SNSSandbox if the IAM user creating the user pool doesn’t
  have SNS permissions. To learn how to move your account out of the
  sandbox, see [Moving out of the SMS sandbox][2].

[1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SmsConfigurationType.html
[2]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox-moving-to-production.html
@return [String]

@!attribute [rw] email_configuration_failure

The reason why the email configuration cannot send the messages to
your users.
@return [String]

@!attribute [rw] domain

Holds the domain prefix if the user pool has a domain associated
with it.
@return [String]

@!attribute [rw] custom_domain

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][1].

[1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html
@return [String]

@!attribute [rw] admin_create_user_config

The configuration for `AdminCreateUser` requests.
@return [Types::AdminCreateUserConfigType]

@!attribute [rw] user_pool_add_ons

The user pool add-ons.
@return [Types::UserPoolAddOnsType]

@!attribute [rw] username_configuration

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][1].

[1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html
@return [Types::UsernameConfigurationType]

@!attribute [rw] arn

The Amazon Resource Name (ARN) for the user pool.
@return [String]

@!attribute [rw] account_recovery_setting

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.
@return [Types::AccountRecoverySettingType]

@see docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserPoolType AWS API Documentation

Constants

SENSITIVE