software.amazon.awssdk.services.cognitoidentityprovider.model

Class UserAttributeUpdateSettingsType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.UserAttributeUpdateSettingsType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<UserAttributeUpdateSettingsType.Builder,UserAttributeUpdateSettingsType>

@Generated(value="software.amazon.awssdk:codegen")
public final class UserAttributeUpdateSettingsType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UserAttributeUpdateSettingsType.Builder,UserAttributeUpdateSettingsType>

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to to email addresses and phone numbers.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UserAttributeUpdateSettingsType.Builder

Method Summary

Modifier and Type	Method and Description
List<VerifiedAttributeType>	attributesRequireVerificationBeforeUpdate() Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute.
List<String>	attributesRequireVerificationBeforeUpdateAsStrings() Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute.
static UserAttributeUpdateSettingsType.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributesRequireVerificationBeforeUpdate() For responses, this returns true if the service returned a value for the AttributesRequireVerificationBeforeUpdate property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends UserAttributeUpdateSettingsType.Builder>	serializableBuilderClass()
UserAttributeUpdateSettingsType.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

attributesRequireVerificationBeforeUpdate

public final List<VerifiedAttributeType> attributesRequireVerificationBeforeUpdate()

Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.

You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the UpdateUserAttributes or AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.

When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributesRequireVerificationBeforeUpdate() method.

Returns:

Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.

You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the UpdateUserAttributes or AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.

When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.

hasAttributesRequireVerificationBeforeUpdate

public final boolean hasAttributesRequireVerificationBeforeUpdate()

For responses, this returns true if the service returned a value for the AttributesRequireVerificationBeforeUpdate property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

attributesRequireVerificationBeforeUpdateAsStrings

public final List<String> attributesRequireVerificationBeforeUpdateAsStrings()

Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.

You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the UpdateUserAttributes or AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.

When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributesRequireVerificationBeforeUpdate() method.

Returns:

Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.

You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the UpdateUserAttributes or AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.

When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.

toBuilder

public UserAttributeUpdateSettingsType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UserAttributeUpdateSettingsType.Builder,UserAttributeUpdateSettingsType>

builder

public static UserAttributeUpdateSettingsType.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo