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

Interface GetUserPoolMfaConfigResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CognitoIdentityProviderResponse.Builder, CopyableBuilder<GetUserPoolMfaConfigResponse.Builder,GetUserPoolMfaConfigResponse>, SdkBuilder<GetUserPoolMfaConfigResponse.Builder,GetUserPoolMfaConfigResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetUserPoolMfaConfigResponse

public static interface GetUserPoolMfaConfigResponse.Builder
extends CognitoIdentityProviderResponse.Builder, SdkPojo, CopyableBuilder<GetUserPoolMfaConfigResponse.Builder,GetUserPoolMfaConfigResponse>

Method Summary

Modifier and Type	Method	Description
default GetUserPoolMfaConfigResponse.Builder	emailMfaConfiguration(Consumer<EmailMfaConfigType.Builder> emailMfaConfiguration)	Shows user pool email message configuration for MFA.
GetUserPoolMfaConfigResponse.Builder	emailMfaConfiguration(EmailMfaConfigType emailMfaConfiguration)	Shows user pool email message configuration for MFA.
GetUserPoolMfaConfigResponse.Builder	mfaConfiguration(String mfaConfiguration)	The multi-factor authentication (MFA) configuration.
GetUserPoolMfaConfigResponse.Builder	mfaConfiguration(UserPoolMfaType mfaConfiguration)	The multi-factor authentication (MFA) configuration.
default GetUserPoolMfaConfigResponse.Builder	smsMfaConfiguration(Consumer<SmsMfaConfigType.Builder> smsMfaConfiguration)	Shows user pool SMS message configuration for MFA.
GetUserPoolMfaConfigResponse.Builder	smsMfaConfiguration(SmsMfaConfigType smsMfaConfiguration)	Shows user pool SMS message configuration for MFA.
default GetUserPoolMfaConfigResponse.Builder	softwareTokenMfaConfiguration(Consumer<SoftwareTokenMfaConfigType.Builder> softwareTokenMfaConfiguration)	Shows user pool configuration for time-based one-time password (TOTP) MFA.
GetUserPoolMfaConfigResponse.Builder	softwareTokenMfaConfiguration(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration)	Shows user pool configuration for time-based one-time password (TOTP) MFA.
default GetUserPoolMfaConfigResponse.Builder	webAuthnConfiguration(Consumer<WebAuthnConfigurationType.Builder> webAuthnConfiguration)	Shows user pool configuration for MFA with passkeys from biometric devices and security keys.
GetUserPoolMfaConfigResponse.Builder	webAuthnConfiguration(WebAuthnConfigurationType webAuthnConfiguration)	Shows user pool configuration for MFA with passkeys from biometric devices and security keys.

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

build, responseMetadata, responseMetadata

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

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

smsMfaConfiguration

GetUserPoolMfaConfigResponse.Builder smsMfaConfiguration(SmsMfaConfigType smsMfaConfiguration)

Shows user pool SMS message configuration for MFA. Includes the message template and the SMS message sending configuration for Amazon SNS.

Parameters:

smsMfaConfiguration - Shows user pool SMS message configuration for MFA. Includes the message template and the SMS message sending configuration for Amazon SNS.

Returns:

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

smsMfaConfiguration

default GetUserPoolMfaConfigResponse.Builder smsMfaConfiguration(Consumer<SmsMfaConfigType.Builder> smsMfaConfiguration)

Shows user pool SMS message configuration for MFA. Includes the message template and the SMS message sending configuration for Amazon SNS.

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

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

Parameters:

smsMfaConfiguration - a consumer that will call methods on SmsMfaConfigType.Builder

Returns:

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

See Also:

smsMfaConfiguration(SmsMfaConfigType)

softwareTokenMfaConfiguration

GetUserPoolMfaConfigResponse.Builder softwareTokenMfaConfiguration(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration)

Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes TOTP enabled or disabled state.

Parameters:

softwareTokenMfaConfiguration - Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes TOTP enabled or disabled state.

Returns:

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

softwareTokenMfaConfiguration

default GetUserPoolMfaConfigResponse.Builder softwareTokenMfaConfiguration(Consumer<SoftwareTokenMfaConfigType.Builder> softwareTokenMfaConfiguration)

Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes TOTP enabled or disabled state.

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

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

Parameters:

softwareTokenMfaConfiguration - a consumer that will call methods on SoftwareTokenMfaConfigType.Builder

Returns:

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

See Also:

softwareTokenMfaConfiguration(SoftwareTokenMfaConfigType)

emailMfaConfiguration

GetUserPoolMfaConfigResponse.Builder emailMfaConfiguration(EmailMfaConfigType emailMfaConfiguration)

Shows user pool email message configuration for MFA. Includes the subject and body of the email message template for MFA messages. To activate this setting, advanced security features must be active in your user pool.

Parameters:

emailMfaConfiguration - Shows user pool email message configuration for MFA. Includes the subject and body of the email message template for MFA messages. To activate this setting, advanced security features must be active in your user pool.

Returns:

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

emailMfaConfiguration

default GetUserPoolMfaConfigResponse.Builder emailMfaConfiguration(Consumer<EmailMfaConfigType.Builder> emailMfaConfiguration)

Shows user pool email message configuration for MFA. Includes the subject and body of the email message template for MFA messages. To activate this setting, advanced security features must be active in your user pool.

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

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

Parameters:

emailMfaConfiguration - a consumer that will call methods on EmailMfaConfigType.Builder

Returns:

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

See Also:

emailMfaConfiguration(EmailMfaConfigType)

mfaConfiguration

GetUserPoolMfaConfigResponse.Builder mfaConfiguration(String mfaConfiguration)

The multi-factor authentication (MFA) configuration. 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 multi-factor authentication (MFA) configuration. 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:

UserPoolMfaType, UserPoolMfaType

mfaConfiguration

GetUserPoolMfaConfigResponse.Builder mfaConfiguration(UserPoolMfaType mfaConfiguration)

The multi-factor authentication (MFA) configuration. 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 multi-factor authentication (MFA) configuration. 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:

UserPoolMfaType, UserPoolMfaType

webAuthnConfiguration

GetUserPoolMfaConfigResponse.Builder webAuthnConfiguration(WebAuthnConfigurationType webAuthnConfiguration)

Shows user pool configuration for MFA with passkeys from biometric devices and security keys.

Parameters:

webAuthnConfiguration - Shows user pool configuration for MFA with passkeys from biometric devices and security keys.

Returns:

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

webAuthnConfiguration

default GetUserPoolMfaConfigResponse.Builder webAuthnConfiguration(Consumer<WebAuthnConfigurationType.Builder> webAuthnConfiguration)

Shows user pool configuration for MFA with passkeys from biometric devices and security keys.

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

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

Parameters:

webAuthnConfiguration - a consumer that will call methods on WebAuthnConfigurationType.Builder

Returns:

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

See Also:

webAuthnConfiguration(WebAuthnConfigurationType)