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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#endpointString

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

Returns:

  • (String)


9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
# File 'lib/aws-sdk-rds/types.rb', line 9764

class DBProxyTarget < Struct.new(
  :target_arn,
  :endpoint,
  :tracked_cluster_id,
  :rds_resource_id,
  :port,
  :type,
  :role,
  :target_health)
  SENSITIVE = []
  include Aws::Structure
end

#portInteger

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

Returns:

  • (Integer)


9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
# File 'lib/aws-sdk-rds/types.rb', line 9764

class DBProxyTarget < Struct.new(
  :target_arn,
  :endpoint,
  :tracked_cluster_id,
  :rds_resource_id,
  :port,
  :type,
  :role,
  :target_health)
  SENSITIVE = []
  include Aws::Structure
end

#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)


9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
# File 'lib/aws-sdk-rds/types.rb', line 9764

class DBProxyTarget < Struct.new(
  :target_arn,
  :endpoint,
  :tracked_cluster_id,
  :rds_resource_id,
  :port,
  :type,
  :role,
  :target_health)
  SENSITIVE = []
  include Aws::Structure
end

#roleString

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

Returns:

  • (String)


9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
# File 'lib/aws-sdk-rds/types.rb', line 9764

class DBProxyTarget < Struct.new(
  :target_arn,
  :endpoint,
  :tracked_cluster_id,
  :rds_resource_id,
  :port,
  :type,
  :role,
  :target_health)
  SENSITIVE = []
  include Aws::Structure
end

#target_arnString

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

Returns:

  • (String)


9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
# File 'lib/aws-sdk-rds/types.rb', line 9764

class DBProxyTarget < Struct.new(
  :target_arn,
  :endpoint,
  :tracked_cluster_id,
  :rds_resource_id,
  :port,
  :type,
  :role,
  :target_health)
  SENSITIVE = []
  include Aws::Structure
end

#target_healthTypes::TargetHealth

Information about the connection health of the RDS Proxy target.

Returns:



9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
# File 'lib/aws-sdk-rds/types.rb', line 9764

class DBProxyTarget < Struct.new(
  :target_arn,
  :endpoint,
  :tracked_cluster_id,
  :rds_resource_id,
  :port,
  :type,
  :role,
  :target_health)
  SENSITIVE = []
  include Aws::Structure
end

#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)


9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
# File 'lib/aws-sdk-rds/types.rb', line 9764

class DBProxyTarget < Struct.new(
  :target_arn,
  :endpoint,
  :tracked_cluster_id,
  :rds_resource_id,
  :port,
  :type,
  :role,
  :target_health)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

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

Returns:

  • (String)


9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
# File 'lib/aws-sdk-rds/types.rb', line 9764

class DBProxyTarget < Struct.new(
  :target_arn,
  :endpoint,
  :tracked_cluster_id,
  :rds_resource_id,
  :port,
  :type,
  :role,
  :target_health)
  SENSITIVE = []
  include Aws::Structure
end