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

Class UpdateUserPoolRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.UpdateUserPoolRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>

@Generated("software.amazon.awssdk:codegen")
public class UpdateUserPoolRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>

Represents the request to update the user pool.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateUserPoolRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
AdminCreateUserConfigType	adminCreateUserConfig()	The configuration for AdminCreateUser requests.
List<String>	autoVerifiedAttributes()	The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
static UpdateUserPoolRequest.Builder	builder()
DeviceConfigurationType	deviceConfiguration()	Device configuration.
EmailConfigurationType	emailConfiguration()	Email configuration.
String	emailVerificationMessage()	The contents of the email verification message.
String	emailVerificationSubject()	The subject of the email verification message.
boolean	equals(Object obj)
int	hashCode()
LambdaConfigType	lambdaConfig()	The AWS Lambda configuration information from the request to update the user pool.
String	mfaConfiguration()	Can be one of the following values:
UserPoolPolicyType	policies()	A container with the policies you wish to update in a user pool.
static Class<? extends UpdateUserPoolRequest.Builder>	serializableBuilderClass()
String	smsAuthenticationMessage()	The contents of the SMS authentication message.
SmsConfigurationType	smsConfiguration()	SMS configuration.
String	smsVerificationMessage()	A container with information about the SMS verification message.
UpdateUserPoolRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	userPoolId()	The user pool ID for the user pool you want to update.
Map<String,String>	userPoolTags()	The cost allocation tags for the user pool.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

userPoolId

public String userPoolId()

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

Returns:

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

policies

public UserPoolPolicyType policies()

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

Returns:

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

lambdaConfig

public LambdaConfigType lambdaConfig()

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

Returns:

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

autoVerifiedAttributes

public List<String> autoVerifiedAttributes()

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

Returns:

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

See Also:

VerifiedAttributeType

smsVerificationMessage

public String smsVerificationMessage()

A container with information about the SMS verification message.

Returns:

A container with information about the SMS verification message.

emailVerificationMessage

public String emailVerificationMessage()

The contents of the email verification message.

Returns:

The contents of the email verification message.

emailVerificationSubject

public String emailVerificationSubject()

The subject of the email verification message.

Returns:

The subject of the email verification message.

smsAuthenticationMessage

public String smsAuthenticationMessage()

The contents of the SMS authentication message.

Returns:

The contents of the SMS authentication message.

mfaConfiguration

public 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.

Returns:

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.

See Also:

UserPoolMfaType

deviceConfiguration

public DeviceConfigurationType deviceConfiguration()

Device configuration.

Returns:

Device configuration.

emailConfiguration

public EmailConfigurationType emailConfiguration()

Email configuration.

Returns:

Email configuration.

smsConfiguration

public SmsConfigurationType smsConfiguration()

SMS configuration.

Returns:

SMS configuration.

userPoolTags

public Map<String,String> userPoolTags()

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

Returns:

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

adminCreateUserConfig

public AdminCreateUserConfigType adminCreateUserConfig()

The configuration for AdminCreateUser requests.

Returns:

The configuration for AdminCreateUser requests.

toBuilder

public UpdateUserPoolRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>

Returns:

a builder for type T

builder

public static UpdateUserPoolRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateUserPoolRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object