AWS SDK for C++  1.9.156
AWS SDK for C++
Public Member Functions | List of all members
Aws::RDS::Model::DBProxyTarget Class Reference

#include <DBProxyTarget.h>

Public Member Functions

 DBProxyTarget ()
 
 DBProxyTarget (const Aws::Utils::Xml::XmlNode &xmlNode)
 
DBProxyTargetoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetTargetArn () const
 
bool TargetArnHasBeenSet () const
 
void SetTargetArn (const Aws::String &value)
 
void SetTargetArn (Aws::String &&value)
 
void SetTargetArn (const char *value)
 
DBProxyTargetWithTargetArn (const Aws::String &value)
 
DBProxyTargetWithTargetArn (Aws::String &&value)
 
DBProxyTargetWithTargetArn (const char *value)
 
const Aws::StringGetEndpoint () const
 
bool EndpointHasBeenSet () const
 
void SetEndpoint (const Aws::String &value)
 
void SetEndpoint (Aws::String &&value)
 
void SetEndpoint (const char *value)
 
DBProxyTargetWithEndpoint (const Aws::String &value)
 
DBProxyTargetWithEndpoint (Aws::String &&value)
 
DBProxyTargetWithEndpoint (const char *value)
 
const Aws::StringGetTrackedClusterId () const
 
bool TrackedClusterIdHasBeenSet () const
 
void SetTrackedClusterId (const Aws::String &value)
 
void SetTrackedClusterId (Aws::String &&value)
 
void SetTrackedClusterId (const char *value)
 
DBProxyTargetWithTrackedClusterId (const Aws::String &value)
 
DBProxyTargetWithTrackedClusterId (Aws::String &&value)
 
DBProxyTargetWithTrackedClusterId (const char *value)
 
const Aws::StringGetRdsResourceId () const
 
bool RdsResourceIdHasBeenSet () const
 
void SetRdsResourceId (const Aws::String &value)
 
void SetRdsResourceId (Aws::String &&value)
 
void SetRdsResourceId (const char *value)
 
DBProxyTargetWithRdsResourceId (const Aws::String &value)
 
DBProxyTargetWithRdsResourceId (Aws::String &&value)
 
DBProxyTargetWithRdsResourceId (const char *value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
DBProxyTargetWithPort (int value)
 
const TargetTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const TargetType &value)
 
void SetType (TargetType &&value)
 
DBProxyTargetWithType (const TargetType &value)
 
DBProxyTargetWithType (TargetType &&value)
 
const TargetRoleGetRole () const
 
bool RoleHasBeenSet () const
 
void SetRole (const TargetRole &value)
 
void SetRole (TargetRole &&value)
 
DBProxyTargetWithRole (const TargetRole &value)
 
DBProxyTargetWithRole (TargetRole &&value)
 
const TargetHealthGetTargetHealth () const
 
bool TargetHealthHasBeenSet () const
 
void SetTargetHealth (const TargetHealth &value)
 
void SetTargetHealth (TargetHealth &&value)
 
DBProxyTargetWithTargetHealth (const TargetHealth &value)
 
DBProxyTargetWithTargetHealth (TargetHealth &&value)
 

Detailed Description

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.

See Also:

AWS API Reference

Definition at line 38 of file DBProxyTarget.h.

Constructor & Destructor Documentation

◆ DBProxyTarget() [1/2]

Aws::RDS::Model::DBProxyTarget::DBProxyTarget ( )

◆ DBProxyTarget() [2/2]

Aws::RDS::Model::DBProxyTarget::DBProxyTarget ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ EndpointHasBeenSet()

bool Aws::RDS::Model::DBProxyTarget::EndpointHasBeenSet ( ) const
inline

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

Definition at line 106 of file DBProxyTarget.h.

◆ GetEndpoint()

const Aws::String& Aws::RDS::Model::DBProxyTarget::GetEndpoint ( ) const
inline

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

Definition at line 101 of file DBProxyTarget.h.

◆ GetPort()

int Aws::RDS::Model::DBProxyTarget::GetPort ( ) const
inline

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

Definition at line 241 of file DBProxyTarget.h.

◆ GetRdsResourceId()

const Aws::String& Aws::RDS::Model::DBProxyTarget::GetRdsResourceId ( ) const
inline

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.

Definition at line 192 of file DBProxyTarget.h.

◆ GetRole()

const TargetRole& Aws::RDS::Model::DBProxyTarget::GetRole ( ) const
inline

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

Definition at line 303 of file DBProxyTarget.h.

◆ GetTargetArn()

const Aws::String& Aws::RDS::Model::DBProxyTarget::GetTargetArn ( ) const
inline

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

Definition at line 53 of file DBProxyTarget.h.

◆ GetTargetHealth()

const TargetHealth& Aws::RDS::Model::DBProxyTarget::GetTargetHealth ( ) const
inline

Information about the connection health of the RDS Proxy target.

Definition at line 339 of file DBProxyTarget.h.

◆ GetTrackedClusterId()

const Aws::String& Aws::RDS::Model::DBProxyTarget::GetTrackedClusterId ( ) const
inline

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

Definition at line 143 of file DBProxyTarget.h.

◆ GetType()

const TargetType& Aws::RDS::Model::DBProxyTarget::GetType ( ) const
inline

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

Definition at line 266 of file DBProxyTarget.h.

◆ operator=()

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::RDS::Model::DBProxyTarget::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::RDS::Model::DBProxyTarget::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ PortHasBeenSet()

bool Aws::RDS::Model::DBProxyTarget::PortHasBeenSet ( ) const
inline

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

Definition at line 247 of file DBProxyTarget.h.

◆ RdsResourceIdHasBeenSet()

bool Aws::RDS::Model::DBProxyTarget::RdsResourceIdHasBeenSet ( ) const
inline

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.

Definition at line 198 of file DBProxyTarget.h.

◆ RoleHasBeenSet()

bool Aws::RDS::Model::DBProxyTarget::RoleHasBeenSet ( ) const
inline

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

Definition at line 309 of file DBProxyTarget.h.

◆ SetEndpoint() [1/3]

void Aws::RDS::Model::DBProxyTarget::SetEndpoint ( Aws::String &&  value)
inline

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

Definition at line 116 of file DBProxyTarget.h.

◆ SetEndpoint() [2/3]

void Aws::RDS::Model::DBProxyTarget::SetEndpoint ( const Aws::String value)
inline

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

Definition at line 111 of file DBProxyTarget.h.

◆ SetEndpoint() [3/3]

void Aws::RDS::Model::DBProxyTarget::SetEndpoint ( const char *  value)
inline

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

Definition at line 121 of file DBProxyTarget.h.

◆ SetPort()

void Aws::RDS::Model::DBProxyTarget::SetPort ( int  value)
inline

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

Definition at line 253 of file DBProxyTarget.h.

◆ SetRdsResourceId() [1/3]

void Aws::RDS::Model::DBProxyTarget::SetRdsResourceId ( Aws::String &&  value)
inline

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.

Definition at line 210 of file DBProxyTarget.h.

◆ SetRdsResourceId() [2/3]

void Aws::RDS::Model::DBProxyTarget::SetRdsResourceId ( const Aws::String value)
inline

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.

Definition at line 204 of file DBProxyTarget.h.

◆ SetRdsResourceId() [3/3]

void Aws::RDS::Model::DBProxyTarget::SetRdsResourceId ( const char *  value)
inline

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.

Definition at line 216 of file DBProxyTarget.h.

◆ SetRole() [1/2]

void Aws::RDS::Model::DBProxyTarget::SetRole ( const TargetRole value)
inline

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

Definition at line 315 of file DBProxyTarget.h.

◆ SetRole() [2/2]

void Aws::RDS::Model::DBProxyTarget::SetRole ( TargetRole &&  value)
inline

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

Definition at line 321 of file DBProxyTarget.h.

◆ SetTargetArn() [1/3]

void Aws::RDS::Model::DBProxyTarget::SetTargetArn ( Aws::String &&  value)
inline

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

Definition at line 71 of file DBProxyTarget.h.

◆ SetTargetArn() [2/3]

void Aws::RDS::Model::DBProxyTarget::SetTargetArn ( const Aws::String value)
inline

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

Definition at line 65 of file DBProxyTarget.h.

◆ SetTargetArn() [3/3]

void Aws::RDS::Model::DBProxyTarget::SetTargetArn ( const char *  value)
inline

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

Definition at line 77 of file DBProxyTarget.h.

◆ SetTargetHealth() [1/2]

void Aws::RDS::Model::DBProxyTarget::SetTargetHealth ( const TargetHealth value)
inline

Information about the connection health of the RDS Proxy target.

Definition at line 349 of file DBProxyTarget.h.

◆ SetTargetHealth() [2/2]

void Aws::RDS::Model::DBProxyTarget::SetTargetHealth ( TargetHealth &&  value)
inline

Information about the connection health of the RDS Proxy target.

Definition at line 354 of file DBProxyTarget.h.

◆ SetTrackedClusterId() [1/3]

void Aws::RDS::Model::DBProxyTarget::SetTrackedClusterId ( Aws::String &&  value)
inline

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

Definition at line 161 of file DBProxyTarget.h.

◆ SetTrackedClusterId() [2/3]

void Aws::RDS::Model::DBProxyTarget::SetTrackedClusterId ( const Aws::String value)
inline

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

Definition at line 155 of file DBProxyTarget.h.

◆ SetTrackedClusterId() [3/3]

void Aws::RDS::Model::DBProxyTarget::SetTrackedClusterId ( const char *  value)
inline

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

Definition at line 167 of file DBProxyTarget.h.

◆ SetType() [1/2]

void Aws::RDS::Model::DBProxyTarget::SetType ( const TargetType value)
inline

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

Definition at line 278 of file DBProxyTarget.h.

◆ SetType() [2/2]

void Aws::RDS::Model::DBProxyTarget::SetType ( TargetType &&  value)
inline

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

Definition at line 284 of file DBProxyTarget.h.

◆ TargetArnHasBeenSet()

bool Aws::RDS::Model::DBProxyTarget::TargetArnHasBeenSet ( ) const
inline

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

Definition at line 59 of file DBProxyTarget.h.

◆ TargetHealthHasBeenSet()

bool Aws::RDS::Model::DBProxyTarget::TargetHealthHasBeenSet ( ) const
inline

Information about the connection health of the RDS Proxy target.

Definition at line 344 of file DBProxyTarget.h.

◆ TrackedClusterIdHasBeenSet()

bool Aws::RDS::Model::DBProxyTarget::TrackedClusterIdHasBeenSet ( ) const
inline

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

Definition at line 149 of file DBProxyTarget.h.

◆ TypeHasBeenSet()

bool Aws::RDS::Model::DBProxyTarget::TypeHasBeenSet ( ) const
inline

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

Definition at line 272 of file DBProxyTarget.h.

◆ WithEndpoint() [1/3]

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithEndpoint ( Aws::String &&  value)
inline

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

Definition at line 131 of file DBProxyTarget.h.

◆ WithEndpoint() [2/3]

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithEndpoint ( const Aws::String value)
inline

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

Definition at line 126 of file DBProxyTarget.h.

◆ WithEndpoint() [3/3]

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithEndpoint ( const char *  value)
inline

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

Definition at line 136 of file DBProxyTarget.h.

◆ WithPort()

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithPort ( int  value)
inline

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

Definition at line 259 of file DBProxyTarget.h.

◆ WithRdsResourceId() [1/3]

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithRdsResourceId ( Aws::String &&  value)
inline

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.

Definition at line 228 of file DBProxyTarget.h.

◆ WithRdsResourceId() [2/3]

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithRdsResourceId ( const Aws::String value)
inline

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.

Definition at line 222 of file DBProxyTarget.h.

◆ WithRdsResourceId() [3/3]

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithRdsResourceId ( const char *  value)
inline

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.

Definition at line 234 of file DBProxyTarget.h.

◆ WithRole() [1/2]

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithRole ( const TargetRole value)
inline

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

Definition at line 327 of file DBProxyTarget.h.

◆ WithRole() [2/2]

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithRole ( TargetRole &&  value)
inline

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

Definition at line 333 of file DBProxyTarget.h.

◆ WithTargetArn() [1/3]

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithTargetArn ( Aws::String &&  value)
inline

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

Definition at line 89 of file DBProxyTarget.h.

◆ WithTargetArn() [2/3]

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithTargetArn ( const Aws::String value)
inline

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

Definition at line 83 of file DBProxyTarget.h.

◆ WithTargetArn() [3/3]

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithTargetArn ( const char *  value)
inline

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

Definition at line 95 of file DBProxyTarget.h.

◆ WithTargetHealth() [1/2]

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithTargetHealth ( const TargetHealth value)
inline

Information about the connection health of the RDS Proxy target.

Definition at line 359 of file DBProxyTarget.h.

◆ WithTargetHealth() [2/2]

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithTargetHealth ( TargetHealth &&  value)
inline

Information about the connection health of the RDS Proxy target.

Definition at line 364 of file DBProxyTarget.h.

◆ WithTrackedClusterId() [1/3]

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithTrackedClusterId ( Aws::String &&  value)
inline

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

Definition at line 179 of file DBProxyTarget.h.

◆ WithTrackedClusterId() [2/3]

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithTrackedClusterId ( const Aws::String value)
inline

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

Definition at line 173 of file DBProxyTarget.h.

◆ WithTrackedClusterId() [3/3]

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithTrackedClusterId ( const char *  value)
inline

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

Definition at line 185 of file DBProxyTarget.h.

◆ WithType() [1/2]

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithType ( const TargetType value)
inline

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

Definition at line 290 of file DBProxyTarget.h.

◆ WithType() [2/2]

DBProxyTarget& Aws::RDS::Model::DBProxyTarget::WithType ( TargetType &&  value)
inline

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

Definition at line 296 of file DBProxyTarget.h.


The documentation for this class was generated from the following file: