Interface SetUserSettingsRequest.Builder

All Superinterfaces:

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

Enclosing class:

SetUserSettingsRequest

@Mutable
@NotThreadSafe
public static interface SetUserSettingsRequest.Builder
extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<SetUserSettingsRequest.Builder,SetUserSettingsRequest>

Method Summary

Modifier and Type	Method	Description
SetUserSettingsRequest.Builder	accessToken(String accessToken)	A valid access token that Amazon Cognito issued to the currently signed-in user.
SetUserSettingsRequest.Builder	mfaOptions(Collection<MFAOptionType> mfaOptions)	You can use this parameter only to set an SMS configuration that uses SMS for delivery.
SetUserSettingsRequest.Builder	mfaOptions(Consumer<MFAOptionType.Builder>... mfaOptions)	You can use this parameter only to set an SMS configuration that uses SMS for delivery.
SetUserSettingsRequest.Builder	mfaOptions(MFAOptionType... mfaOptions)	You can use this parameter only to set an SMS configuration that uses SMS for delivery.
SetUserSettingsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SetUserSettingsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

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

overrideConfiguration

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

build

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

accessToken

SetUserSettingsRequest.Builder accessToken(String accessToken)

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

Parameters:

accessToken - A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

Returns:

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

mfaOptions

SetUserSettingsRequest.Builder mfaOptions(Collection<MFAOptionType> mfaOptions)

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Parameters:

mfaOptions - You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Returns:

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

mfaOptions

SetUserSettingsRequest.Builder mfaOptions(MFAOptionType... mfaOptions)

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Parameters:

mfaOptions - You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Returns:

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

mfaOptions

SetUserSettingsRequest.Builder mfaOptions(Consumer<MFAOptionType.Builder>... mfaOptions)

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

This is a convenience method that creates an instance of the MFAOptionType.Builder avoiding the need to create one manually via MFAOptionType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to mfaOptions(List<MFAOptionType>).

Parameters:

mfaOptions - a consumer that will call methods on MFAOptionType.Builder

Returns:

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

See Also:

• mfaOptions(java.util.Collection<MFAOptionType>)

overrideConfiguration

SetUserSettingsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

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

Returns:

This object for method chaining.