software.amazon.awssdk.services.cognitoidentityprovider.model

Interface UpdateUserPoolRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CognitoIdentityProviderRequest.Builder, CopyableBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>, SdkBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>, SdkRequest.Builder

Enclosing class:

UpdateUserPoolRequest

public static interface UpdateUserPoolRequest.Builder
extends CognitoIdentityProviderRequest.Builder, CopyableBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>

Method Summary

Modifier and Type	Method and Description
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<String> autoVerifiedAttributes) The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
UpdateUserPoolRequest.Builder	autoVerifiedAttributes(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:
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	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
UpdateUserPoolRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
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.
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 cost allocation tags for 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.

Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

userPoolId

UpdateUserPoolRequest.Builder userPoolId(String userPoolId)

The user pool ID for the user pool you want to update.

Parameters:

userPoolId - The user pool ID for the user pool you want to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

policies

UpdateUserPoolRequest.Builder policies(UserPoolPolicyType policies)

A container with the policies you wish to update in a user pool.

Parameters:

policies - A container with the policies you wish to update in a user pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

policies

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 the UserPoolPolicyType.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).

Parameters:

policies - a consumer that will call methods on UserPoolPolicyType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

policies(UserPoolPolicyType)

lambdaConfig

UpdateUserPoolRequest.Builder lambdaConfig(LambdaConfigType lambdaConfig)

The AWS Lambda configuration information from the request to update the user pool.

Parameters:

lambdaConfig - The AWS Lambda configuration information from the request to update the user pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

lambdaConfig

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 the LambdaConfigType.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).

Parameters:

lambdaConfig - a consumer that will call methods on LambdaConfigType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

lambdaConfig(LambdaConfigType)

autoVerifiedAttributes

UpdateUserPoolRequest.Builder autoVerifiedAttributes(Collection<String> autoVerifiedAttributes)

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

Parameters:

autoVerifiedAttributes - The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

Returns:

Returns a reference to this object so that method calls can be chained together.

autoVerifiedAttributes

UpdateUserPoolRequest.Builder autoVerifiedAttributes(String... autoVerifiedAttributes)

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

Parameters:

autoVerifiedAttributes - The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

Returns:

Returns a reference to this object so that method calls can be chained together.

smsVerificationMessage

UpdateUserPoolRequest.Builder smsVerificationMessage(String smsVerificationMessage)

A container with information about the SMS verification message.

Parameters:

smsVerificationMessage - A container with information about the SMS verification message.

Returns:

Returns a reference to this object so that method calls can be chained together.

emailVerificationMessage

UpdateUserPoolRequest.Builder emailVerificationMessage(String emailVerificationMessage)

The contents of the email verification message.

Parameters:

emailVerificationMessage - The contents of the email verification message.

Returns:

Returns a reference to this object so that method calls can be chained together.

emailVerificationSubject

UpdateUserPoolRequest.Builder emailVerificationSubject(String emailVerificationSubject)

The subject of the email verification message.

Parameters:

emailVerificationSubject - The subject of the email verification message.

Returns:

Returns a reference to this object so that method calls can be chained together.

verificationMessageTemplate

UpdateUserPoolRequest.Builder verificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)

The template for verification messages.

Parameters:

verificationMessageTemplate - The template for verification messages.

Returns:

Returns a reference to this object so that method calls can be chained together.

verificationMessageTemplate

default UpdateUserPoolRequest.Builder verificationMessageTemplate(Consumer<VerificationMessageTemplateType.Builder> verificationMessageTemplate)

The template for verification messages.

This is a convenience that creates an instance of the VerificationMessageTemplateType.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) .

Parameters:

verificationMessageTemplate - a consumer that will call methods on VerificationMessageTemplateType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

verificationMessageTemplate(VerificationMessageTemplateType)

smsAuthenticationMessage

UpdateUserPoolRequest.Builder smsAuthenticationMessage(String smsAuthenticationMessage)

The contents of the SMS authentication message.

Parameters:

smsAuthenticationMessage - The contents of the SMS authentication message.

Returns:

Returns a reference to this object so that method calls can be chained together.

mfaConfiguration

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 required when you are initially creating a user pool.

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

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

UserPoolMfaType, UserPoolMfaType

mfaConfiguration

UpdateUserPoolRequest.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 required when you are initially creating a user pool.

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

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

UserPoolMfaType, UserPoolMfaType

deviceConfiguration

UpdateUserPoolRequest.Builder deviceConfiguration(DeviceConfigurationType deviceConfiguration)

Device configuration.

Parameters:

deviceConfiguration - Device configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

deviceConfiguration

default UpdateUserPoolRequest.Builder deviceConfiguration(Consumer<DeviceConfigurationType.Builder> deviceConfiguration)

Device configuration.

This is a convenience that creates an instance of the DeviceConfigurationType.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).

Parameters:

deviceConfiguration - a consumer that will call methods on DeviceConfigurationType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

deviceConfiguration(DeviceConfigurationType)

emailConfiguration

UpdateUserPoolRequest.Builder emailConfiguration(EmailConfigurationType emailConfiguration)

Email configuration.

Parameters:

emailConfiguration - Email configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

emailConfiguration

default UpdateUserPoolRequest.Builder emailConfiguration(Consumer<EmailConfigurationType.Builder> emailConfiguration)

Email configuration.

This is a convenience that creates an instance of the EmailConfigurationType.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).

Parameters:

emailConfiguration - a consumer that will call methods on EmailConfigurationType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

emailConfiguration(EmailConfigurationType)

smsConfiguration

UpdateUserPoolRequest.Builder smsConfiguration(SmsConfigurationType smsConfiguration)

SMS configuration.

Parameters:

smsConfiguration - SMS configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

smsConfiguration

default UpdateUserPoolRequest.Builder smsConfiguration(Consumer<SmsConfigurationType.Builder> smsConfiguration)

SMS configuration.

This is a convenience that creates an instance of the SmsConfigurationType.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).

Parameters:

smsConfiguration - a consumer that will call methods on SmsConfigurationType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

smsConfiguration(SmsConfigurationType)

userPoolTags

UpdateUserPoolRequest.Builder userPoolTags(Map<String,String> userPoolTags)

The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool

Parameters:

userPoolTags - The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool

Returns:

Returns a reference to this object so that method calls can be chained together.

adminCreateUserConfig

UpdateUserPoolRequest.Builder adminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)

The configuration for AdminCreateUser requests.

Parameters:

adminCreateUserConfig - The configuration for AdminCreateUser requests.

Returns:

Returns a reference to this object so that method calls can be chained together.

adminCreateUserConfig

default UpdateUserPoolRequest.Builder adminCreateUserConfig(Consumer<AdminCreateUserConfigType.Builder> adminCreateUserConfig)

The configuration for AdminCreateUser requests.

This is a convenience that creates an instance of the 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).

Parameters:

adminCreateUserConfig - a consumer that will call methods on AdminCreateUserConfigType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

adminCreateUserConfig(AdminCreateUserConfigType)

requestOverrideConfig

UpdateUserPoolRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

UpdateUserPoolRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.