@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DBProxy extends Object implements Serializable, Cloneable
The data structure representing a proxy managed by the RDS Proxy.
This data type is used as a response element in the DescribeDBProxies
action.
Constructor and Description |
---|
DBProxy() |
Modifier and Type | Method and Description |
---|---|
DBProxy |
clone() |
boolean |
equals(Object obj) |
List<UserAuthConfigInfo> |
getAuth()
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance
or Aurora DB cluster.
|
Date |
getCreatedDate()
The date and time when the proxy was first created.
|
String |
getDBProxyArn()
The Amazon Resource Name (ARN) for the proxy.
|
String |
getDBProxyName()
The identifier for the proxy.
|
Boolean |
getDebugLogging()
Indicates whether the proxy includes detailed information about SQL statements in its logs.
|
String |
getEndpoint()
The endpoint that you can use to connect to the DB proxy.
|
String |
getEngineFamily()
The kinds of databases that the proxy can connect to.
|
Integer |
getIdleClientTimeout()
The number of seconds a connection to the proxy can have no activity before the proxy drops the client
connection.
|
Boolean |
getRequireTLS()
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
|
String |
getRoleArn()
The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
|
String |
getStatus()
The current status of this proxy.
|
Date |
getUpdatedDate()
The date and time when the proxy was last updated.
|
String |
getVpcId()
Provides the VPC ID of the DB proxy.
|
List<String> |
getVpcSecurityGroupIds()
Provides a list of VPC security groups that the proxy belongs to.
|
List<String> |
getVpcSubnetIds()
The EC2 subnet IDs for the proxy.
|
int |
hashCode() |
Boolean |
isDebugLogging()
Indicates whether the proxy includes detailed information about SQL statements in its logs.
|
Boolean |
isRequireTLS()
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
|
void |
setAuth(Collection<UserAuthConfigInfo> auth)
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance
or Aurora DB cluster.
|
void |
setCreatedDate(Date createdDate)
The date and time when the proxy was first created.
|
void |
setDBProxyArn(String dBProxyArn)
The Amazon Resource Name (ARN) for the proxy.
|
void |
setDBProxyName(String dBProxyName)
The identifier for the proxy.
|
void |
setDebugLogging(Boolean debugLogging)
Indicates whether the proxy includes detailed information about SQL statements in its logs.
|
void |
setEndpoint(String endpoint)
The endpoint that you can use to connect to the DB proxy.
|
void |
setEngineFamily(String engineFamily)
The kinds of databases that the proxy can connect to.
|
void |
setIdleClientTimeout(Integer idleClientTimeout)
The number of seconds a connection to the proxy can have no activity before the proxy drops the client
connection.
|
void |
setRequireTLS(Boolean requireTLS)
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
|
void |
setRoleArn(String roleArn)
The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
|
void |
setStatus(String status)
The current status of this proxy.
|
void |
setUpdatedDate(Date updatedDate)
The date and time when the proxy was last updated.
|
void |
setVpcId(String vpcId)
Provides the VPC ID of the DB proxy.
|
void |
setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
Provides a list of VPC security groups that the proxy belongs to.
|
void |
setVpcSubnetIds(Collection<String> vpcSubnetIds)
The EC2 subnet IDs for the proxy.
|
String |
toString()
Returns a string representation of this object.
|
DBProxy |
withAuth(Collection<UserAuthConfigInfo> auth)
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance
or Aurora DB cluster.
|
DBProxy |
withAuth(UserAuthConfigInfo... auth)
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance
or Aurora DB cluster.
|
DBProxy |
withCreatedDate(Date createdDate)
The date and time when the proxy was first created.
|
DBProxy |
withDBProxyArn(String dBProxyArn)
The Amazon Resource Name (ARN) for the proxy.
|
DBProxy |
withDBProxyName(String dBProxyName)
The identifier for the proxy.
|
DBProxy |
withDebugLogging(Boolean debugLogging)
Indicates whether the proxy includes detailed information about SQL statements in its logs.
|
DBProxy |
withEndpoint(String endpoint)
The endpoint that you can use to connect to the DB proxy.
|
DBProxy |
withEngineFamily(String engineFamily)
The kinds of databases that the proxy can connect to.
|
DBProxy |
withIdleClientTimeout(Integer idleClientTimeout)
The number of seconds a connection to the proxy can have no activity before the proxy drops the client
connection.
|
DBProxy |
withRequireTLS(Boolean requireTLS)
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
|
DBProxy |
withRoleArn(String roleArn)
The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
|
DBProxy |
withStatus(DBProxyStatus status)
The current status of this proxy.
|
DBProxy |
withStatus(String status)
The current status of this proxy.
|
DBProxy |
withUpdatedDate(Date updatedDate)
The date and time when the proxy was last updated.
|
DBProxy |
withVpcId(String vpcId)
Provides the VPC ID of the DB proxy.
|
DBProxy |
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
Provides a list of VPC security groups that the proxy belongs to.
|
DBProxy |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
Provides a list of VPC security groups that the proxy belongs to.
|
DBProxy |
withVpcSubnetIds(Collection<String> vpcSubnetIds)
The EC2 subnet IDs for the proxy.
|
DBProxy |
withVpcSubnetIds(String... vpcSubnetIds)
The EC2 subnet IDs for the proxy.
|
public void setDBProxyName(String 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.
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.public String getDBProxyName()
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.
public DBProxy withDBProxyName(String 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.
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.public void setDBProxyArn(String dBProxyArn)
The Amazon Resource Name (ARN) for the proxy.
dBProxyArn
- The Amazon Resource Name (ARN) for the proxy.public String getDBProxyArn()
The Amazon Resource Name (ARN) for the proxy.
public DBProxy withDBProxyArn(String dBProxyArn)
The Amazon Resource Name (ARN) for the proxy.
dBProxyArn
- The Amazon Resource Name (ARN) for the proxy.public void setStatus(String status)
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.
status
- 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.DBProxyStatus
public String getStatus()
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.
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.DBProxyStatus
public DBProxy withStatus(String status)
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.
status
- 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.DBProxyStatus
public DBProxy withStatus(DBProxyStatus status)
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.
status
- 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.DBProxyStatus
public void setEngineFamily(String engineFamily)
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.
engineFamily
- 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.public String getEngineFamily()
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.
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.public DBProxy withEngineFamily(String engineFamily)
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.
engineFamily
- 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.public void setVpcId(String vpcId)
Provides the VPC ID of the DB proxy.
vpcId
- Provides the VPC ID of the DB proxy.public String getVpcId()
Provides the VPC ID of the DB proxy.
public DBProxy withVpcId(String vpcId)
Provides the VPC ID of the DB proxy.
vpcId
- Provides the VPC ID of the DB proxy.public List<String> getVpcSecurityGroupIds()
Provides a list of VPC security groups that the proxy belongs to.
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
Provides a list of VPC security groups that the proxy belongs to.
vpcSecurityGroupIds
- Provides a list of VPC security groups that the proxy belongs to.public DBProxy withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
Provides a list of VPC security groups that the proxy belongs to.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSecurityGroupIds(java.util.Collection)
or withVpcSecurityGroupIds(java.util.Collection)
if you want to override the existing values.
vpcSecurityGroupIds
- Provides a list of VPC security groups that the proxy belongs to.public DBProxy withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
Provides a list of VPC security groups that the proxy belongs to.
vpcSecurityGroupIds
- Provides a list of VPC security groups that the proxy belongs to.public List<String> getVpcSubnetIds()
The EC2 subnet IDs for the proxy.
public void setVpcSubnetIds(Collection<String> vpcSubnetIds)
The EC2 subnet IDs for the proxy.
vpcSubnetIds
- The EC2 subnet IDs for the proxy.public DBProxy withVpcSubnetIds(String... vpcSubnetIds)
The EC2 subnet IDs for the proxy.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSubnetIds(java.util.Collection)
or withVpcSubnetIds(java.util.Collection)
if you want to
override the existing values.
vpcSubnetIds
- The EC2 subnet IDs for the proxy.public DBProxy withVpcSubnetIds(Collection<String> vpcSubnetIds)
The EC2 subnet IDs for the proxy.
vpcSubnetIds
- The EC2 subnet IDs for the proxy.public List<UserAuthConfigInfo> getAuth()
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
public void setAuth(Collection<UserAuthConfigInfo> auth)
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
auth
- One or more data structures specifying the authorization mechanism to connect to the associated RDS DB
instance or Aurora DB cluster.public DBProxy withAuth(UserAuthConfigInfo... auth)
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
NOTE: This method appends the values to the existing list (if any). Use
setAuth(java.util.Collection)
or withAuth(java.util.Collection)
if you want to override the
existing values.
auth
- One or more data structures specifying the authorization mechanism to connect to the associated RDS DB
instance or Aurora DB cluster.public DBProxy withAuth(Collection<UserAuthConfigInfo> auth)
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
auth
- One or more data structures specifying the authorization mechanism to connect to the associated RDS DB
instance or Aurora DB cluster.public void setRoleArn(String roleArn)
The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
roleArn
- The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.public String getRoleArn()
The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
public DBProxy withRoleArn(String roleArn)
The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
roleArn
- The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.public void setEndpoint(String 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.
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.public String getEndpoint()
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.
public DBProxy withEndpoint(String 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.
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.public void setRequireTLS(Boolean requireTLS)
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
requireTLS
- Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.public Boolean getRequireTLS()
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
public DBProxy withRequireTLS(Boolean requireTLS)
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
requireTLS
- Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.public Boolean isRequireTLS()
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
public void setIdleClientTimeout(Integer 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
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
public Integer getIdleClientTimeout()
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
Default: 1800 (30 minutes)
Constraints: 1 to 28,800
public DBProxy withIdleClientTimeout(Integer 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
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
public void setDebugLogging(Boolean debugLogging)
Indicates 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.
debugLogging
- Indicates 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.public Boolean getDebugLogging()
Indicates 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.
public DBProxy withDebugLogging(Boolean debugLogging)
Indicates 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.
debugLogging
- Indicates 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.public Boolean isDebugLogging()
Indicates 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.
public void setCreatedDate(Date createdDate)
The date and time when the proxy was first created.
createdDate
- The date and time when the proxy was first created.public Date getCreatedDate()
The date and time when the proxy was first created.
public DBProxy withCreatedDate(Date createdDate)
The date and time when the proxy was first created.
createdDate
- The date and time when the proxy was first created.public void setUpdatedDate(Date updatedDate)
The date and time when the proxy was last updated.
updatedDate
- The date and time when the proxy was last updated.public Date getUpdatedDate()
The date and time when the proxy was last updated.
public DBProxy withUpdatedDate(Date updatedDate)
The date and time when the proxy was last updated.
updatedDate
- The date and time when the proxy was last updated.public String toString()
toString
in class Object
Object.toString()