Package software.amazon.awssdk.services.rds.model

Interface DBProxyTarget.Builder

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

  • Method Details

    • targetArn

      DBProxyTarget.Builder targetArn(String targetArn)

      The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

      Parameters:
      targetArn - The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpoint

      DBProxyTarget.Builder endpoint(String endpoint)

      The writer endpoint for the RDS DB instance or Aurora DB cluster.

      Parameters:
      endpoint - The writer endpoint for the RDS DB instance or Aurora DB cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trackedClusterId

      DBProxyTarget.Builder trackedClusterId(String trackedClusterId)

      The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

      Parameters:
      trackedClusterId - The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rdsResourceId

      DBProxyTarget.Builder rdsResourceId(String rdsResourceId)

      The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.

      Parameters:
      rdsResourceId - The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • port

      DBProxyTarget.Builder port(Integer port)

      The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

      Parameters:
      port - The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      DBProxyTarget.Builder type(String type)

      Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

      Parameters:
      type - Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      DBProxyTarget.Builder type(TargetType type)

      Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

      Parameters:
      type - Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • role

      DBProxyTarget.Builder role(String role)

      A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

      Parameters:
      role - A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • role

      DBProxyTarget.Builder role(TargetRole role)

      A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

      Parameters:
      role - A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • targetHealth

      DBProxyTarget.Builder targetHealth(TargetHealth targetHealth)

      Information about the connection health of the RDS Proxy target.

      Parameters:
      targetHealth - Information about the connection health of the RDS Proxy target.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetHealth

      default DBProxyTarget.Builder targetHealth(Consumer<TargetHealth.Builder> targetHealth)

      Information about the connection health of the RDS Proxy target.

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

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

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