@Generated(value="software.amazon.awssdk:codegen") public final class UserPoolType extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UserPoolType.Builder,UserPoolType>
A container for information about the user pool.
Modifier and Type | Class and Description |
---|---|
static interface |
UserPoolType.Builder |
Modifier and Type | Method and Description |
---|---|
AccountRecoverySettingType |
accountRecoverySetting()
Use this setting to define which verified available method a user can use to recover their password when they
call
ForgotPassword . |
AdminCreateUserConfigType |
adminCreateUserConfig()
The configuration for
AdminCreateUser requests. |
List<AliasAttributeType> |
aliasAttributes()
Specifies the attributes that are aliased in a user pool.
|
List<String> |
aliasAttributesAsStrings()
Specifies the attributes that are aliased in a user pool.
|
String |
arn()
The Amazon Resource Name (ARN) for the user pool.
|
List<VerifiedAttributeType> |
autoVerifiedAttributes()
Specifies the attributes that are auto-verified in a user pool.
|
List<String> |
autoVerifiedAttributesAsStrings()
Specifies the attributes that are auto-verified in a user pool.
|
static UserPoolType.Builder |
builder() |
Instant |
creationDate()
The date the user pool was created.
|
String |
customDomain()
A custom domain name that you provide to Amazon Cognito.
|
DeviceConfigurationType |
deviceConfiguration()
The device configuration.
|
String |
domain()
Holds the domain prefix if the user pool has a domain associated with it.
|
EmailConfigurationType |
emailConfiguration()
The email configuration.
|
String |
emailConfigurationFailure()
The reason why the email configuration cannot send the messages to your users.
|
String |
emailVerificationMessage()
The contents of the email verification message.
|
String |
emailVerificationSubject()
The subject of the email verification message.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
Integer |
estimatedNumberOfUsers()
A number estimating the size of the user pool.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAliasAttributes()
Returns true if the AliasAttributes property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasAutoVerifiedAttributes()
Returns true if the AutoVerifiedAttributes property was specified by the sender (it may be empty), or false if
the sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasSchemaAttributes()
Returns true if the SchemaAttributes property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasUsernameAttributes()
Returns true if the UsernameAttributes property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasUserPoolTags()
Returns true if the UserPoolTags property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
String |
id()
The ID of the user pool.
|
LambdaConfigType |
lambdaConfig()
The AWS Lambda triggers associated with the user pool.
|
Instant |
lastModifiedDate()
The date the user pool was last modified.
|
UserPoolMfaType |
mfaConfiguration()
Can be one of the following values:
|
String |
mfaConfigurationAsString()
Can be one of the following values:
|
String |
name()
The name of the user pool.
|
UserPoolPolicyType |
policies()
The policies associated with the user pool.
|
List<SchemaAttributeType> |
schemaAttributes()
A container with the schema attributes of a user pool.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends UserPoolType.Builder> |
serializableBuilderClass() |
String |
smsAuthenticationMessage()
The contents of the SMS authentication message.
|
SmsConfigurationType |
smsConfiguration()
The SMS configuration.
|
String |
smsConfigurationFailure()
The reason why the SMS configuration cannot send the messages to your users.
|
String |
smsVerificationMessage()
The contents of the SMS verification message.
|
StatusType |
status()
The status of a user pool.
|
String |
statusAsString()
The status of a user pool.
|
UserPoolType.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
List<UsernameAttributeType> |
usernameAttributes()
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
List<String> |
usernameAttributesAsStrings()
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
UsernameConfigurationType |
usernameConfiguration()
You can choose to enable case sensitivity on the username input for the selected sign-in option.
|
UserPoolAddOnsType |
userPoolAddOns()
The user pool add-ons.
|
Map<String,String> |
userPoolTags()
The tags that are assigned to the user pool.
|
VerificationMessageTemplateType |
verificationMessageTemplate()
The template for verification messages.
|
copy
public final String id()
The ID of the user pool.
public final String name()
The name of the user pool.
public final UserPoolPolicyType policies()
The policies associated with the user pool.
public final LambdaConfigType lambdaConfig()
The AWS Lambda triggers associated with the user pool.
public final StatusType status()
The status of a user pool.
If the service returns an enum value that is not available in the current SDK version, status
will
return StatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusAsString()
.
StatusType
public final String statusAsString()
The status of a user pool.
If the service returns an enum value that is not available in the current SDK version, status
will
return StatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusAsString()
.
StatusType
public final Instant lastModifiedDate()
The date the user pool was last modified.
public final Instant creationDate()
The date the user pool was created.
public final boolean hasSchemaAttributes()
public final List<SchemaAttributeType> schemaAttributes()
A container with the schema attributes of a user pool.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasSchemaAttributes()
to see if a value was sent in this field.
public final List<VerifiedAttributeType> autoVerifiedAttributes()
Specifies the attributes that are auto-verified in a user pool.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAutoVerifiedAttributes()
to see if a value was sent in this field.
public final boolean hasAutoVerifiedAttributes()
public final List<String> autoVerifiedAttributesAsStrings()
Specifies the attributes that are auto-verified in a user pool.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAutoVerifiedAttributes()
to see if a value was sent in this field.
public final List<AliasAttributeType> aliasAttributes()
Specifies the attributes that are aliased in a user pool.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAliasAttributes()
to see if a value was sent in this field.
public final boolean hasAliasAttributes()
public final List<String> aliasAttributesAsStrings()
Specifies the attributes that are aliased in a user pool.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAliasAttributes()
to see if a value was sent in this field.
public final List<UsernameAttributeType> usernameAttributes()
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasUsernameAttributes()
to see if a value was sent in this field.
public final boolean hasUsernameAttributes()
public final List<String> usernameAttributesAsStrings()
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasUsernameAttributes()
to see if a value was sent in this field.
public final String smsVerificationMessage()
The contents of the SMS verification message.
public final String emailVerificationMessage()
The contents of the email verification message.
public final String emailVerificationSubject()
The subject of the email verification message.
public final VerificationMessageTemplateType verificationMessageTemplate()
The template for verification messages.
public final String smsAuthenticationMessage()
The contents of the SMS authentication message.
public final UserPoolMfaType mfaConfiguration()
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.
If the service returns an enum value that is not available in the current SDK version, mfaConfiguration
will return UserPoolMfaType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from mfaConfigurationAsString()
.
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.
UserPoolMfaType
public final String mfaConfigurationAsString()
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.
If the service returns an enum value that is not available in the current SDK version, mfaConfiguration
will return UserPoolMfaType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from mfaConfigurationAsString()
.
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.
UserPoolMfaType
public final DeviceConfigurationType deviceConfiguration()
The device configuration.
public final Integer estimatedNumberOfUsers()
A number estimating the size of the user pool.
public final EmailConfigurationType emailConfiguration()
The email configuration.
public final SmsConfigurationType smsConfiguration()
The SMS configuration.
public final boolean hasUserPoolTags()
public final Map<String,String> 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.
You can use hasUserPoolTags()
to see if a value was sent in this field.
public final String smsConfigurationFailure()
The reason why the SMS configuration cannot send the messages to your users.
public final String emailConfigurationFailure()
The reason why the email configuration cannot send the messages to your users.
public final String domain()
Holds the domain prefix if the user pool has a domain associated with it.
public final String 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. 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.
auth.example.com
.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
public final AdminCreateUserConfigType adminCreateUserConfig()
The configuration for AdminCreateUser
requests.
AdminCreateUser
requests.public final UserPoolAddOnsType userPoolAddOns()
The user pool add-ons.
public final UsernameConfigurationType usernameConfiguration()
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.
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.public final String arn()
The Amazon Resource Name (ARN) for the user pool.
public final AccountRecoverySettingType accountRecoverySetting()
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.
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.public UserPoolType.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UserPoolType.Builder,UserPoolType>
public static UserPoolType.Builder builder()
public static Class<? extends UserPoolType.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.