public static interface UpdateUserPoolRequest.Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>
| Modifier and Type | Method and Description |
|---|---|
UpdateUserPoolRequest.Builder |
accountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)
Use this setting to define which verified available method a user can use to recover their password when they
call
ForgotPassword. |
default UpdateUserPoolRequest.Builder |
accountRecoverySetting(Consumer<AccountRecoverySettingType.Builder> accountRecoverySetting)
Use this setting to define which verified available method a user can use to recover their password when they
call
ForgotPassword. |
UpdateUserPoolRequest.Builder |
adminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for
AdminCreateUser requests. |
default UpdateUserPoolRequest.Builder |
adminCreateUserConfig(Consumer<AdminCreateUserConfigType.Builder> adminCreateUserConfig)
The configuration for
AdminCreateUser requests. |
UpdateUserPoolRequest.Builder |
autoVerifiedAttributes(Collection<VerifiedAttributeType> autoVerifiedAttributes)
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user
pools.
|
UpdateUserPoolRequest.Builder |
autoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user
pools.
|
UpdateUserPoolRequest.Builder |
autoVerifiedAttributesWithStrings(Collection<String> autoVerifiedAttributes)
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user
pools.
|
UpdateUserPoolRequest.Builder |
autoVerifiedAttributesWithStrings(String... autoVerifiedAttributes)
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user
pools.
|
default UpdateUserPoolRequest.Builder |
deviceConfiguration(Consumer<DeviceConfigurationType.Builder> deviceConfiguration)
Device configuration.
|
UpdateUserPoolRequest.Builder |
deviceConfiguration(DeviceConfigurationType deviceConfiguration)
Device configuration.
|
default UpdateUserPoolRequest.Builder |
emailConfiguration(Consumer<EmailConfigurationType.Builder> emailConfiguration)
Email configuration.
|
UpdateUserPoolRequest.Builder |
emailConfiguration(EmailConfigurationType emailConfiguration)
Email configuration.
|
UpdateUserPoolRequest.Builder |
emailVerificationMessage(String emailVerificationMessage)
The contents of the email verification message.
|
UpdateUserPoolRequest.Builder |
emailVerificationSubject(String emailVerificationSubject)
The subject of the email verification message.
|
default UpdateUserPoolRequest.Builder |
lambdaConfig(Consumer<LambdaConfigType.Builder> lambdaConfig)
The AWS Lambda configuration information from the request to update the user pool.
|
UpdateUserPoolRequest.Builder |
lambdaConfig(LambdaConfigType lambdaConfig)
The AWS Lambda configuration information from the request to update the user pool.
|
UpdateUserPoolRequest.Builder |
mfaConfiguration(String mfaConfiguration)
Can be one of the following values:
|
UpdateUserPoolRequest.Builder |
mfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:
|
UpdateUserPoolRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
UpdateUserPoolRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
default UpdateUserPoolRequest.Builder |
policies(Consumer<UserPoolPolicyType.Builder> policies)
A container with the policies you wish to update in a user pool.
|
UpdateUserPoolRequest.Builder |
policies(UserPoolPolicyType policies)
A container with the policies you wish to update in a user pool.
|
UpdateUserPoolRequest.Builder |
smsAuthenticationMessage(String smsAuthenticationMessage)
The contents of the SMS authentication message.
|
default UpdateUserPoolRequest.Builder |
smsConfiguration(Consumer<SmsConfigurationType.Builder> smsConfiguration)
SMS configuration.
|
UpdateUserPoolRequest.Builder |
smsConfiguration(SmsConfigurationType smsConfiguration)
SMS configuration.
|
UpdateUserPoolRequest.Builder |
smsVerificationMessage(String smsVerificationMessage)
A container with information about the SMS verification message.
|
default UpdateUserPoolRequest.Builder |
userPoolAddOns(Consumer<UserPoolAddOnsType.Builder> userPoolAddOns)
Used to enable advanced security risk detection.
|
UpdateUserPoolRequest.Builder |
userPoolAddOns(UserPoolAddOnsType userPoolAddOns)
Used to enable advanced security risk detection.
|
UpdateUserPoolRequest.Builder |
userPoolId(String userPoolId)
The user pool ID for the user pool you want to update.
|
UpdateUserPoolRequest.Builder |
userPoolTags(Map<String,String> userPoolTags)
The tag keys and values to assign to the user pool.
|
default UpdateUserPoolRequest.Builder |
verificationMessageTemplate(Consumer<VerificationMessageTemplateType.Builder> verificationMessageTemplate)
The template for verification messages.
|
UpdateUserPoolRequest.Builder |
verificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for verification messages.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildUpdateUserPoolRequest.Builder userPoolId(String userPoolId)
The user pool ID for the user pool you want to update.
userPoolId - The user pool ID for the user pool you want to update.UpdateUserPoolRequest.Builder policies(UserPoolPolicyType policies)
A container with the policies you wish to update in a user pool.
policies - A container with the policies you wish to update in a user pool.default UpdateUserPoolRequest.Builder policies(Consumer<UserPoolPolicyType.Builder> policies)
A container with the policies you wish to update in a user pool.
This is a convenience that creates an instance of theUserPoolPolicyType.Builder avoiding the need to
create one manually via UserPoolPolicyType.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to policies(UserPoolPolicyType).policies - a consumer that will call methods on UserPoolPolicyType.Builderpolicies(UserPoolPolicyType)UpdateUserPoolRequest.Builder lambdaConfig(LambdaConfigType lambdaConfig)
The AWS Lambda configuration information from the request to update the user pool.
lambdaConfig - The AWS Lambda configuration information from the request to update the user pool.default UpdateUserPoolRequest.Builder lambdaConfig(Consumer<LambdaConfigType.Builder> lambdaConfig)
The AWS Lambda configuration information from the request to update the user pool.
This is a convenience that creates an instance of theLambdaConfigType.Builder avoiding the need to
create one manually via LambdaConfigType.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to lambdaConfig(LambdaConfigType).lambdaConfig - a consumer that will call methods on LambdaConfigType.BuilderlambdaConfig(LambdaConfigType)UpdateUserPoolRequest.Builder autoVerifiedAttributesWithStrings(Collection<String> autoVerifiedAttributes)
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
autoVerifiedAttributes - The attributes that are automatically verified when the Amazon Cognito service makes a request to
update user pools.UpdateUserPoolRequest.Builder autoVerifiedAttributesWithStrings(String... autoVerifiedAttributes)
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
autoVerifiedAttributes - The attributes that are automatically verified when the Amazon Cognito service makes a request to
update user pools.UpdateUserPoolRequest.Builder autoVerifiedAttributes(Collection<VerifiedAttributeType> autoVerifiedAttributes)
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
autoVerifiedAttributes - The attributes that are automatically verified when the Amazon Cognito service makes a request to
update user pools.UpdateUserPoolRequest.Builder autoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
autoVerifiedAttributes - The attributes that are automatically verified when the Amazon Cognito service makes a request to
update user pools.UpdateUserPoolRequest.Builder smsVerificationMessage(String smsVerificationMessage)
A container with information about the SMS verification message.
smsVerificationMessage - A container with information about the SMS verification message.UpdateUserPoolRequest.Builder emailVerificationMessage(String emailVerificationMessage)
The contents of the email verification message.
emailVerificationMessage - The contents of the email verification message.UpdateUserPoolRequest.Builder emailVerificationSubject(String emailVerificationSubject)
The subject of the email verification message.
emailVerificationSubject - The subject of the email verification message.UpdateUserPoolRequest.Builder verificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for verification messages.
verificationMessageTemplate - The template for verification messages.default UpdateUserPoolRequest.Builder verificationMessageTemplate(Consumer<VerificationMessageTemplateType.Builder> verificationMessageTemplate)
The template for verification messages.
This is a convenience that creates an instance of theVerificationMessageTemplateType.Builder
avoiding the need to create one manually via VerificationMessageTemplateType.builder().
When the Consumer completes, SdkBuilder.build() is called
immediately and its result is passed to verificationMessageTemplate(VerificationMessageTemplateType)
.verificationMessageTemplate - a consumer that will call methods on VerificationMessageTemplateType.BuilderverificationMessageTemplate(VerificationMessageTemplateType)UpdateUserPoolRequest.Builder smsAuthenticationMessage(String smsAuthenticationMessage)
The contents of the SMS authentication message.
smsAuthenticationMessage - The contents of the SMS authentication message.UpdateUserPoolRequest.Builder mfaConfiguration(String 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 ON when you are
initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
OPTIONAL - Users have the option when registering to create an MFA token.
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 ON when you
are initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
OPTIONAL - Users have the option when registering to create an MFA token.
UserPoolMfaType,
UserPoolMfaTypeUpdateUserPoolRequest.Builder mfaConfiguration(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 ON when you are
initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
OPTIONAL - Users have the option when registering to create an MFA token.
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 ON when you
are initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
OPTIONAL - Users have the option when registering to create an MFA token.
UserPoolMfaType,
UserPoolMfaTypeUpdateUserPoolRequest.Builder deviceConfiguration(DeviceConfigurationType deviceConfiguration)
Device configuration.
deviceConfiguration - Device configuration.default UpdateUserPoolRequest.Builder deviceConfiguration(Consumer<DeviceConfigurationType.Builder> deviceConfiguration)
Device configuration.
This is a convenience that creates an instance of theDeviceConfigurationType.Builder avoiding the
need to create one manually via DeviceConfigurationType.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to deviceConfiguration(DeviceConfigurationType).deviceConfiguration - a consumer that will call methods on DeviceConfigurationType.BuilderdeviceConfiguration(DeviceConfigurationType)UpdateUserPoolRequest.Builder emailConfiguration(EmailConfigurationType emailConfiguration)
Email configuration.
emailConfiguration - Email configuration.default UpdateUserPoolRequest.Builder emailConfiguration(Consumer<EmailConfigurationType.Builder> emailConfiguration)
Email configuration.
This is a convenience that creates an instance of theEmailConfigurationType.Builder avoiding the
need to create one manually via EmailConfigurationType.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to emailConfiguration(EmailConfigurationType).emailConfiguration - a consumer that will call methods on EmailConfigurationType.BuilderemailConfiguration(EmailConfigurationType)UpdateUserPoolRequest.Builder smsConfiguration(SmsConfigurationType smsConfiguration)
SMS configuration.
smsConfiguration - SMS configuration.default UpdateUserPoolRequest.Builder smsConfiguration(Consumer<SmsConfigurationType.Builder> smsConfiguration)
SMS configuration.
This is a convenience that creates an instance of theSmsConfigurationType.Builder avoiding the need
to create one manually via SmsConfigurationType.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to smsConfiguration(SmsConfigurationType).smsConfiguration - a consumer that will call methods on SmsConfigurationType.BuildersmsConfiguration(SmsConfigurationType)UpdateUserPoolRequest.Builder userPoolTags(Map<String,String> userPoolTags)
The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
userPoolTags - The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize
and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.UpdateUserPoolRequest.Builder adminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for AdminCreateUser requests.
adminCreateUserConfig - The configuration for AdminCreateUser requests.default UpdateUserPoolRequest.Builder adminCreateUserConfig(Consumer<AdminCreateUserConfigType.Builder> adminCreateUserConfig)
The configuration for AdminCreateUser requests.
AdminCreateUserConfigType.Builder avoiding the
need to create one manually via AdminCreateUserConfigType.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to adminCreateUserConfig(AdminCreateUserConfigType).adminCreateUserConfig - a consumer that will call methods on AdminCreateUserConfigType.BuilderadminCreateUserConfig(AdminCreateUserConfigType)UpdateUserPoolRequest.Builder userPoolAddOns(UserPoolAddOnsType userPoolAddOns)
Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value
"AUDIT".
userPoolAddOns - Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the
value "AUDIT".default UpdateUserPoolRequest.Builder userPoolAddOns(Consumer<UserPoolAddOnsType.Builder> userPoolAddOns)
Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value
"AUDIT".
UserPoolAddOnsType.Builder avoiding the need to
create one manually via UserPoolAddOnsType.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to userPoolAddOns(UserPoolAddOnsType).userPoolAddOns - a consumer that will call methods on UserPoolAddOnsType.BuilderuserPoolAddOns(UserPoolAddOnsType)UpdateUserPoolRequest.Builder accountRecoverySetting(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.
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.default UpdateUserPoolRequest.Builder accountRecoverySetting(Consumer<AccountRecoverySettingType.Builder> 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.
AccountRecoverySettingType.Builder avoiding the
need to create one manually via AccountRecoverySettingType.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to accountRecoverySetting(AccountRecoverySettingType).accountRecoverySetting - a consumer that will call methods on AccountRecoverySettingType.BuilderaccountRecoverySetting(AccountRecoverySettingType)UpdateUserPoolRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderUpdateUserPoolRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2021. All rights reserved.