| Package | Description |
|---|---|
| software.amazon.awssdk.services.cognitoidentityprovider.model |
| Modifier and Type | Method and Description |
|---|---|
UserPoolType.Builder |
UserPoolType.Builder.accountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)
The available verified method a user can use to recover their password when they call
ForgotPassword. |
default UserPoolType.Builder |
UserPoolType.Builder.accountRecoverySetting(Consumer<AccountRecoverySettingType.Builder> accountRecoverySetting)
The available verified method a user can use to recover their password when they call
ForgotPassword. |
UserPoolType.Builder |
UserPoolType.Builder.adminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for
AdminCreateUser requests. |
default UserPoolType.Builder |
UserPoolType.Builder.adminCreateUserConfig(Consumer<AdminCreateUserConfigType.Builder> adminCreateUserConfig)
The configuration for
AdminCreateUser requests. |
UserPoolType.Builder |
UserPoolType.Builder.aliasAttributes(AliasAttributeType... aliasAttributes)
The attributes that are aliased in a user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.aliasAttributes(Collection<AliasAttributeType> aliasAttributes)
The attributes that are aliased in a user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.aliasAttributesWithStrings(Collection<String> aliasAttributes)
The attributes that are aliased in a user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.aliasAttributesWithStrings(String... aliasAttributes)
The attributes that are aliased in a user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.arn(String arn)
The Amazon Resource Name (ARN) for the user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.autoVerifiedAttributes(Collection<VerifiedAttributeType> autoVerifiedAttributes)
The attributes that are auto-verified in a user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.autoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
The attributes that are auto-verified in a user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.autoVerifiedAttributesWithStrings(Collection<String> autoVerifiedAttributes)
The attributes that are auto-verified in a user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.autoVerifiedAttributesWithStrings(String... autoVerifiedAttributes)
The attributes that are auto-verified in a user pool.
|
static UserPoolType.Builder |
UserPoolType.builder() |
UserPoolType.Builder |
UserPoolType.Builder.creationDate(Instant creationDate)
The date the user pool was created.
|
UserPoolType.Builder |
UserPoolType.Builder.customDomain(String customDomain)
A custom domain name that you provide to Amazon Cognito.
|
UserPoolType.Builder |
UserPoolType.Builder.deletionProtection(DeletionProtectionType deletionProtection)
When active,
DeletionProtection prevents accidental deletion of your user pool. |
UserPoolType.Builder |
UserPoolType.Builder.deletionProtection(String deletionProtection)
When active,
DeletionProtection prevents accidental deletion of your user pool. |
default UserPoolType.Builder |
UserPoolType.Builder.deviceConfiguration(Consumer<DeviceConfigurationType.Builder> deviceConfiguration)
The device-remembering configuration for a user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.deviceConfiguration(DeviceConfigurationType deviceConfiguration)
The device-remembering configuration for a user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.domain(String domain)
The domain prefix, if the user pool has a domain associated with it.
|
default UserPoolType.Builder |
UserPoolType.Builder.emailConfiguration(Consumer<EmailConfigurationType.Builder> emailConfiguration)
The email configuration of your user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.emailConfiguration(EmailConfigurationType emailConfiguration)
The email configuration of your user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.emailConfigurationFailure(String emailConfigurationFailure)
Deprecated.
|
UserPoolType.Builder |
UserPoolType.Builder.emailVerificationMessage(String emailVerificationMessage)
This parameter is no longer used.
|
UserPoolType.Builder |
UserPoolType.Builder.emailVerificationSubject(String emailVerificationSubject)
This parameter is no longer used.
|
UserPoolType.Builder |
UserPoolType.Builder.estimatedNumberOfUsers(Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.id(String id)
The ID of the user pool.
|
default UserPoolType.Builder |
UserPoolType.Builder.lambdaConfig(Consumer<LambdaConfigType.Builder> lambdaConfig)
The Lambda triggers associated with the user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.lambdaConfig(LambdaConfigType lambdaConfig)
The Lambda triggers associated with the user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.lastModifiedDate(Instant lastModifiedDate)
The date the user pool was last modified.
|
UserPoolType.Builder |
UserPoolType.Builder.mfaConfiguration(String mfaConfiguration)
Can be one of the following values:
|
UserPoolType.Builder |
UserPoolType.Builder.mfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:
|
UserPoolType.Builder |
UserPoolType.Builder.name(String name)
The name of the user pool.
|
default UserPoolType.Builder |
UserPoolType.Builder.policies(Consumer<UserPoolPolicyType.Builder> policies)
The policies associated with the user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.policies(UserPoolPolicyType policies)
The policies associated with the user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.schemaAttributes(Collection<SchemaAttributeType> schemaAttributes)
A container with the schema attributes of a user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.schemaAttributes(Consumer<SchemaAttributeType.Builder>... schemaAttributes)
A container with the schema attributes of a user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.schemaAttributes(SchemaAttributeType... schemaAttributes)
A container with the schema attributes of a user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.smsAuthenticationMessage(String smsAuthenticationMessage)
The contents of the SMS authentication message.
|
default UserPoolType.Builder |
UserPoolType.Builder.smsConfiguration(Consumer<SmsConfigurationType.Builder> 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.
|
UserPoolType.Builder |
UserPoolType.Builder.smsConfiguration(SmsConfigurationType 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.
|
UserPoolType.Builder |
UserPoolType.Builder.smsConfigurationFailure(String smsConfigurationFailure)
The reason why the SMS configuration can't send the messages to your users.
|
UserPoolType.Builder |
UserPoolType.Builder.smsVerificationMessage(String smsVerificationMessage)
This parameter is no longer used.
|
UserPoolType.Builder |
UserPoolType.Builder.status(StatusType status)
The status of a user pool.
|
UserPoolType.Builder |
UserPoolType.Builder.status(String status)
The status of a user pool.
|
UserPoolType.Builder |
UserPoolType.toBuilder() |
default UserPoolType.Builder |
UserPoolType.Builder.userAttributeUpdateSettings(Consumer<UserAttributeUpdateSettingsType.Builder> userAttributeUpdateSettings)
The settings for updates to user attributes.
|
UserPoolType.Builder |
UserPoolType.Builder.userAttributeUpdateSettings(UserAttributeUpdateSettingsType userAttributeUpdateSettings)
The settings for updates to user attributes.
|
UserPoolType.Builder |
UserPoolType.Builder.usernameAttributes(Collection<UsernameAttributeType> usernameAttributes)
Specifies whether a user can use an email address or phone number as a username when they sign up.
|
UserPoolType.Builder |
UserPoolType.Builder.usernameAttributes(UsernameAttributeType... usernameAttributes)
Specifies whether a user can use an email address or phone number as a username when they sign up.
|
UserPoolType.Builder |
UserPoolType.Builder.usernameAttributesWithStrings(Collection<String> usernameAttributes)
Specifies whether a user can use an email address or phone number as a username when they sign up.
|
UserPoolType.Builder |
UserPoolType.Builder.usernameAttributesWithStrings(String... usernameAttributes)
Specifies whether a user can use an email address or phone number as a username when they sign up.
|
default UserPoolType.Builder |
UserPoolType.Builder.usernameConfiguration(Consumer<UsernameConfigurationType.Builder> usernameConfiguration)
Case sensitivity of the username input for the selected sign-in option.
|
UserPoolType.Builder |
UserPoolType.Builder.usernameConfiguration(UsernameConfigurationType usernameConfiguration)
Case sensitivity of the username input for the selected sign-in option.
|
default UserPoolType.Builder |
UserPoolType.Builder.userPoolAddOns(Consumer<UserPoolAddOnsType.Builder> userPoolAddOns)
The user pool add-ons.
|
UserPoolType.Builder |
UserPoolType.Builder.userPoolAddOns(UserPoolAddOnsType userPoolAddOns)
The user pool add-ons.
|
UserPoolType.Builder |
UserPoolType.Builder.userPoolTags(Map<String,String> userPoolTags)
The tags that are assigned to the user pool.
|
default UserPoolType.Builder |
UserPoolType.Builder.verificationMessageTemplate(Consumer<VerificationMessageTemplateType.Builder> verificationMessageTemplate)
The template for verification messages.
|
UserPoolType.Builder |
UserPoolType.Builder.verificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for verification messages.
|
| Modifier and Type | Method and Description |
|---|---|
static Class<? extends UserPoolType.Builder> |
UserPoolType.serializableBuilderClass() |
| Modifier and Type | Method and Description |
|---|---|
default DescribeUserPoolResponse.Builder |
DescribeUserPoolResponse.Builder.userPool(Consumer<UserPoolType.Builder> userPool)
The container of metadata returned by the server to describe the pool.
|
default CreateUserPoolResponse.Builder |
CreateUserPoolResponse.Builder.userPool(Consumer<UserPoolType.Builder> userPool)
A container for the user pool details.
|
Copyright © 2022. All rights reserved.