/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include 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
The identifier for the proxy. This name must be unique for all proxies owned * by your Amazon Web Services account in the specified Amazon Web Services * Region.
*/ inline const Aws::String& GetDBProxyName() const{ return m_dBProxyName; } /** *The identifier for the proxy. This name must be unique for all proxies owned * by your Amazon Web Services account in the specified Amazon Web Services * Region.
*/ inline bool DBProxyNameHasBeenSet() const { return m_dBProxyNameHasBeenSet; } /** *The identifier for the proxy. This name must be unique for all proxies owned * by your Amazon Web Services account in the specified Amazon Web Services * Region.
*/ inline void SetDBProxyName(const Aws::String& value) { m_dBProxyNameHasBeenSet = true; m_dBProxyName = value; } /** *The identifier for the proxy. This name must be unique for all proxies owned * by your Amazon Web Services account in the specified Amazon Web Services * Region.
*/ inline void SetDBProxyName(Aws::String&& value) { m_dBProxyNameHasBeenSet = true; m_dBProxyName = std::move(value); } /** *The identifier for the proxy. This name must be unique for all proxies owned * by your Amazon Web Services account in the specified Amazon Web Services * Region.
*/ inline void SetDBProxyName(const char* value) { m_dBProxyNameHasBeenSet = true; m_dBProxyName.assign(value); } /** *The identifier for the proxy. This name must be unique for all proxies owned * by your Amazon Web Services account in the specified Amazon Web Services * Region.
*/ inline DBProxy& WithDBProxyName(const Aws::String& value) { SetDBProxyName(value); return *this;} /** *The identifier for the proxy. This name must be unique for all proxies owned * by your Amazon Web Services account in the specified Amazon Web Services * Region.
*/ inline DBProxy& WithDBProxyName(Aws::String&& value) { SetDBProxyName(std::move(value)); return *this;} /** *The identifier for the proxy. This name must be unique for all proxies owned * by your Amazon Web Services account in the specified Amazon Web Services * Region.
*/ inline DBProxy& WithDBProxyName(const char* value) { SetDBProxyName(value); return *this;} /** *The Amazon Resource Name (ARN) for the proxy.
*/ inline const Aws::String& GetDBProxyArn() const{ return m_dBProxyArn; } /** *The Amazon Resource Name (ARN) for the proxy.
*/ inline bool DBProxyArnHasBeenSet() const { return m_dBProxyArnHasBeenSet; } /** *The Amazon Resource Name (ARN) for the proxy.
*/ inline void SetDBProxyArn(const Aws::String& value) { m_dBProxyArnHasBeenSet = true; m_dBProxyArn = value; } /** *The Amazon Resource Name (ARN) for the proxy.
*/ inline void SetDBProxyArn(Aws::String&& value) { m_dBProxyArnHasBeenSet = true; m_dBProxyArn = std::move(value); } /** *The Amazon Resource Name (ARN) for the proxy.
*/ inline void SetDBProxyArn(const char* value) { m_dBProxyArnHasBeenSet = true; m_dBProxyArn.assign(value); } /** *The Amazon Resource Name (ARN) for the proxy.
*/ inline DBProxy& WithDBProxyArn(const Aws::String& value) { SetDBProxyArn(value); return *this;} /** *The Amazon Resource Name (ARN) for the proxy.
*/ inline DBProxy& WithDBProxyArn(Aws::String&& value) { SetDBProxyArn(std::move(value)); return *this;} /** *The Amazon Resource Name (ARN) for the proxy.
*/ inline DBProxy& WithDBProxyArn(const char* value) { SetDBProxyArn(value); return *this;} /** *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.
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.
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.
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.
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.
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.
The kinds of databases that the proxy can connect to. This value determines
* which database network protocol the proxy recognizes when it interprets network
* traffic to and from the database. MYSQL
supports Aurora MySQL, RDS
* for MariaDB, and RDS for MySQL databases. POSTGRESQL
supports
* Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER
* supports RDS for Microsoft SQL Server databases.
The kinds of databases that the proxy can connect to. This value determines
* which database network protocol the proxy recognizes when it interprets network
* traffic to and from the database. MYSQL
supports Aurora MySQL, RDS
* for MariaDB, and RDS for MySQL databases. POSTGRESQL
supports
* Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER
* supports RDS for Microsoft SQL Server databases.
The kinds of databases that the proxy can connect to. This value determines
* which database network protocol the proxy recognizes when it interprets network
* traffic to and from the database. MYSQL
supports Aurora MySQL, RDS
* for MariaDB, and RDS for MySQL databases. POSTGRESQL
supports
* Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER
* supports RDS for Microsoft SQL Server databases.
The kinds of databases that the proxy can connect to. This value determines
* which database network protocol the proxy recognizes when it interprets network
* traffic to and from the database. MYSQL
supports Aurora MySQL, RDS
* for MariaDB, and RDS for MySQL databases. POSTGRESQL
supports
* Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER
* supports RDS for Microsoft SQL Server databases.
The kinds of databases that the proxy can connect to. This value determines
* which database network protocol the proxy recognizes when it interprets network
* traffic to and from the database. MYSQL
supports Aurora MySQL, RDS
* for MariaDB, and RDS for MySQL databases. POSTGRESQL
supports
* Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER
* supports RDS for Microsoft SQL Server databases.
The kinds of databases that the proxy can connect to. This value determines
* which database network protocol the proxy recognizes when it interprets network
* traffic to and from the database. MYSQL
supports Aurora MySQL, RDS
* for MariaDB, and RDS for MySQL databases. POSTGRESQL
supports
* Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER
* supports RDS for Microsoft SQL Server databases.
The kinds of databases that the proxy can connect to. This value determines
* which database network protocol the proxy recognizes when it interprets network
* traffic to and from the database. MYSQL
supports Aurora MySQL, RDS
* for MariaDB, and RDS for MySQL databases. POSTGRESQL
supports
* Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER
* supports RDS for Microsoft SQL Server databases.
The kinds of databases that the proxy can connect to. This value determines
* which database network protocol the proxy recognizes when it interprets network
* traffic to and from the database. MYSQL
supports Aurora MySQL, RDS
* for MariaDB, and RDS for MySQL databases. POSTGRESQL
supports
* Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER
* supports RDS for Microsoft SQL Server databases.
Provides the VPC ID of the DB proxy.
*/ inline const Aws::String& GetVpcId() const{ return m_vpcId; } /** *Provides the VPC ID of the DB proxy.
*/ inline bool VpcIdHasBeenSet() const { return m_vpcIdHasBeenSet; } /** *Provides the VPC ID of the DB proxy.
*/ inline void SetVpcId(const Aws::String& value) { m_vpcIdHasBeenSet = true; m_vpcId = value; } /** *Provides the VPC ID of the DB proxy.
*/ inline void SetVpcId(Aws::String&& value) { m_vpcIdHasBeenSet = true; m_vpcId = std::move(value); } /** *Provides the VPC ID of the DB proxy.
*/ inline void SetVpcId(const char* value) { m_vpcIdHasBeenSet = true; m_vpcId.assign(value); } /** *Provides the VPC ID of the DB proxy.
*/ inline DBProxy& WithVpcId(const Aws::String& value) { SetVpcId(value); return *this;} /** *Provides the VPC ID of the DB proxy.
*/ inline DBProxy& WithVpcId(Aws::String&& value) { SetVpcId(std::move(value)); return *this;} /** *Provides the VPC ID of the DB proxy.
*/ inline DBProxy& WithVpcId(const char* value) { SetVpcId(value); return *this;} /** *Provides a list of VPC security groups that the proxy belongs to.
*/ inline const Aws::VectorProvides a list of VPC security groups that the proxy belongs to.
*/ inline bool VpcSecurityGroupIdsHasBeenSet() const { return m_vpcSecurityGroupIdsHasBeenSet; } /** *Provides a list of VPC security groups that the proxy belongs to.
*/ inline void SetVpcSecurityGroupIds(const Aws::VectorProvides a list of VPC security groups that the proxy belongs to.
*/ inline void SetVpcSecurityGroupIds(Aws::VectorProvides a list of VPC security groups that the proxy belongs to.
*/ inline DBProxy& WithVpcSecurityGroupIds(const Aws::VectorProvides a list of VPC security groups that the proxy belongs to.
*/ inline DBProxy& WithVpcSecurityGroupIds(Aws::VectorProvides a list of VPC security groups that the proxy belongs to.
*/ inline DBProxy& AddVpcSecurityGroupIds(const Aws::String& value) { m_vpcSecurityGroupIdsHasBeenSet = true; m_vpcSecurityGroupIds.push_back(value); return *this; } /** *Provides a list of VPC security groups that the proxy belongs to.
*/ inline DBProxy& AddVpcSecurityGroupIds(Aws::String&& value) { m_vpcSecurityGroupIdsHasBeenSet = true; m_vpcSecurityGroupIds.push_back(std::move(value)); return *this; } /** *Provides a list of VPC security groups that the proxy belongs to.
*/ inline DBProxy& AddVpcSecurityGroupIds(const char* value) { m_vpcSecurityGroupIdsHasBeenSet = true; m_vpcSecurityGroupIds.push_back(value); return *this; } /** *The EC2 subnet IDs for the proxy.
*/ inline const Aws::VectorThe EC2 subnet IDs for the proxy.
*/ inline bool VpcSubnetIdsHasBeenSet() const { return m_vpcSubnetIdsHasBeenSet; } /** *The EC2 subnet IDs for the proxy.
*/ inline void SetVpcSubnetIds(const Aws::VectorThe EC2 subnet IDs for the proxy.
*/ inline void SetVpcSubnetIds(Aws::VectorThe EC2 subnet IDs for the proxy.
*/ inline DBProxy& WithVpcSubnetIds(const Aws::VectorThe EC2 subnet IDs for the proxy.
*/ inline DBProxy& WithVpcSubnetIds(Aws::VectorThe EC2 subnet IDs for the proxy.
*/ inline DBProxy& AddVpcSubnetIds(const Aws::String& value) { m_vpcSubnetIdsHasBeenSet = true; m_vpcSubnetIds.push_back(value); return *this; } /** *The EC2 subnet IDs for the proxy.
*/ inline DBProxy& AddVpcSubnetIds(Aws::String&& value) { m_vpcSubnetIdsHasBeenSet = true; m_vpcSubnetIds.push_back(std::move(value)); return *this; } /** *The EC2 subnet IDs for the proxy.
*/ inline DBProxy& AddVpcSubnetIds(const char* value) { m_vpcSubnetIdsHasBeenSet = true; m_vpcSubnetIds.push_back(value); return *this; } /** *One or more data structures specifying the authorization mechanism to connect * to the associated RDS DB instance or Aurora DB cluster.
*/ inline const Aws::VectorOne or more data structures specifying the authorization mechanism to connect * to the associated RDS DB instance or Aurora DB cluster.
*/ inline bool AuthHasBeenSet() const { return m_authHasBeenSet; } /** *One or more data structures specifying the authorization mechanism to connect * to the associated RDS DB instance or Aurora DB cluster.
*/ inline void SetAuth(const Aws::VectorOne or more data structures specifying the authorization mechanism to connect * to the associated RDS DB instance or Aurora DB cluster.
*/ inline void SetAuth(Aws::VectorOne or more data structures specifying the authorization mechanism to connect * to the associated RDS DB instance or Aurora DB cluster.
*/ inline DBProxy& WithAuth(const Aws::VectorOne or more data structures specifying the authorization mechanism to connect * to the associated RDS DB instance or Aurora DB cluster.
*/ inline DBProxy& WithAuth(Aws::VectorOne or more data structures specifying the authorization mechanism to connect * to the associated RDS DB instance or Aurora DB cluster.
*/ inline DBProxy& AddAuth(const UserAuthConfigInfo& value) { m_authHasBeenSet = true; m_auth.push_back(value); return *this; } /** *One or more data structures specifying the authorization mechanism to connect * to the associated RDS DB instance or Aurora DB cluster.
*/ inline DBProxy& AddAuth(UserAuthConfigInfo&& value) { m_authHasBeenSet = true; m_auth.push_back(std::move(value)); return *this; } /** *The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access * Amazon Secrets Manager.
*/ inline const Aws::String& GetRoleArn() const{ return m_roleArn; } /** *The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access * Amazon Secrets Manager.
*/ inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; } /** *The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access * Amazon Secrets Manager.
*/ inline void SetRoleArn(const Aws::String& value) { m_roleArnHasBeenSet = true; m_roleArn = value; } /** *The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access * Amazon Secrets Manager.
*/ inline void SetRoleArn(Aws::String&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::move(value); } /** *The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access * Amazon Secrets Manager.
*/ inline void SetRoleArn(const char* value) { m_roleArnHasBeenSet = true; m_roleArn.assign(value); } /** *The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access * Amazon Secrets Manager.
*/ inline DBProxy& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;} /** *The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access * Amazon Secrets Manager.
*/ inline DBProxy& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;} /** *The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access * Amazon Secrets Manager.
*/ inline DBProxy& WithRoleArn(const char* value) { SetRoleArn(value); return *this;} /** *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.
*/ inline const Aws::String& GetEndpoint() const{ return m_endpoint; } /** *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.
*/ inline bool EndpointHasBeenSet() const { return m_endpointHasBeenSet; } /** *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.
*/ inline void SetEndpoint(const Aws::String& value) { m_endpointHasBeenSet = true; m_endpoint = value; } /** *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.
*/ inline void SetEndpoint(Aws::String&& value) { m_endpointHasBeenSet = true; m_endpoint = std::move(value); } /** *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.
*/ inline void SetEndpoint(const char* value) { m_endpointHasBeenSet = true; m_endpoint.assign(value); } /** *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.
*/ inline DBProxy& WithEndpoint(const Aws::String& value) { SetEndpoint(value); return *this;} /** *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.
*/ inline DBProxy& WithEndpoint(Aws::String&& value) { SetEndpoint(std::move(value)); return *this;} /** *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.
*/ inline DBProxy& WithEndpoint(const char* value) { SetEndpoint(value); return *this;} /** *Indicates whether Transport Layer Security (TLS) encryption is required for * connections to the proxy.
*/ inline bool GetRequireTLS() const{ return m_requireTLS; } /** *Indicates whether Transport Layer Security (TLS) encryption is required for * connections to the proxy.
*/ inline bool RequireTLSHasBeenSet() const { return m_requireTLSHasBeenSet; } /** *Indicates whether Transport Layer Security (TLS) encryption is required for * connections to the proxy.
*/ inline void SetRequireTLS(bool value) { m_requireTLSHasBeenSet = true; m_requireTLS = value; } /** *Indicates whether Transport Layer Security (TLS) encryption is required for * connections to the proxy.
*/ inline DBProxy& WithRequireTLS(bool value) { SetRequireTLS(value); return *this;} /** *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
*/ inline int GetIdleClientTimeout() const{ return m_idleClientTimeout; } /** *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
*/ inline bool IdleClientTimeoutHasBeenSet() const { return m_idleClientTimeoutHasBeenSet; } /** *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
*/ inline void SetIdleClientTimeout(int value) { m_idleClientTimeoutHasBeenSet = true; m_idleClientTimeout = value; } /** *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
*/ inline DBProxy& WithIdleClientTimeout(int value) { SetIdleClientTimeout(value); return *this;} /** *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.
*/ inline bool GetDebugLogging() const{ return m_debugLogging; } /** *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.
*/ inline bool DebugLoggingHasBeenSet() const { return m_debugLoggingHasBeenSet; } /** *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.
*/ inline void SetDebugLogging(bool value) { m_debugLoggingHasBeenSet = true; m_debugLogging = value; } /** *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.
*/ inline DBProxy& WithDebugLogging(bool value) { SetDebugLogging(value); return *this;} /** *The date and time when the proxy was first created.
*/ inline const Aws::Utils::DateTime& GetCreatedDate() const{ return m_createdDate; } /** *The date and time when the proxy was first created.
*/ inline bool CreatedDateHasBeenSet() const { return m_createdDateHasBeenSet; } /** *The date and time when the proxy was first created.
*/ inline void SetCreatedDate(const Aws::Utils::DateTime& value) { m_createdDateHasBeenSet = true; m_createdDate = value; } /** *The date and time when the proxy was first created.
*/ inline void SetCreatedDate(Aws::Utils::DateTime&& value) { m_createdDateHasBeenSet = true; m_createdDate = std::move(value); } /** *The date and time when the proxy was first created.
*/ inline DBProxy& WithCreatedDate(const Aws::Utils::DateTime& value) { SetCreatedDate(value); return *this;} /** *The date and time when the proxy was first created.
*/ inline DBProxy& WithCreatedDate(Aws::Utils::DateTime&& value) { SetCreatedDate(std::move(value)); return *this;} /** *The date and time when the proxy was last updated.
*/ inline const Aws::Utils::DateTime& GetUpdatedDate() const{ return m_updatedDate; } /** *The date and time when the proxy was last updated.
*/ inline bool UpdatedDateHasBeenSet() const { return m_updatedDateHasBeenSet; } /** *The date and time when the proxy was last updated.
*/ inline void SetUpdatedDate(const Aws::Utils::DateTime& value) { m_updatedDateHasBeenSet = true; m_updatedDate = value; } /** *The date and time when the proxy was last updated.
*/ inline void SetUpdatedDate(Aws::Utils::DateTime&& value) { m_updatedDateHasBeenSet = true; m_updatedDate = std::move(value); } /** *The date and time when the proxy was last updated.
*/ inline DBProxy& WithUpdatedDate(const Aws::Utils::DateTime& value) { SetUpdatedDate(value); return *this;} /** *The date and time when the proxy was last updated.
*/ inline DBProxy& WithUpdatedDate(Aws::Utils::DateTime&& value) { SetUpdatedDate(std::move(value)); return *this;} private: Aws::String m_dBProxyName; bool m_dBProxyNameHasBeenSet = false; Aws::String m_dBProxyArn; bool m_dBProxyArnHasBeenSet = false; DBProxyStatus m_status; bool m_statusHasBeenSet = false; Aws::String m_engineFamily; bool m_engineFamilyHasBeenSet = false; Aws::String m_vpcId; bool m_vpcIdHasBeenSet = false; Aws::Vector