Interface User.Builder

All Superinterfaces:
Buildable, CopyableBuilder<User.Builder,User>, SdkBuilder<User.Builder,User>, SdkPojo
Enclosing class:
User
public static interface User.Builder extends SdkPojo, CopyableBuilder<User.Builder,User>

  • Method Details

    • userId

      User.Builder userId(String userId)

      The ID of the user.

      Parameters:
      userId - The ID 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 username of the user.

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

    • status

      User.Builder status(String status)

      Indicates the user status. Can be "active", "modifying" or "deleting".

      Parameters:
      status - Indicates the user status. Can be "active", "modifying" or "deleting".
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engine

      User.Builder engine(String engine)

      The options are valkey or redis.

      Parameters:
      engine - The options are valkey or redis.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • minimumEngineVersion

      User.Builder minimumEngineVersion(String minimumEngineVersion)

      The minimum engine version required, which is Redis OSS 6.0

      Parameters:
      minimumEngineVersion - The minimum engine version required, which is Redis OSS 6.0
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessString

      User.Builder accessString(String accessString)

      Access permissions string used for this user.

      Parameters:
      accessString - Access permissions string used for this user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userGroupIds

      User.Builder userGroupIds(Collection<String> userGroupIds)

      Returns a list of the user group IDs the user belongs to.

      Parameters:
      userGroupIds - Returns a list of the user group IDs the user belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userGroupIds

      User.Builder userGroupIds(String... userGroupIds)

      Returns a list of the user group IDs the user belongs to.

      Parameters:
      userGroupIds - Returns a list of the user group IDs the user belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authentication

      User.Builder authentication(Authentication authentication)

      Denotes whether the user requires a password to authenticate.

      Parameters:
      authentication - Denotes whether the user requires a password to authenticate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authentication

      default User.Builder authentication(Consumer<Authentication.Builder> authentication)

      Denotes whether the user requires a password to authenticate.

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

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

      Parameters:
      authentication - a consumer that will call methods on Authentication.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • arn

      User.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the user.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.