UserPoolType

Gets and sets the property AccountRecoverySetting.

The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

Gets and sets the property AdminCreateUserConfig.

The configuration for AdminCreateUser requests.

Gets and sets the property AliasAttributes.

The attributes that are aliased in a user pool.

Gets and sets the property Arn.

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

Gets and sets the property AutoVerifiedAttributes.

The attributes that are auto-verified in a user pool.

Gets and sets the property CreationDate.

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Gets and sets the property CustomDomain.

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. An example of a custom domain name might be auth.example.com.

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

Gets and sets the property DeletionProtection.

When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

Gets and sets the property DeviceConfiguration.

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

Gets and sets the property Domain.

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

Gets and sets the property EmailConfiguration.

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.

Gets and sets the property EmailConfigurationFailure.

Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email configuration.

Gets and sets the property EmailVerificationMessage.

This parameter is no longer used. See VerificationMessageTemplateType.

Gets and sets the property EmailVerificationSubject.

This parameter is no longer used. See VerificationMessageTemplateType.

Gets and sets the property EstimatedNumberOfUsers.

A number estimating the size of the user pool.

Gets and sets the property Id.

The ID of the user pool.

Gets and sets the property LambdaConfig.

The Lambda triggers associated with the user pool.

Gets and sets the property LastModifiedDate.

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Gets and sets the property MfaConfiguration.

Can be one of the following values:

• OFF - MFA tokens aren't required and can't be specified during user registration.

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

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

Gets and sets the property Name.

The name of the user pool.

Gets and sets the property Policies.

The policies associated with the user pool.

Gets and sets the property SchemaAttributes.

A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes.

Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.

Gets and sets the property SmsAuthenticationMessage.

The contents of the SMS authentication message.

Gets and sets the property SmsConfiguration.

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

Gets and sets the property SmsConfigurationFailure.

The reason why the SMS configuration can't 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 Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.

SNSSandbox

The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.

Gets and sets the property SmsVerificationMessage.

This parameter is no longer used. See VerificationMessageTemplateType.

Gets and sets the property Status.

This parameter is no longer used.

Gets and sets the property UserAttributeUpdateSettings.

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

Gets and sets the property UsernameAttributes.

Specifies whether a user can use an email address or phone number as a username when they sign up.

Gets and sets the property UsernameConfiguration.

Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

Gets and sets the property UserPoolAddOns.

User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

For more information, see Adding advanced security to a user pool.

Gets and sets the property UserPoolTags.

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.

Gets and sets the property VerificationMessageTemplate.

The template for verification messages.