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

Interface AdminSetUserMfaPreferenceRequest.Builder

All Superinterfaces:

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

Enclosing class:

AdminSetUserMfaPreferenceRequest

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

Method Summary

Modifier and Type	Method	Description
AdminSetUserMfaPreferenceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
AdminSetUserMfaPreferenceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default AdminSetUserMfaPreferenceRequest.Builder	smsMfaSettings(Consumer<SMSMfaSettingsType.Builder> smsMfaSettings)	The SMS text message MFA settings.
AdminSetUserMfaPreferenceRequest.Builder	smsMfaSettings(SMSMfaSettingsType smsMfaSettings)	The SMS text message MFA settings.
default AdminSetUserMfaPreferenceRequest.Builder	softwareTokenMfaSettings(Consumer<SoftwareTokenMfaSettingsType.Builder> softwareTokenMfaSettings)	The time-based one-time password software token MFA settings.
AdminSetUserMfaPreferenceRequest.Builder	softwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings)	The time-based one-time password software token MFA settings.
AdminSetUserMfaPreferenceRequest.Builder	username(String username)	The username of the user that you want to query or modify.
AdminSetUserMfaPreferenceRequest.Builder	userPoolId(String userPoolId)	The user pool ID.

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 Details

smsMfaSettings

AdminSetUserMfaPreferenceRequest.Builder smsMfaSettings(SMSMfaSettingsType smsMfaSettings)

The SMS text message MFA settings.

Parameters:

smsMfaSettings - The SMS text message MFA settings.

Returns:

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

smsMfaSettings

default AdminSetUserMfaPreferenceRequest.Builder smsMfaSettings(Consumer<SMSMfaSettingsType.Builder> smsMfaSettings)

The SMS text message MFA settings.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to smsMfaSettings(SMSMfaSettingsType).

Parameters:

smsMfaSettings - a consumer that will call methods on SMSMfaSettingsType.Builder

Returns:

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

See Also:

• smsMfaSettings(SMSMfaSettingsType)

softwareTokenMfaSettings

AdminSetUserMfaPreferenceRequest.Builder softwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings)

The time-based one-time password software token MFA settings.

Parameters:

softwareTokenMfaSettings - The time-based one-time password software token MFA settings.

Returns:

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

softwareTokenMfaSettings

default AdminSetUserMfaPreferenceRequest.Builder softwareTokenMfaSettings(Consumer<SoftwareTokenMfaSettingsType.Builder> softwareTokenMfaSettings)

The time-based one-time password software token MFA settings.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to softwareTokenMfaSettings(SoftwareTokenMfaSettingsType).

Parameters:

softwareTokenMfaSettings - a consumer that will call methods on SoftwareTokenMfaSettingsType.Builder

Returns:

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

See Also:

• softwareTokenMfaSettings(SoftwareTokenMfaSettingsType)

username

AdminSetUserMfaPreferenceRequest.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, this value must be the sub of a local user or the username of a user from a third-party IdP.

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, this value must be the sub of a local user or the username of a user from a third-party IdP.

Returns:

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

userPoolId

AdminSetUserMfaPreferenceRequest.Builder userPoolId(String userPoolId)

The user pool ID.

Parameters:

userPoolId - The user pool ID.

Returns:

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

overrideConfiguration

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

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