Interface SetUserPoolMfaConfigRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CognitoIdentityProviderRequest.Builder
,CopyableBuilder<SetUserPoolMfaConfigRequest.Builder,
,SetUserPoolMfaConfigRequest> SdkBuilder<SetUserPoolMfaConfigRequest.Builder,
,SetUserPoolMfaConfigRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SetUserPoolMfaConfigRequest
-
Method Summary
Modifier and TypeMethodDescriptionmfaConfiguration
(String mfaConfiguration) The MFA configuration.mfaConfiguration
(UserPoolMfaType mfaConfiguration) The MFA configuration.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.smsMfaConfiguration
(Consumer<SmsMfaConfigType.Builder> smsMfaConfiguration) The SMS text message MFA configuration.smsMfaConfiguration
(SmsMfaConfigType smsMfaConfiguration) The SMS text message MFA configuration.softwareTokenMfaConfiguration
(Consumer<SoftwareTokenMfaConfigType.Builder> softwareTokenMfaConfiguration) The software token MFA configuration.softwareTokenMfaConfiguration
(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration) The software token MFA configuration.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
-
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.
-
smsMfaConfiguration
The SMS text message MFA configuration.
- Parameters:
smsMfaConfiguration
- The SMS text message MFA configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
smsMfaConfiguration
default SetUserPoolMfaConfigRequest.Builder smsMfaConfiguration(Consumer<SmsMfaConfigType.Builder> smsMfaConfiguration) The SMS text message MFA configuration.
This is a convenience method that creates an instance of theSmsMfaConfigType.Builder
avoiding the need to create one manually viaSmsMfaConfigType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosmsMfaConfiguration(SmsMfaConfigType)
.- Parameters:
smsMfaConfiguration
- a consumer that will call methods onSmsMfaConfigType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
softwareTokenMfaConfiguration
SetUserPoolMfaConfigRequest.Builder softwareTokenMfaConfiguration(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration) The software token MFA configuration.
- Parameters:
softwareTokenMfaConfiguration
- The software token MFA configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
softwareTokenMfaConfiguration
default SetUserPoolMfaConfigRequest.Builder softwareTokenMfaConfiguration(Consumer<SoftwareTokenMfaConfigType.Builder> softwareTokenMfaConfiguration) The software token MFA configuration.
This is a convenience method that creates an instance of theSoftwareTokenMfaConfigType.Builder
avoiding the need to create one manually viaSoftwareTokenMfaConfigType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosoftwareTokenMfaConfiguration(SoftwareTokenMfaConfigType)
.- Parameters:
softwareTokenMfaConfiguration
- a consumer that will call methods onSoftwareTokenMfaConfigType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
mfaConfiguration
The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
-
OFF
MFA won't be used for any users. -
ON
MFA is required for all users to sign in. -
OPTIONAL
MFA will be required only for individual users who have an MFA factor activated.
- Parameters:
mfaConfiguration
- The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:-
OFF
MFA won't be used for any users. -
ON
MFA is required for all users to sign in. -
OPTIONAL
MFA will be required only for individual users who have an MFA factor activated.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
mfaConfiguration
The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
-
OFF
MFA won't be used for any users. -
ON
MFA is required for all users to sign in. -
OPTIONAL
MFA will be required only for individual users who have an MFA factor activated.
- Parameters:
mfaConfiguration
- The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:-
OFF
MFA won't be used for any users. -
ON
MFA is required for all users to sign in. -
OPTIONAL
MFA will be required only for individual users who have an MFA factor activated.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
overrideConfiguration
SetUserPoolMfaConfigRequest.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
SetUserPoolMfaConfigRequest.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.
-