Skip to content

RDS  >  Structures  >  DBProxyTarget

DBProxyTarget

Structure Class

DBProxyTarget dataclass

Bases: _SerdeShape

Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.

This data type is used as a response element in the DescribeDBProxyTargets action.

Attributes

endpoint class-attribute instance-attribute
endpoint: str | None = ...

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

port class-attribute instance-attribute
port: int | None = ...

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

rds_resource_id class-attribute instance-attribute
rds_resource_id: str | None = ...

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.

role class-attribute instance-attribute
role: str | None = ...

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

target_arn class-attribute instance-attribute
target_arn: str | None = ...

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

target_health class-attribute instance-attribute
target_health: TargetHealth | None = ...

Information about the connection health of the RDS Proxy target.

tracked_cluster_id class-attribute instance-attribute
tracked_cluster_id: str | None = ...

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

type class-attribute instance-attribute
type: str | None = ...

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