RDS / Client / register_db_proxy_targets

register_db_proxy_targets#

RDS.Client.register_db_proxy_targets(**kwargs)#

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

Request Syntax

response = client.register_db_proxy_targets(
    DBProxyName='string',
    TargetGroupName='string',
    DBInstanceIdentifiers=[
        'string',
    ],
    DBClusterIdentifiers=[
        'string',
    ]
)

Parameters:

DBProxyName (string) –
[REQUIRED]

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
TargetGroupName (string) – The identifier of the DBProxyTargetGroup.
DBInstanceIdentifiers (list) –
One or more DB instance identifiers.
- (string) –
DBClusterIdentifiers (list) –
One or more DB cluster identifiers.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DBProxyTargets': [
        {
            'TargetArn': 'string',
            'Endpoint': 'string',
            'TrackedClusterId': 'string',
            'RdsResourceId': 'string',
            'Port': 123,
            'Type': 'RDS_INSTANCE'|'RDS_SERVERLESS_ENDPOINT'|'TRACKED_CLUSTER',
            'Role': 'READ_WRITE'|'READ_ONLY'|'UNKNOWN',
            'TargetHealth': {
                'State': 'REGISTERING'|'AVAILABLE'|'UNAVAILABLE',
                'Reason': 'UNREACHABLE'|'CONNECTION_FAILED'|'AUTH_FAILURE'|'PENDING_PROXY_CAPACITY'|'INVALID_REPLICATION_STATE',
                'Description': 'string'
            }
        },
    ]
}

Response Structure

(dict) –
- DBProxyTargets (list) –
  
  One or more DBProxyTarget objects that are created when you register targets with a target group.
  - (dict) –
    
    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.
    - TargetArn (string) –
      
      The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
    - Endpoint (string) –
      
      The writer endpoint for the RDS DB instance or Aurora DB cluster.
    - TrackedClusterId (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.
    - RdsResourceId (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.
    - Port (integer) –
      
      The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
    - Type (string) –
      
      Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
    - Role (string) –
      
      A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
    - TargetHealth (dict) –
      
      Information about the connection health of the RDS Proxy target.
      - State (string) –
        
        The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:
        
        registering > unavailable > available > unavailable > available
      - Reason (string) –
        
        The reason for the current health State of the RDS Proxy target.
      - Description (string) –
        
        A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.

Exceptions

RDS.Client.exceptions.DBProxyNotFoundFault
RDS.Client.exceptions.DBProxyTargetGroupNotFoundFault
RDS.Client.exceptions.DBClusterNotFoundFault
RDS.Client.exceptions.DBInstanceNotFoundFault
RDS.Client.exceptions.DBProxyTargetAlreadyRegisteredFault
RDS.Client.exceptions.InvalidDBInstanceStateFault
RDS.Client.exceptions.InvalidDBClusterStateFault
RDS.Client.exceptions.InvalidDBProxyStateFault
RDS.Client.exceptions.InsufficientAvailableIPsInSubnetFault