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

Interface AdminSetUserSettingsRequest.Builder

All Superinterfaces:

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

Enclosing class:

AdminSetUserSettingsRequest

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

Method Summary

Modifier and Type	Method	Description
AdminSetUserSettingsRequest.Builder	mfaOptions(Collection<MFAOptionType> mfaOptions)	You can use this parameter only to set an SMS configuration that uses SMS for delivery.
AdminSetUserSettingsRequest.Builder	mfaOptions(Consumer<MFAOptionType.Builder>... mfaOptions)	You can use this parameter only to set an SMS configuration that uses SMS for delivery.
AdminSetUserSettingsRequest.Builder	mfaOptions(MFAOptionType... mfaOptions)	You can use this parameter only to set an SMS configuration that uses SMS for delivery.
AdminSetUserSettingsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AdminSetUserSettingsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AdminSetUserSettingsRequest.Builder	username(String username)	The username of the user that you want to query or modify.
AdminSetUserSettingsRequest.Builder	userPoolId(String userPoolId)	The ID of the user pool that contains the user whose options you're setting.

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, sdkFields

Method Detail

userPoolId

AdminSetUserSettingsRequest.Builder userPoolId(String userPoolId)

The ID of the user pool that contains the user whose options you're setting.

Parameters:

userPoolId - The ID of the user pool that contains the user whose options you're setting.

Returns:

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

username

AdminSetUserSettingsRequest.Builder username(String username)

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, you can also use their sub in this request.

Parameters:

username - The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, you can also use their sub in this request.

Returns:

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

mfaOptions

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

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

AdminSetUserSettingsRequest.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).

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)

overrideConfiguration

AdminSetUserSettingsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder