Class UserPoolType
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<UserPoolType.Builder,
UserPoolType>
A container for information about the user pool.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe available verified method a user can use to recover their password when they callForgotPassword
.The configuration forAdminCreateUser
requests.final List
<AliasAttributeType> The attributes that are aliased in a user pool.The attributes that are aliased in a user pool.final String
arn()
The Amazon Resource Name (ARN) for the user pool.final List
<VerifiedAttributeType> The attributes that are auto-verified in a user pool.The attributes that are auto-verified in a user pool.static UserPoolType.Builder
builder()
final Instant
The date and time, in ISO 8601 format, when the item was created.final String
A custom domain name that you provide to Amazon Cognito.final DeletionProtectionType
When active,DeletionProtection
prevents accidental deletion of your user pool.final String
When active,DeletionProtection
prevents accidental deletion of your user pool.final DeviceConfigurationType
The device-remembering configuration for a user pool.final String
domain()
The domain prefix, if the user pool has a domain associated with it.final EmailConfigurationType
The email configuration of your user pool.final String
Deprecated.final String
This parameter is no longer used.final String
This parameter is no longer used.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
A number estimating the size of the user pool.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AliasAttributes property.final boolean
For responses, this returns true if the service returned a value for the AutoVerifiedAttributes property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SchemaAttributes property.final boolean
For responses, this returns true if the service returned a value for the UsernameAttributes property.final boolean
For responses, this returns true if the service returned a value for the UserPoolTags property.final String
id()
The ID of the user pool.final LambdaConfigType
The Lambda triggers associated with the user pool.final Instant
The date and time, in ISO 8601 format, when the item was modified.final UserPoolMfaType
Can be one of the following values:final String
Can be one of the following values:final String
name()
The name of the user pool.final UserPoolPolicyType
policies()
The policies associated with the user pool.final List
<SchemaAttributeType> A list of the user attributes and their properties in your user pool.static Class
<? extends UserPoolType.Builder> final String
The contents of the SMS authentication message.final SmsConfigurationType
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.final String
The reason why the SMS configuration can't send the messages to your users.final String
This parameter is no longer used.final StatusType
status()
Deprecated.This property is no longer available.final String
Deprecated.This property is no longer available.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.The settings for updates to user attributes.final List
<UsernameAttributeType> Specifies whether a user can use an email address or phone number as a username when they sign up.Specifies whether a user can use an email address or phone number as a username when they sign up.Case sensitivity of the username input for the selected sign-in option.final UserPoolAddOnsType
User pool add-ons.The tags that are assigned to the user pool.The template for verification messages.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The ID of the user pool.
- Returns:
- The ID of the user pool.
-
name
The name of the user pool.
- Returns:
- The name of the user pool.
-
policies
The policies associated with the user pool.
- Returns:
- The policies associated with the user pool.
-
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 anInvalidParameterException
error. To delete a protected user pool, send a newDeleteUserPool
request after you deactivate deletion protection in anUpdateUserPool
API request.If the service returns an enum value that is not available in the current SDK version,
deletionProtection
will returnDeletionProtectionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeletionProtectionAsString()
.- Returns:
- 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 anInvalidParameterException
error. To delete a protected user pool, send a newDeleteUserPool
request after you deactivate deletion protection in anUpdateUserPool
API request. - See Also:
-
deletionProtectionAsString
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 anInvalidParameterException
error. To delete a protected user pool, send a newDeleteUserPool
request after you deactivate deletion protection in anUpdateUserPool
API request.If the service returns an enum value that is not available in the current SDK version,
deletionProtection
will returnDeletionProtectionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeletionProtectionAsString()
.- Returns:
- 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 anInvalidParameterException
error. To delete a protected user pool, send a newDeleteUserPool
request after you deactivate deletion protection in anUpdateUserPool
API request. - See Also:
-
lambdaConfig
The Lambda triggers associated with the user pool.
- Returns:
- The Lambda triggers associated with the user pool.
-
status
Deprecated.This property is no longer available.This parameter is no longer used.
If the service returns an enum value that is not available in the current SDK version,
status
will returnStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- This parameter is no longer used.
- See Also:
-
statusAsString
Deprecated.This property is no longer available.This parameter is no longer used.
If the service returns an enum value that is not available in the current SDK version,
status
will returnStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- This parameter is no longer used.
- See Also:
-
lastModifiedDate
The date and time, in ISO 8601 format, when the item was modified.
- Returns:
- The date and time, in ISO 8601 format, when the item was modified.
-
creationDate
The date and time, in ISO 8601 format, when the item was created.
- Returns:
- The date and time, in ISO 8601 format, when the item was created.
-
hasSchemaAttributes
public final boolean hasSchemaAttributes()For responses, this returns true if the service returned a value for the SchemaAttributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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 adev:
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSchemaAttributes()
method.- Returns:
- 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 adev:
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.
-
autoVerifiedAttributes
The attributes that are auto-verified in a user pool.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAutoVerifiedAttributes()
method.- Returns:
- The attributes that are auto-verified in a user pool.
-
hasAutoVerifiedAttributes
public final boolean hasAutoVerifiedAttributes()For responses, this returns true if the service returned a value for the AutoVerifiedAttributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
autoVerifiedAttributesAsStrings
The attributes that are auto-verified in a user pool.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAutoVerifiedAttributes()
method.- Returns:
- The attributes that are auto-verified in a user pool.
-
aliasAttributes
The attributes that are aliased in a user pool.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAliasAttributes()
method.- Returns:
- The attributes that are aliased in a user pool.
-
hasAliasAttributes
public final boolean hasAliasAttributes()For responses, this returns true if the service returned a value for the AliasAttributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
aliasAttributesAsStrings
The attributes that are aliased in a user pool.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAliasAttributes()
method.- Returns:
- The attributes that are aliased in a user pool.
-
usernameAttributes
Specifies whether a user can use an email address or phone number as a username when they sign up.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasUsernameAttributes()
method.- Returns:
- Specifies whether a user can use an email address or phone number as a username when they sign up.
-
hasUsernameAttributes
public final boolean hasUsernameAttributes()For responses, this returns true if the service returned a value for the UsernameAttributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
usernameAttributesAsStrings
Specifies whether a user can use an email address or phone number as a username when they sign up.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasUsernameAttributes()
method.- Returns:
- Specifies whether a user can use an email address or phone number as a username when they sign up.
-
smsVerificationMessage
This parameter is no longer used. See VerificationMessageTemplateType.
- Returns:
- This parameter is no longer used. See VerificationMessageTemplateType.
-
emailVerificationMessage
This parameter is no longer used. See VerificationMessageTemplateType.
- Returns:
- This parameter is no longer used. See VerificationMessageTemplateType.
-
emailVerificationSubject
This parameter is no longer used. See VerificationMessageTemplateType.
- Returns:
- This parameter is no longer used. See VerificationMessageTemplateType.
-
verificationMessageTemplate
The template for verification messages.
- Returns:
- The template for verification messages.
-
smsAuthenticationMessage
The contents of the SMS authentication message.
- Returns:
- The contents of the SMS authentication message.
-
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.- Returns:
- 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.
-
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.
If the service returns an enum value that is not available in the current SDK version,
mfaConfiguration
will returnUserPoolMfaType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommfaConfigurationAsString()
.- Returns:
- 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.
-
- See Also:
-
-
mfaConfigurationAsString
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.
If the service returns an enum value that is not available in the current SDK version,
mfaConfiguration
will returnUserPoolMfaType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommfaConfigurationAsString()
.- Returns:
- 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.
-
- See Also:
-
-
deviceConfiguration
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any
DeviceConfiguration
field, you activate the Amazon Cognito device-remembering feature.- Returns:
- The device-remembering configuration for a user pool. A null value indicates that you have deactivated
device remembering in your user pool.
When you provide a value for any
DeviceConfiguration
field, you activate the Amazon Cognito device-remembering feature.
-
estimatedNumberOfUsers
A number estimating the size of the user pool.
- Returns:
- A number estimating the size of the user pool.
-
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.
- Returns:
- 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.
-
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.
- Returns:
- 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.
-
hasUserPoolTags
public final boolean hasUserPoolTags()For responses, this returns true if the service returned a value for the UserPoolTags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasUserPoolTags()
method.- Returns:
- 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.
-
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.
- Returns:
- 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.
-
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.- Returns:
- Deprecated. Review error codes from API requests with
EventSource:cognito-idp.amazonaws.com
in CloudTrail for information about problems with user pool email configuration.
-
domain
The domain prefix, if the user pool has a domain associated with it.
- Returns:
- The domain prefix, if the user pool has a domain associated with it.
-
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.
- Returns:
- 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.
-
adminCreateUserConfig
The configuration for
AdminCreateUser
requests.- Returns:
- The configuration for
AdminCreateUser
requests.
-
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 toENFORCED
.For more information, see Adding advanced security to a user pool.
- Returns:
- 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 toENFORCED
.For more information, see Adding advanced security to a user pool.
-
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.- Returns:
- 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.
-
arn
The Amazon Resource Name (ARN) for the user pool.
- Returns:
- The Amazon Resource Name (ARN) for the user pool.
-
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.- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UserPoolType.Builder,
UserPoolType> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-