Skip to content

DBProxyTarget

Source code in docs_src/capo_rds/types/db_proxy_target.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class DBProxyTarget(TypedDict, closed=True):
    target_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.</p>"""
    endpoint: NotRequired["capo_rds.types.string.String"]
    """<p>The writer endpoint for the RDS DB instance or Aurora DB cluster.</p>"""
    tracked_cluster_id: NotRequired["capo_rds.types.string.String"]
    """<p>The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.</p>"""
    rds_resource_id: NotRequired["capo_rds.types.string.String"]
    """<p>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.</p>"""
    port: NotRequired["capo_rds.types.integer.Integer"]
    """<p>The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.</p>"""
    type: NotRequired["capo_rds.types.target_type.TargetType"]
    """<p>Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.</p>"""
    role: NotRequired["capo_rds.types.target_role.TargetRole"]
    """<p>A value that indicates whether the target of the proxy can be used for read/write or read-only operations.</p>"""
    target_health: NotRequired["capo_rds.types.target_health.TargetHealth"]
    """<p>Information about the connection health of the RDS Proxy target.</p>"""

endpoint instance-attribute 

endpoint: NotRequired[String]

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

port instance-attribute 

port: NotRequired[Integer]

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

rds_resource_id instance-attribute 

rds_resource_id: NotRequired[String]

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 instance-attribute 

role: NotRequired[TargetRole]

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

target_arn instance-attribute 

target_arn: NotRequired[String]

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

target_health instance-attribute 

target_health: NotRequired[TargetHealth]

Information about the connection health of the RDS Proxy target.

tracked_cluster_id instance-attribute 

tracked_cluster_id: NotRequired[String]

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 instance-attribute 

type: NotRequired[TargetType]

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