Interface User.Builder

    • Method Detail

      • arn

        User.Builder arn​(String arn)

        The ARN of the user.

        Parameters:
        arn - The ARN of the user.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • userName

        User.Builder userName​(String userName)

        The email address of the user.

        Users' email addresses are case-sensitive.

        Parameters:
        userName - The email address of the user.

        Users' email addresses are case-sensitive.

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

        User.Builder enabled​(Boolean enabled)

        Specifies whether the user in the user pool is enabled.

        Parameters:
        enabled - Specifies whether the user in the user pool is enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • status

        User.Builder status​(String status)

        The status of the user in the user pool. The status can be one of the following:

        • UNCONFIRMED – The user is created but not confirmed.

        • CONFIRMED – The user is confirmed.

        • ARCHIVED – The user is no longer active.

        • COMPROMISED – The user is disabled because of a potential security threat.

        • UNKNOWN – The user status is not known.

        Parameters:
        status - The status of the user in the user pool. The status can be one of the following:

        • UNCONFIRMED – The user is created but not confirmed.

        • CONFIRMED – The user is confirmed.

        • ARCHIVED – The user is no longer active.

        • COMPROMISED – The user is disabled because of a potential security threat.

        • UNKNOWN – The user status is not known.

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

        User.Builder firstName​(String firstName)

        The first name, or given name, of the user.

        Parameters:
        firstName - The first name, or given name, of the user.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • lastName

        User.Builder lastName​(String lastName)

        The last name, or surname, of the user.

        Parameters:
        lastName - The last name, or surname, of the user.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • createdTime

        User.Builder createdTime​(Instant createdTime)

        The date and time the user was created in the user pool.

        Parameters:
        createdTime - The date and time the user was created in the user pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • authenticationType

        User.Builder authenticationType​(String authenticationType)

        The authentication type for the user.

        Parameters:
        authenticationType - The authentication type for the user.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AuthenticationType, AuthenticationType
      • authenticationType

        User.Builder authenticationType​(AuthenticationType authenticationType)

        The authentication type for the user.

        Parameters:
        authenticationType - The authentication type for the user.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AuthenticationType, AuthenticationType