Interface SetUserMfaPreferenceRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CognitoIdentityProviderRequest.Builder
,CopyableBuilder<SetUserMfaPreferenceRequest.Builder,
,SetUserMfaPreferenceRequest> SdkBuilder<SetUserMfaPreferenceRequest.Builder,
,SetUserMfaPreferenceRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SetUserMfaPreferenceRequest
public static interface SetUserMfaPreferenceRequest.Builder
extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<SetUserMfaPreferenceRequest.Builder,SetUserMfaPreferenceRequest>
-
Method Summary
Modifier and TypeMethodDescriptionaccessToken
(String accessToken) A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.smsMfaSettings
(Consumer<SMSMfaSettingsType.Builder> smsMfaSettings) The SMS text message multi-factor authentication (MFA) settings.smsMfaSettings
(SMSMfaSettingsType smsMfaSettings) The SMS text message multi-factor authentication (MFA) settings.softwareTokenMfaSettings
(Consumer<SoftwareTokenMfaSettingsType.Builder> softwareTokenMfaSettings) The time-based one-time password (TOTP) software token MFA settings.softwareTokenMfaSettings
(SoftwareTokenMfaSettingsType softwareTokenMfaSettings) The time-based one-time password (TOTP) software token MFA settings.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
The SMS text message multi-factor authentication (MFA) settings.
- Parameters:
smsMfaSettings
- The SMS text message multi-factor authentication (MFA) settings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
smsMfaSettings
default SetUserMfaPreferenceRequest.Builder smsMfaSettings(Consumer<SMSMfaSettingsType.Builder> smsMfaSettings) The SMS text message multi-factor authentication (MFA) settings.
This is a convenience method that creates an instance of theSMSMfaSettingsType.Builder
avoiding the need to create one manually viaSMSMfaSettingsType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosmsMfaSettings(SMSMfaSettingsType)
.- Parameters:
smsMfaSettings
- a consumer that will call methods onSMSMfaSettingsType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
softwareTokenMfaSettings
SetUserMfaPreferenceRequest.Builder softwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings) The time-based one-time password (TOTP) software token MFA settings.
- Parameters:
softwareTokenMfaSettings
- The time-based one-time password (TOTP) software token MFA settings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
softwareTokenMfaSettings
default SetUserMfaPreferenceRequest.Builder softwareTokenMfaSettings(Consumer<SoftwareTokenMfaSettingsType.Builder> softwareTokenMfaSettings) The time-based one-time password (TOTP) software token MFA settings.
This is a convenience method that creates an instance of theSoftwareTokenMfaSettingsType.Builder
avoiding the need to create one manually viaSoftwareTokenMfaSettingsType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosoftwareTokenMfaSettings(SoftwareTokenMfaSettingsType)
.- Parameters:
softwareTokenMfaSettings
- a consumer that will call methods onSoftwareTokenMfaSettingsType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
accessToken
A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.
- Parameters:
accessToken
- A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
SetUserMfaPreferenceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SetUserMfaPreferenceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-