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

Interface GetUserResponse.Builder

    • Method Detail

      • username

        GetUserResponse.Builder username​(String username)

        The username of the user that you requested.

        Parameters:
        username - The username of the user that you requested.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userAttributes

        GetUserResponse.Builder userAttributes​(Collection<AttributeType> userAttributes)

        An array of name-value pairs representing user attributes.

        For custom attributes, you must prepend the custom: prefix to the attribute name.

        Parameters:
        userAttributes - An array of name-value pairs representing user attributes.

        For custom attributes, you must prepend the custom: prefix to the attribute name.

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

      • userAttributes

        GetUserResponse.Builder userAttributes​(AttributeType... userAttributes)

        An array of name-value pairs representing user attributes.

        For custom attributes, you must prepend the custom: prefix to the attribute name.

        Parameters:
        userAttributes - An array of name-value pairs representing user attributes.

        For custom attributes, you must prepend the custom: prefix to the attribute name.

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

      • userAttributes

        GetUserResponse.Builder userAttributes​(Consumer<AttributeType.Builder>... userAttributes)

        An array of name-value pairs representing user attributes.

        For custom attributes, you must prepend the custom: prefix to the attribute name.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #userAttributes(List).

        Parameters:
        userAttributes - a consumer that will call methods on AttributeType.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #userAttributes(java.util.Collection)

      • mfaOptions

        GetUserResponse.Builder mfaOptions​(Collection<MFAOptionType> mfaOptions)

        This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

        Parameters:
        mfaOptions - This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • mfaOptions

        GetUserResponse.Builder mfaOptions​(MFAOptionType... mfaOptions)

        This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

        Parameters:
        mfaOptions - This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • mfaOptions

        GetUserResponse.Builder mfaOptions​(Consumer<MFAOptionType.Builder>... mfaOptions)

        This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #mfaOptions(List).

        Parameters:
        mfaOptions - a consumer that will call methods on MFAOptionType.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #mfaOptions(java.util.Collection)

      • preferredMfaSetting

        GetUserResponse.Builder preferredMfaSetting​(String preferredMfaSetting)

        The user's preferred MFA setting.

        Parameters:
        preferredMfaSetting - The user's preferred MFA setting.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userMFASettingList

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

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