Interface DBProxyTarget.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DBProxyTarget.Builder,
,DBProxyTarget> SdkBuilder<DBProxyTarget.Builder,
,DBProxyTarget> SdkPojo
- Enclosing class:
DBProxyTarget
-
Method Summary
Modifier and TypeMethodDescriptionThe writer endpoint for the RDS DB instance or Aurora DB cluster.The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.rdsResourceId
(String rdsResourceId) The identifier representing the target.A value that indicates whether the target of the proxy can be used for read/write or read-only operations.role
(TargetRole role) A value that indicates whether the target of the proxy can be used for read/write or read-only operations.The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.default DBProxyTarget.Builder
targetHealth
(Consumer<TargetHealth.Builder> targetHealth) Information about the connection health of the RDS Proxy target.targetHealth
(TargetHealth targetHealth) Information about the connection health of the RDS Proxy target.trackedClusterId
(String trackedClusterId) The DB cluster identifier when the target represents an Aurora DB cluster.Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.type
(TargetType type) Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.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, sdkFields
-
Method Details
-
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
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
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
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
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
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
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
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
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
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
Information about the connection health of the RDS Proxy target.
This is a convenience method that creates an instance of theTargetHealth.Builder
avoiding the need to create one manually viaTargetHealth.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totargetHealth(TargetHealth)
.- Parameters:
targetHealth
- a consumer that will call methods onTargetHealth.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-