Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface UpdateUserPoolRequest.Builder

All Superinterfaces:

CopyableBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>, SdkBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>

Enclosing class:

UpdateUserPoolRequest

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

Method Summary

Modifier and Type	Method	Description
UpdateUserPoolRequest.Builder	adminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)	The configuration for AdminCreateUser requests.
UpdateUserPoolRequest.Builder	autoVerifiedAttributes(String... autoVerifiedAttributes)	The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
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(VerifiedAttributeType... autoVerifiedAttributes)	The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
UpdateUserPoolRequest.Builder	deviceConfiguration(DeviceConfigurationType deviceConfiguration)	Device 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.
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	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.
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.

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.

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.

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.

See Also:

VerifiedAttributeType

autoVerifiedAttributes

UpdateUserPoolRequest.Builder autoVerifiedAttributes(String... autoVerifiedAttributes)

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

NOTE: This method appends the values to the existing list (if any). Use #setAutoVerifiedAttributes(java.util.Collection) or #withAutoVerifiedAttributes(java.util.Collection) if you want to override the existing values.

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.

See Also:

VerifiedAttributeType

autoVerifiedAttributes

UpdateUserPoolRequest.Builder autoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)

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

NOTE: This method appends the values to the existing list (if any). Use #setAutoVerifiedAttributes(java.util.Collection) or #withAutoVerifiedAttributes(java.util.Collection) if you want to override the existing values.

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.

See Also:

VerifiedAttributeType

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.

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

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

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.

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.

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.

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.