AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RDS::Types::DBProxyTarget

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

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.

Instance Attribute Summary collapse

Instance Attribute Details

#endpointString

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

Returns:

  • (String)

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

#portInteger

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

Returns:

  • (Integer)

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

#rds_resource_idString

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:

  • (String)

    The identifier representing the target.

#target_arnString

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

Returns:

  • (String)

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

#target_healthTypes::TargetHealth

Information about the connection health of the RDS Proxy target.

Returns:

#tracked_cluster_idString

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:

  • (String)

    The DB cluster identifier when the target represents an Aurora DB cluster.

#typeString

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

Possible values:

  • RDS_INSTANCE
  • RDS_SERVERLESS_ENDPOINT
  • TRACKED_CLUSTER

Returns:

  • (String)

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