software.amazon.awssdk.services.cognitoidentityprovider.model

Interface AdminUpdateUserAttributesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<AdminUpdateUserAttributesRequest.Builder,AdminUpdateUserAttributesRequest>, SdkBuilder<AdminUpdateUserAttributesRequest.Builder,AdminUpdateUserAttributesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

AdminUpdateUserAttributesRequest

public static interface AdminUpdateUserAttributesRequest.Builder
extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<AdminUpdateUserAttributesRequest.Builder,AdminUpdateUserAttributesRequest>

Method Summary

Modifier and Type	Method and Description
AdminUpdateUserAttributesRequest.Builder	clientMetadata(Map<String,String> clientMetadata) A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
AdminUpdateUserAttributesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AdminUpdateUserAttributesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AdminUpdateUserAttributesRequest.Builder	userAttributes(AttributeType... userAttributes) An array of name-value pairs representing user attributes.
AdminUpdateUserAttributesRequest.Builder	userAttributes(Collection<AttributeType> userAttributes) An array of name-value pairs representing user attributes.
AdminUpdateUserAttributesRequest.Builder	userAttributes(Consumer<AttributeType.Builder>... userAttributes) An array of name-value pairs representing user attributes.
AdminUpdateUserAttributesRequest.Builder	username(String username) The user name of the user for whom you want to update user attributes.
AdminUpdateUserAttributesRequest.Builder	userPoolId(String userPoolId) The user pool ID for the user pool where you want to update user attributes.

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

build

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

userPoolId

AdminUpdateUserAttributesRequest.Builder userPoolId(String userPoolId)

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

Parameters:

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

Returns:

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

username

AdminUpdateUserAttributesRequest.Builder username(String username)

The user name of the user for whom you want to update user attributes.

Parameters:

username - The user name of the user for whom you want to update user attributes.

Returns:

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

userAttributes

AdminUpdateUserAttributesRequest.Builder userAttributes(Collection<AttributeType> userAttributes)

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Parameters:

userAttributes - An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Returns:

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

userAttributes

AdminUpdateUserAttributesRequest.Builder userAttributes(AttributeType... userAttributes)

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Parameters:

userAttributes - An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Returns:

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

userAttributes

AdminUpdateUserAttributesRequest.Builder userAttributes(Consumer<AttributeType.Builder>... userAttributes)

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #userAttributes(List).

Parameters:

userAttributes - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#userAttributes(List)

clientMetadata

AdminUpdateUserAttributesRequest.Builder clientMetadata(Map<String,String> clientMetadata)

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

• Amazon Cognito does not validate the ClientMetadata value.

• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

Parameters:

clientMetadata - A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

• Amazon Cognito does not validate the ClientMetadata value.

• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

Returns:

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

overrideConfiguration

AdminUpdateUserAttributesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

AdminUpdateUserAttributesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder