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

#include <DBProxy.h>

Public Member Functions

 DBProxy ()
 
 DBProxy (const Aws::Utils::Xml::XmlNode &xmlNode)
 
DBProxyoperator= (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::StringGetDBProxyName () const
 
bool DBProxyNameHasBeenSet () const
 
void SetDBProxyName (const Aws::String &value)
 
void SetDBProxyName (Aws::String &&value)
 
void SetDBProxyName (const char *value)
 
DBProxyWithDBProxyName (const Aws::String &value)
 
DBProxyWithDBProxyName (Aws::String &&value)
 
DBProxyWithDBProxyName (const char *value)
 
const Aws::StringGetDBProxyArn () const
 
bool DBProxyArnHasBeenSet () const
 
void SetDBProxyArn (const Aws::String &value)
 
void SetDBProxyArn (Aws::String &&value)
 
void SetDBProxyArn (const char *value)
 
DBProxyWithDBProxyArn (const Aws::String &value)
 
DBProxyWithDBProxyArn (Aws::String &&value)
 
DBProxyWithDBProxyArn (const char *value)
 
const DBProxyStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const DBProxyStatus &value)
 
void SetStatus (DBProxyStatus &&value)
 
DBProxyWithStatus (const DBProxyStatus &value)
 
DBProxyWithStatus (DBProxyStatus &&value)
 
const Aws::StringGetEngineFamily () const
 
bool EngineFamilyHasBeenSet () const
 
void SetEngineFamily (const Aws::String &value)
 
void SetEngineFamily (Aws::String &&value)
 
void SetEngineFamily (const char *value)
 
DBProxyWithEngineFamily (const Aws::String &value)
 
DBProxyWithEngineFamily (Aws::String &&value)
 
DBProxyWithEngineFamily (const char *value)
 
const Aws::StringGetVpcId () const
 
bool VpcIdHasBeenSet () const
 
void SetVpcId (const Aws::String &value)
 
void SetVpcId (Aws::String &&value)
 
void SetVpcId (const char *value)
 
DBProxyWithVpcId (const Aws::String &value)
 
DBProxyWithVpcId (Aws::String &&value)
 
DBProxyWithVpcId (const char *value)
 
const Aws::Vector< Aws::String > & GetVpcSecurityGroupIds () const
 
bool VpcSecurityGroupIdsHasBeenSet () const
 
void SetVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
void SetVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
DBProxyWithVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
DBProxyWithVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
DBProxyAddVpcSecurityGroupIds (const Aws::String &value)
 
DBProxyAddVpcSecurityGroupIds (Aws::String &&value)
 
DBProxyAddVpcSecurityGroupIds (const char *value)
 
const Aws::Vector< Aws::String > & GetVpcSubnetIds () const
 
bool VpcSubnetIdsHasBeenSet () const
 
void SetVpcSubnetIds (const Aws::Vector< Aws::String > &value)
 
void SetVpcSubnetIds (Aws::Vector< Aws::String > &&value)
 
DBProxyWithVpcSubnetIds (const Aws::Vector< Aws::String > &value)
 
DBProxyWithVpcSubnetIds (Aws::Vector< Aws::String > &&value)
 
DBProxyAddVpcSubnetIds (const Aws::String &value)
 
DBProxyAddVpcSubnetIds (Aws::String &&value)
 
DBProxyAddVpcSubnetIds (const char *value)
 
const Aws::Vector< UserAuthConfigInfo > & GetAuth () const
 
bool AuthHasBeenSet () const
 
void SetAuth (const Aws::Vector< UserAuthConfigInfo > &value)
 
void SetAuth (Aws::Vector< UserAuthConfigInfo > &&value)
 
DBProxyWithAuth (const Aws::Vector< UserAuthConfigInfo > &value)
 
DBProxyWithAuth (Aws::Vector< UserAuthConfigInfo > &&value)
 
DBProxyAddAuth (const UserAuthConfigInfo &value)
 
DBProxyAddAuth (UserAuthConfigInfo &&value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
DBProxyWithRoleArn (const Aws::String &value)
 
DBProxyWithRoleArn (Aws::String &&value)
 
DBProxyWithRoleArn (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)
 
DBProxyWithEndpoint (const Aws::String &value)
 
DBProxyWithEndpoint (Aws::String &&value)
 
DBProxyWithEndpoint (const char *value)
 
bool GetRequireTLS () const
 
bool RequireTLSHasBeenSet () const
 
void SetRequireTLS (bool value)
 
DBProxyWithRequireTLS (bool value)
 
int GetIdleClientTimeout () const
 
bool IdleClientTimeoutHasBeenSet () const
 
void SetIdleClientTimeout (int value)
 
DBProxyWithIdleClientTimeout (int value)
 
bool GetDebugLogging () const
 
bool DebugLoggingHasBeenSet () const
 
void SetDebugLogging (bool value)
 
DBProxyWithDebugLogging (bool value)
 
const Aws::Utils::DateTimeGetCreatedDate () const
 
bool CreatedDateHasBeenSet () const
 
void SetCreatedDate (const Aws::Utils::DateTime &value)
 
void SetCreatedDate (Aws::Utils::DateTime &&value)
 
DBProxyWithCreatedDate (const Aws::Utils::DateTime &value)
 
DBProxyWithCreatedDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetUpdatedDate () const
 
bool UpdatedDateHasBeenSet () const
 
void SetUpdatedDate (const Aws::Utils::DateTime &value)
 
void SetUpdatedDate (Aws::Utils::DateTime &&value)
 
DBProxyWithUpdatedDate (const Aws::Utils::DateTime &value)
 
DBProxyWithUpdatedDate (Aws::Utils::DateTime &&value)
 

Detailed Description

The data structure representing a proxy managed by the RDS Proxy.

This data type is used as a response element in the DescribeDBProxies action.

See Also:

AWS API Reference

Definition at line 37 of file DBProxy.h.

Constructor & Destructor Documentation

◆ DBProxy() [1/2]

Aws::RDS::Model::DBProxy::DBProxy ( )

◆ DBProxy() [2/2]

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

Member Function Documentation

◆ AddAuth() [1/2]

DBProxy& Aws::RDS::Model::DBProxy::AddAuth ( const UserAuthConfigInfo value)
inline

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

Definition at line 403 of file DBProxy.h.

◆ AddAuth() [2/2]

DBProxy& Aws::RDS::Model::DBProxy::AddAuth ( UserAuthConfigInfo &&  value)
inline

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

Definition at line 409 of file DBProxy.h.

◆ AddVpcSecurityGroupIds() [1/3]

DBProxy& Aws::RDS::Model::DBProxy::AddVpcSecurityGroupIds ( Aws::String &&  value)
inline

Provides a list of VPC security groups that the proxy belongs to.

Definition at line 309 of file DBProxy.h.

◆ AddVpcSecurityGroupIds() [2/3]

DBProxy& Aws::RDS::Model::DBProxy::AddVpcSecurityGroupIds ( const Aws::String value)
inline

Provides a list of VPC security groups that the proxy belongs to.

Definition at line 304 of file DBProxy.h.

◆ AddVpcSecurityGroupIds() [3/3]

DBProxy& Aws::RDS::Model::DBProxy::AddVpcSecurityGroupIds ( const char *  value)
inline

Provides a list of VPC security groups that the proxy belongs to.

Definition at line 314 of file DBProxy.h.

◆ AddVpcSubnetIds() [1/3]

DBProxy& Aws::RDS::Model::DBProxy::AddVpcSubnetIds ( Aws::String &&  value)
inline

The EC2 subnet IDs for the proxy.

Definition at line 355 of file DBProxy.h.

◆ AddVpcSubnetIds() [2/3]

DBProxy& Aws::RDS::Model::DBProxy::AddVpcSubnetIds ( const Aws::String value)
inline

The EC2 subnet IDs for the proxy.

Definition at line 350 of file DBProxy.h.

◆ AddVpcSubnetIds() [3/3]

DBProxy& Aws::RDS::Model::DBProxy::AddVpcSubnetIds ( const char *  value)
inline

The EC2 subnet IDs for the proxy.

Definition at line 360 of file DBProxy.h.

◆ AuthHasBeenSet()

bool Aws::RDS::Model::DBProxy::AuthHasBeenSet ( ) const
inline

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

Definition at line 373 of file DBProxy.h.

◆ CreatedDateHasBeenSet()

bool Aws::RDS::Model::DBProxy::CreatedDateHasBeenSet ( ) const
inline

The date and time when the proxy was first created.

Definition at line 625 of file DBProxy.h.

◆ DBProxyArnHasBeenSet()

bool Aws::RDS::Model::DBProxy::DBProxyArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) for the proxy.

Definition at line 105 of file DBProxy.h.

◆ DBProxyNameHasBeenSet()

bool Aws::RDS::Model::DBProxy::DBProxyNameHasBeenSet ( ) const
inline

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

Definition at line 58 of file DBProxy.h.

◆ DebugLoggingHasBeenSet()

bool Aws::RDS::Model::DBProxy::DebugLoggingHasBeenSet ( ) const
inline

Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

Definition at line 592 of file DBProxy.h.

◆ EndpointHasBeenSet()

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

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

Definition at line 471 of file DBProxy.h.

◆ EngineFamilyHasBeenSet()

bool Aws::RDS::Model::DBProxy::EngineFamilyHasBeenSet ( ) const
inline

The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

Definition at line 191 of file DBProxy.h.

◆ GetAuth()

const Aws::Vector<UserAuthConfigInfo>& Aws::RDS::Model::DBProxy::GetAuth ( ) const
inline

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

Definition at line 367 of file DBProxy.h.

◆ GetCreatedDate()

const Aws::Utils::DateTime& Aws::RDS::Model::DBProxy::GetCreatedDate ( ) const
inline

The date and time when the proxy was first created.

Definition at line 620 of file DBProxy.h.

◆ GetDBProxyArn()

const Aws::String& Aws::RDS::Model::DBProxy::GetDBProxyArn ( ) const
inline

The Amazon Resource Name (ARN) for the proxy.

Definition at line 100 of file DBProxy.h.

◆ GetDBProxyName()

const Aws::String& Aws::RDS::Model::DBProxy::GetDBProxyName ( ) const
inline

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

Definition at line 52 of file DBProxy.h.

◆ GetDebugLogging()

bool Aws::RDS::Model::DBProxy::GetDebugLogging ( ) const
inline

Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

Definition at line 581 of file DBProxy.h.

◆ GetEndpoint()

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

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

Definition at line 465 of file DBProxy.h.

◆ GetEngineFamily()

const Aws::String& Aws::RDS::Model::DBProxy::GetEngineFamily ( ) const
inline

The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

Definition at line 185 of file DBProxy.h.

◆ GetIdleClientTimeout()

int Aws::RDS::Model::DBProxy::GetIdleClientTimeout ( ) const
inline

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.

Default: 1800 (30 minutes)

Constraints: 1 to 28,800

Definition at line 542 of file DBProxy.h.

◆ GetRequireTLS()

bool Aws::RDS::Model::DBProxy::GetRequireTLS ( ) const
inline

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

Definition at line 514 of file DBProxy.h.

◆ GetRoleArn()

const Aws::String& Aws::RDS::Model::DBProxy::GetRoleArn ( ) const
inline

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

Definition at line 416 of file DBProxy.h.

◆ GetStatus()

const DBProxyStatus& Aws::RDS::Model::DBProxy::GetStatus ( ) const
inline

The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

Definition at line 143 of file DBProxy.h.

◆ GetUpdatedDate()

const Aws::Utils::DateTime& Aws::RDS::Model::DBProxy::GetUpdatedDate ( ) const
inline

The date and time when the proxy was last updated.

Definition at line 651 of file DBProxy.h.

◆ GetVpcId()

const Aws::String& Aws::RDS::Model::DBProxy::GetVpcId ( ) const
inline

Provides the VPC ID of the DB proxy.

Definition at line 233 of file DBProxy.h.

◆ GetVpcSecurityGroupIds()

const Aws::Vector<Aws::String>& Aws::RDS::Model::DBProxy::GetVpcSecurityGroupIds ( ) const
inline

Provides a list of VPC security groups that the proxy belongs to.

Definition at line 274 of file DBProxy.h.

◆ GetVpcSubnetIds()

const Aws::Vector<Aws::String>& Aws::RDS::Model::DBProxy::GetVpcSubnetIds ( ) const
inline

The EC2 subnet IDs for the proxy.

Definition at line 320 of file DBProxy.h.

◆ IdleClientTimeoutHasBeenSet()

bool Aws::RDS::Model::DBProxy::IdleClientTimeoutHasBeenSet ( ) const
inline

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.

Default: 1800 (30 minutes)

Constraints: 1 to 28,800

Definition at line 551 of file DBProxy.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ RequireTLSHasBeenSet()

bool Aws::RDS::Model::DBProxy::RequireTLSHasBeenSet ( ) const
inline

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

Definition at line 520 of file DBProxy.h.

◆ RoleArnHasBeenSet()

bool Aws::RDS::Model::DBProxy::RoleArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

Definition at line 422 of file DBProxy.h.

◆ SetAuth() [1/2]

void Aws::RDS::Model::DBProxy::SetAuth ( Aws::Vector< UserAuthConfigInfo > &&  value)
inline

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

Definition at line 385 of file DBProxy.h.

◆ SetAuth() [2/2]

void Aws::RDS::Model::DBProxy::SetAuth ( const Aws::Vector< UserAuthConfigInfo > &  value)
inline

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

Definition at line 379 of file DBProxy.h.

◆ SetCreatedDate() [1/2]

void Aws::RDS::Model::DBProxy::SetCreatedDate ( Aws::Utils::DateTime &&  value)
inline

The date and time when the proxy was first created.

Definition at line 635 of file DBProxy.h.

◆ SetCreatedDate() [2/2]

void Aws::RDS::Model::DBProxy::SetCreatedDate ( const Aws::Utils::DateTime value)
inline

The date and time when the proxy was first created.

Definition at line 630 of file DBProxy.h.

◆ SetDBProxyArn() [1/3]

void Aws::RDS::Model::DBProxy::SetDBProxyArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the proxy.

Definition at line 115 of file DBProxy.h.

◆ SetDBProxyArn() [2/3]

void Aws::RDS::Model::DBProxy::SetDBProxyArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the proxy.

Definition at line 110 of file DBProxy.h.

◆ SetDBProxyArn() [3/3]

void Aws::RDS::Model::DBProxy::SetDBProxyArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for the proxy.

Definition at line 120 of file DBProxy.h.

◆ SetDBProxyName() [1/3]

void Aws::RDS::Model::DBProxy::SetDBProxyName ( Aws::String &&  value)
inline

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

Definition at line 70 of file DBProxy.h.

◆ SetDBProxyName() [2/3]

void Aws::RDS::Model::DBProxy::SetDBProxyName ( const Aws::String value)
inline

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

Definition at line 64 of file DBProxy.h.

◆ SetDBProxyName() [3/3]

void Aws::RDS::Model::DBProxy::SetDBProxyName ( const char *  value)
inline

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

Definition at line 76 of file DBProxy.h.

◆ SetDebugLogging()

void Aws::RDS::Model::DBProxy::SetDebugLogging ( bool  value)
inline

Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

Definition at line 603 of file DBProxy.h.

◆ SetEndpoint() [1/3]

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

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

Definition at line 483 of file DBProxy.h.

◆ SetEndpoint() [2/3]

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

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

Definition at line 477 of file DBProxy.h.

◆ SetEndpoint() [3/3]

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

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

Definition at line 489 of file DBProxy.h.

◆ SetEngineFamily() [1/3]

void Aws::RDS::Model::DBProxy::SetEngineFamily ( Aws::String &&  value)
inline

The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

Definition at line 203 of file DBProxy.h.

◆ SetEngineFamily() [2/3]

void Aws::RDS::Model::DBProxy::SetEngineFamily ( const Aws::String value)
inline

The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

Definition at line 197 of file DBProxy.h.

◆ SetEngineFamily() [3/3]

void Aws::RDS::Model::DBProxy::SetEngineFamily ( const char *  value)
inline

The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

Definition at line 209 of file DBProxy.h.

◆ SetIdleClientTimeout()

void Aws::RDS::Model::DBProxy::SetIdleClientTimeout ( int  value)
inline

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.

Default: 1800 (30 minutes)

Constraints: 1 to 28,800

Definition at line 560 of file DBProxy.h.

◆ SetRequireTLS()

void Aws::RDS::Model::DBProxy::SetRequireTLS ( bool  value)
inline

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

Definition at line 526 of file DBProxy.h.

◆ SetRoleArn() [1/3]

void Aws::RDS::Model::DBProxy::SetRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

Definition at line 434 of file DBProxy.h.

◆ SetRoleArn() [2/3]

void Aws::RDS::Model::DBProxy::SetRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

Definition at line 428 of file DBProxy.h.

◆ SetRoleArn() [3/3]

void Aws::RDS::Model::DBProxy::SetRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

Definition at line 440 of file DBProxy.h.

◆ SetStatus() [1/2]

void Aws::RDS::Model::DBProxy::SetStatus ( const DBProxyStatus value)
inline

The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

Definition at line 157 of file DBProxy.h.

◆ SetStatus() [2/2]

void Aws::RDS::Model::DBProxy::SetStatus ( DBProxyStatus &&  value)
inline

The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

Definition at line 164 of file DBProxy.h.

◆ SetUpdatedDate() [1/2]

void Aws::RDS::Model::DBProxy::SetUpdatedDate ( Aws::Utils::DateTime &&  value)
inline

The date and time when the proxy was last updated.

Definition at line 666 of file DBProxy.h.

◆ SetUpdatedDate() [2/2]

void Aws::RDS::Model::DBProxy::SetUpdatedDate ( const Aws::Utils::DateTime value)
inline

The date and time when the proxy was last updated.

Definition at line 661 of file DBProxy.h.

◆ SetVpcId() [1/3]

void Aws::RDS::Model::DBProxy::SetVpcId ( Aws::String &&  value)
inline

Provides the VPC ID of the DB proxy.

Definition at line 248 of file DBProxy.h.

◆ SetVpcId() [2/3]

void Aws::RDS::Model::DBProxy::SetVpcId ( const Aws::String value)
inline

Provides the VPC ID of the DB proxy.

Definition at line 243 of file DBProxy.h.

◆ SetVpcId() [3/3]

void Aws::RDS::Model::DBProxy::SetVpcId ( const char *  value)
inline

Provides the VPC ID of the DB proxy.

Definition at line 253 of file DBProxy.h.

◆ SetVpcSecurityGroupIds() [1/2]

void Aws::RDS::Model::DBProxy::SetVpcSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

Provides a list of VPC security groups that the proxy belongs to.

Definition at line 289 of file DBProxy.h.

◆ SetVpcSecurityGroupIds() [2/2]

void Aws::RDS::Model::DBProxy::SetVpcSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

Provides a list of VPC security groups that the proxy belongs to.

Definition at line 284 of file DBProxy.h.

◆ SetVpcSubnetIds() [1/2]

void Aws::RDS::Model::DBProxy::SetVpcSubnetIds ( Aws::Vector< Aws::String > &&  value)
inline

The EC2 subnet IDs for the proxy.

Definition at line 335 of file DBProxy.h.

◆ SetVpcSubnetIds() [2/2]

void Aws::RDS::Model::DBProxy::SetVpcSubnetIds ( const Aws::Vector< Aws::String > &  value)
inline

The EC2 subnet IDs for the proxy.

Definition at line 330 of file DBProxy.h.

◆ StatusHasBeenSet()

bool Aws::RDS::Model::DBProxy::StatusHasBeenSet ( ) const
inline

The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

Definition at line 150 of file DBProxy.h.

◆ UpdatedDateHasBeenSet()

bool Aws::RDS::Model::DBProxy::UpdatedDateHasBeenSet ( ) const
inline

The date and time when the proxy was last updated.

Definition at line 656 of file DBProxy.h.

◆ VpcIdHasBeenSet()

bool Aws::RDS::Model::DBProxy::VpcIdHasBeenSet ( ) const
inline

Provides the VPC ID of the DB proxy.

Definition at line 238 of file DBProxy.h.

◆ VpcSecurityGroupIdsHasBeenSet()

bool Aws::RDS::Model::DBProxy::VpcSecurityGroupIdsHasBeenSet ( ) const
inline

Provides a list of VPC security groups that the proxy belongs to.

Definition at line 279 of file DBProxy.h.

◆ VpcSubnetIdsHasBeenSet()

bool Aws::RDS::Model::DBProxy::VpcSubnetIdsHasBeenSet ( ) const
inline

The EC2 subnet IDs for the proxy.

Definition at line 325 of file DBProxy.h.

◆ WithAuth() [1/2]

DBProxy& Aws::RDS::Model::DBProxy::WithAuth ( Aws::Vector< UserAuthConfigInfo > &&  value)
inline

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

Definition at line 397 of file DBProxy.h.

◆ WithAuth() [2/2]

DBProxy& Aws::RDS::Model::DBProxy::WithAuth ( const Aws::Vector< UserAuthConfigInfo > &  value)
inline

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

Definition at line 391 of file DBProxy.h.

◆ WithCreatedDate() [1/2]

DBProxy& Aws::RDS::Model::DBProxy::WithCreatedDate ( Aws::Utils::DateTime &&  value)
inline

The date and time when the proxy was first created.

Definition at line 645 of file DBProxy.h.

◆ WithCreatedDate() [2/2]

DBProxy& Aws::RDS::Model::DBProxy::WithCreatedDate ( const Aws::Utils::DateTime value)
inline

The date and time when the proxy was first created.

Definition at line 640 of file DBProxy.h.

◆ WithDBProxyArn() [1/3]

DBProxy& Aws::RDS::Model::DBProxy::WithDBProxyArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the proxy.

Definition at line 130 of file DBProxy.h.

◆ WithDBProxyArn() [2/3]

DBProxy& Aws::RDS::Model::DBProxy::WithDBProxyArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the proxy.

Definition at line 125 of file DBProxy.h.

◆ WithDBProxyArn() [3/3]

DBProxy& Aws::RDS::Model::DBProxy::WithDBProxyArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for the proxy.

Definition at line 135 of file DBProxy.h.

◆ WithDBProxyName() [1/3]

DBProxy& Aws::RDS::Model::DBProxy::WithDBProxyName ( Aws::String &&  value)
inline

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

Definition at line 88 of file DBProxy.h.

◆ WithDBProxyName() [2/3]

DBProxy& Aws::RDS::Model::DBProxy::WithDBProxyName ( const Aws::String value)
inline

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

Definition at line 82 of file DBProxy.h.

◆ WithDBProxyName() [3/3]

DBProxy& Aws::RDS::Model::DBProxy::WithDBProxyName ( const char *  value)
inline

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

Definition at line 94 of file DBProxy.h.

◆ WithDebugLogging()

DBProxy& Aws::RDS::Model::DBProxy::WithDebugLogging ( bool  value)
inline

Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

Definition at line 614 of file DBProxy.h.

◆ WithEndpoint() [1/3]

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

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

Definition at line 501 of file DBProxy.h.

◆ WithEndpoint() [2/3]

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

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

Definition at line 495 of file DBProxy.h.

◆ WithEndpoint() [3/3]

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

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

Definition at line 507 of file DBProxy.h.

◆ WithEngineFamily() [1/3]

DBProxy& Aws::RDS::Model::DBProxy::WithEngineFamily ( Aws::String &&  value)
inline

The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

Definition at line 221 of file DBProxy.h.

◆ WithEngineFamily() [2/3]

DBProxy& Aws::RDS::Model::DBProxy::WithEngineFamily ( const Aws::String value)
inline

The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

Definition at line 215 of file DBProxy.h.

◆ WithEngineFamily() [3/3]

DBProxy& Aws::RDS::Model::DBProxy::WithEngineFamily ( const char *  value)
inline

The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

Definition at line 227 of file DBProxy.h.

◆ WithIdleClientTimeout()

DBProxy& Aws::RDS::Model::DBProxy::WithIdleClientTimeout ( int  value)
inline

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.

Default: 1800 (30 minutes)

Constraints: 1 to 28,800

Definition at line 569 of file DBProxy.h.

◆ WithRequireTLS()

DBProxy& Aws::RDS::Model::DBProxy::WithRequireTLS ( bool  value)
inline

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

Definition at line 532 of file DBProxy.h.

◆ WithRoleArn() [1/3]

DBProxy& Aws::RDS::Model::DBProxy::WithRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

Definition at line 452 of file DBProxy.h.

◆ WithRoleArn() [2/3]

DBProxy& Aws::RDS::Model::DBProxy::WithRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

Definition at line 446 of file DBProxy.h.

◆ WithRoleArn() [3/3]

DBProxy& Aws::RDS::Model::DBProxy::WithRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

Definition at line 458 of file DBProxy.h.

◆ WithStatus() [1/2]

DBProxy& Aws::RDS::Model::DBProxy::WithStatus ( const DBProxyStatus value)
inline

The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

Definition at line 171 of file DBProxy.h.

◆ WithStatus() [2/2]

DBProxy& Aws::RDS::Model::DBProxy::WithStatus ( DBProxyStatus &&  value)
inline

The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

Definition at line 178 of file DBProxy.h.

◆ WithUpdatedDate() [1/2]

DBProxy& Aws::RDS::Model::DBProxy::WithUpdatedDate ( Aws::Utils::DateTime &&  value)
inline

The date and time when the proxy was last updated.

Definition at line 676 of file DBProxy.h.

◆ WithUpdatedDate() [2/2]

DBProxy& Aws::RDS::Model::DBProxy::WithUpdatedDate ( const Aws::Utils::DateTime value)
inline

The date and time when the proxy was last updated.

Definition at line 671 of file DBProxy.h.

◆ WithVpcId() [1/3]

DBProxy& Aws::RDS::Model::DBProxy::WithVpcId ( Aws::String &&  value)
inline

Provides the VPC ID of the DB proxy.

Definition at line 263 of file DBProxy.h.

◆ WithVpcId() [2/3]

DBProxy& Aws::RDS::Model::DBProxy::WithVpcId ( const Aws::String value)
inline

Provides the VPC ID of the DB proxy.

Definition at line 258 of file DBProxy.h.

◆ WithVpcId() [3/3]

DBProxy& Aws::RDS::Model::DBProxy::WithVpcId ( const char *  value)
inline

Provides the VPC ID of the DB proxy.

Definition at line 268 of file DBProxy.h.

◆ WithVpcSecurityGroupIds() [1/2]

DBProxy& Aws::RDS::Model::DBProxy::WithVpcSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

Provides a list of VPC security groups that the proxy belongs to.

Definition at line 299 of file DBProxy.h.

◆ WithVpcSecurityGroupIds() [2/2]

DBProxy& Aws::RDS::Model::DBProxy::WithVpcSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

Provides a list of VPC security groups that the proxy belongs to.

Definition at line 294 of file DBProxy.h.

◆ WithVpcSubnetIds() [1/2]

DBProxy& Aws::RDS::Model::DBProxy::WithVpcSubnetIds ( Aws::Vector< Aws::String > &&  value)
inline

The EC2 subnet IDs for the proxy.

Definition at line 345 of file DBProxy.h.

◆ WithVpcSubnetIds() [2/2]

DBProxy& Aws::RDS::Model::DBProxy::WithVpcSubnetIds ( const Aws::Vector< Aws::String > &  value)
inline

The EC2 subnet IDs for the proxy.

Definition at line 340 of file DBProxy.h.


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