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

Interface GetUserAuthFactorsResponse.Builder

All Superinterfaces:

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

Enclosing class:

GetUserAuthFactorsResponse

@Mutable
@NotThreadSafe
public static interface GetUserAuthFactorsResponse.Builder
extends CognitoIdentityProviderResponse.Builder, SdkPojo, CopyableBuilder<GetUserAuthFactorsResponse.Builder,GetUserAuthFactorsResponse>

Method Summary

Modifier and Type	Method	Description
GetUserAuthFactorsResponse.Builder	configuredUserAuthFactors(Collection<AuthFactorType> configuredUserAuthFactors)	The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].
GetUserAuthFactorsResponse.Builder	configuredUserAuthFactors(AuthFactorType... configuredUserAuthFactors)	The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].
GetUserAuthFactorsResponse.Builder	configuredUserAuthFactorsWithStrings(String... configuredUserAuthFactors)	The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].
GetUserAuthFactorsResponse.Builder	configuredUserAuthFactorsWithStrings(Collection<String> configuredUserAuthFactors)	The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].
GetUserAuthFactorsResponse.Builder	preferredMfaSetting(String preferredMfaSetting)	The challenge method that Amazon Cognito returns to the user in response to sign-in requests.
GetUserAuthFactorsResponse.Builder	userMFASettingList(String... userMFASettingList)	The MFA options that are activated for the user.
GetUserAuthFactorsResponse.Builder	userMFASettingList(Collection<String> userMFASettingList)	The MFA options that are activated for the user.
GetUserAuthFactorsResponse.Builder	username(String username)	The name of the user who is eligible for the authentication factors in the response.

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

username

GetUserAuthFactorsResponse.Builder username(String username)

The name of the user who is eligible for the authentication factors in the response.

Parameters:

username - The name of the user who is eligible for the authentication factors in the response.

Returns:

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

preferredMfaSetting

GetUserAuthFactorsResponse.Builder preferredMfaSetting(String preferredMfaSetting)

The challenge method that Amazon Cognito returns to the user in response to sign-in requests. Users can prefer SMS message, email message, or TOTP MFA.

Parameters:

preferredMfaSetting - The challenge method that Amazon Cognito returns to the user in response to sign-in requests. Users can prefer SMS message, email message, or TOTP MFA.

Returns:

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

userMFASettingList

GetUserAuthFactorsResponse.Builder userMFASettingList(Collection<String> userMFASettingList)

The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA.

Parameters:

userMFASettingList - The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA.

Returns:

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

userMFASettingList

GetUserAuthFactorsResponse.Builder userMFASettingList(String... userMFASettingList)

The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA.

Parameters:

userMFASettingList - The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA.

Returns:

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

configuredUserAuthFactorsWithStrings

GetUserAuthFactorsResponse.Builder configuredUserAuthFactorsWithStrings(Collection<String> configuredUserAuthFactors)

The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

Parameters:

configuredUserAuthFactors - The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

Returns:

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

configuredUserAuthFactorsWithStrings

GetUserAuthFactorsResponse.Builder configuredUserAuthFactorsWithStrings(String... configuredUserAuthFactors)

The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

Parameters:

configuredUserAuthFactors - The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

Returns:

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

configuredUserAuthFactors

GetUserAuthFactorsResponse.Builder configuredUserAuthFactors(Collection<AuthFactorType> configuredUserAuthFactors)

The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

Parameters:

configuredUserAuthFactors - The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

Returns:

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

configuredUserAuthFactors

GetUserAuthFactorsResponse.Builder configuredUserAuthFactors(AuthFactorType... configuredUserAuthFactors)

The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

Parameters:

configuredUserAuthFactors - The authentication types that are available to the user with USER_AUTH sign-in, for example ["PASSWORD", "WEB_AUTHN"].

Returns:

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