/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.rds.model; import java.io.Serializable; import javax.annotation.Generated; /** *

* Specifies the settings that control the size and behavior of the connection pool associated with a * DBProxyTargetGroup. *

* * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ConnectionPoolConfiguration implements Serializable, Cloneable { /** *

* The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage * of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target * group. *

*

* If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter. *

*

* Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines *

*

* Constraints: Must be between 1 and 100. *

*/ private Integer maxConnectionsPercent; /** *

* Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed * as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by * the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low * value causes the proxy to close more idle connections and return them to the database. *

*

* If you specify this parameter, then you must also include a value for MaxConnectionsPercent. *

*

* Default: The default value is half of the value of MaxConnectionsPercent. For example, if * MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent is 40. * If the value of MaxConnectionsPercent isn't specified, then for SQL Server, * MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50. *

*

* Constraints: Must be between 0 and the value of MaxConnectionsPercent. *

*/ private Integer maxIdleConnectionsPercent; /** *

* The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only * applies when the proxy has opened its maximum number of connections and all connections are busy with client * sessions. *

*

* Default: 120 *

*

* Constraints: between 1 and 3600, or 0 representing unlimited *

*/ private Integer connectionBorrowTimeout; /** *

* Each item in the list represents a class of SQL operations that normally cause all later statements in a session * using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that * class of SQL operations from the pinning behavior. *

*

* Default: no session pinning filters *

*/ private com.amazonaws.internal.SdkInternalList sessionPinningFilters; /** *

* One or more SQL statements for the proxy to run when opening each new database connection. Typically used with * SET statements to make sure that each connection has identical settings such as time zone and * character set. For multiple statements, use semicolons as the separator. You can also include multiple variables * in a single SET statement, such as SET x=1, y=2. *

*

* Default: no initialization query *

*/ private String initQuery; /** *

* The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage * of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target * group. *

*

* If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter. *

*

* Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines *

*

* Constraints: Must be between 1 and 100. *

* * @param maxConnectionsPercent * The maximum size of the connection pool for each target in a target group. The value is expressed as a * percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used * by the target group.

*

* If you specify MaxIdleConnectionsPercent, then you must also include a value for this * parameter. *

*

* Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines *

*

* Constraints: Must be between 1 and 100. */ public void setMaxConnectionsPercent(Integer maxConnectionsPercent) { this.maxConnectionsPercent = maxConnectionsPercent; } /** *

* The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage * of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target * group. *

*

* If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter. *

*

* Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines *

*

* Constraints: Must be between 1 and 100. *

* * @return The maximum size of the connection pool for each target in a target group. The value is expressed as a * percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used * by the target group.

*

* If you specify MaxIdleConnectionsPercent, then you must also include a value for this * parameter. *

*

* Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines *

*

* Constraints: Must be between 1 and 100. */ public Integer getMaxConnectionsPercent() { return this.maxConnectionsPercent; } /** *

* The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage * of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target * group. *

*

* If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter. *

*

* Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines *

*

* Constraints: Must be between 1 and 100. *

* * @param maxConnectionsPercent * The maximum size of the connection pool for each target in a target group. The value is expressed as a * percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used * by the target group.

*

* If you specify MaxIdleConnectionsPercent, then you must also include a value for this * parameter. *

*

* Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines *

*

* Constraints: Must be between 1 and 100. * @return Returns a reference to this object so that method calls can be chained together. */ public ConnectionPoolConfiguration withMaxConnectionsPercent(Integer maxConnectionsPercent) { setMaxConnectionsPercent(maxConnectionsPercent); return this; } /** *

* Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed * as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by * the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low * value causes the proxy to close more idle connections and return them to the database. *

*

* If you specify this parameter, then you must also include a value for MaxConnectionsPercent. *

*

* Default: The default value is half of the value of MaxConnectionsPercent. For example, if * MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent is 40. * If the value of MaxConnectionsPercent isn't specified, then for SQL Server, * MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50. *

*

* Constraints: Must be between 0 and the value of MaxConnectionsPercent. *

* * @param maxIdleConnectionsPercent * Controls how actively the proxy closes idle database connections in the connection pool. The value is * expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB * cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database * connections open. A low value causes the proxy to close more idle connections and return them to the * database.

*

* If you specify this parameter, then you must also include a value for MaxConnectionsPercent. *

*

* Default: The default value is half of the value of MaxConnectionsPercent. For example, if * MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent * is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, * MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50. *

*

* Constraints: Must be between 0 and the value of MaxConnectionsPercent. */ public void setMaxIdleConnectionsPercent(Integer maxIdleConnectionsPercent) { this.maxIdleConnectionsPercent = maxIdleConnectionsPercent; } /** *

* Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed * as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by * the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low * value causes the proxy to close more idle connections and return them to the database. *

*

* If you specify this parameter, then you must also include a value for MaxConnectionsPercent. *

*

* Default: The default value is half of the value of MaxConnectionsPercent. For example, if * MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent is 40. * If the value of MaxConnectionsPercent isn't specified, then for SQL Server, * MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50. *

*

* Constraints: Must be between 0 and the value of MaxConnectionsPercent. *

* * @return Controls how actively the proxy closes idle database connections in the connection pool. The value is * expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora * DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle * database connections open. A low value causes the proxy to close more idle connections and return them to * the database.

*

* If you specify this parameter, then you must also include a value for MaxConnectionsPercent. *

*

* Default: The default value is half of the value of MaxConnectionsPercent. For example, if * MaxConnectionsPercent is 80, then the default value of * MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't * specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and for all other engines, * the default is 50. *

*

* Constraints: Must be between 0 and the value of MaxConnectionsPercent. */ public Integer getMaxIdleConnectionsPercent() { return this.maxIdleConnectionsPercent; } /** *

* Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed * as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by * the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low * value causes the proxy to close more idle connections and return them to the database. *

*

* If you specify this parameter, then you must also include a value for MaxConnectionsPercent. *

*

* Default: The default value is half of the value of MaxConnectionsPercent. For example, if * MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent is 40. * If the value of MaxConnectionsPercent isn't specified, then for SQL Server, * MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50. *

*

* Constraints: Must be between 0 and the value of MaxConnectionsPercent. *

* * @param maxIdleConnectionsPercent * Controls how actively the proxy closes idle database connections in the connection pool. The value is * expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB * cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database * connections open. A low value causes the proxy to close more idle connections and return them to the * database.

*

* If you specify this parameter, then you must also include a value for MaxConnectionsPercent. *

*

* Default: The default value is half of the value of MaxConnectionsPercent. For example, if * MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent * is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, * MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50. *

*

* Constraints: Must be between 0 and the value of MaxConnectionsPercent. * @return Returns a reference to this object so that method calls can be chained together. */ public ConnectionPoolConfiguration withMaxIdleConnectionsPercent(Integer maxIdleConnectionsPercent) { setMaxIdleConnectionsPercent(maxIdleConnectionsPercent); return this; } /** *

* The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only * applies when the proxy has opened its maximum number of connections and all connections are busy with client * sessions. *

*

* Default: 120 *

*

* Constraints: between 1 and 3600, or 0 representing unlimited *

* * @param connectionBorrowTimeout * The number of seconds for a proxy to wait for a connection to become available in the connection pool. * Only applies when the proxy has opened its maximum number of connections and all connections are busy with * client sessions.

*

* Default: 120 *

*

* Constraints: between 1 and 3600, or 0 representing unlimited */ public void setConnectionBorrowTimeout(Integer connectionBorrowTimeout) { this.connectionBorrowTimeout = connectionBorrowTimeout; } /** *

* The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only * applies when the proxy has opened its maximum number of connections and all connections are busy with client * sessions. *

*

* Default: 120 *

*

* Constraints: between 1 and 3600, or 0 representing unlimited *

* * @return The number of seconds for a proxy to wait for a connection to become available in the connection pool. * Only applies when the proxy has opened its maximum number of connections and all connections are busy * with client sessions.

*

* Default: 120 *

*

* Constraints: between 1 and 3600, or 0 representing unlimited */ public Integer getConnectionBorrowTimeout() { return this.connectionBorrowTimeout; } /** *

* The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only * applies when the proxy has opened its maximum number of connections and all connections are busy with client * sessions. *

*

* Default: 120 *

*

* Constraints: between 1 and 3600, or 0 representing unlimited *

* * @param connectionBorrowTimeout * The number of seconds for a proxy to wait for a connection to become available in the connection pool. * Only applies when the proxy has opened its maximum number of connections and all connections are busy with * client sessions.

*

* Default: 120 *

*

* Constraints: between 1 and 3600, or 0 representing unlimited * @return Returns a reference to this object so that method calls can be chained together. */ public ConnectionPoolConfiguration withConnectionBorrowTimeout(Integer connectionBorrowTimeout) { setConnectionBorrowTimeout(connectionBorrowTimeout); return this; } /** *

* Each item in the list represents a class of SQL operations that normally cause all later statements in a session * using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that * class of SQL operations from the pinning behavior. *

*

* Default: no session pinning filters *

* * @return Each item in the list represents a class of SQL operations that normally cause all later statements in a * session using a proxy to be pinned to the same underlying database connection. Including an item in the * list exempts that class of SQL operations from the pinning behavior.

*

* Default: no session pinning filters */ public java.util.List getSessionPinningFilters() { if (sessionPinningFilters == null) { sessionPinningFilters = new com.amazonaws.internal.SdkInternalList(); } return sessionPinningFilters; } /** *

* Each item in the list represents a class of SQL operations that normally cause all later statements in a session * using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that * class of SQL operations from the pinning behavior. *

*

* Default: no session pinning filters *

* * @param sessionPinningFilters * Each item in the list represents a class of SQL operations that normally cause all later statements in a * session using a proxy to be pinned to the same underlying database connection. Including an item in the * list exempts that class of SQL operations from the pinning behavior.

*

* Default: no session pinning filters */ public void setSessionPinningFilters(java.util.Collection sessionPinningFilters) { if (sessionPinningFilters == null) { this.sessionPinningFilters = null; return; } this.sessionPinningFilters = new com.amazonaws.internal.SdkInternalList(sessionPinningFilters); } /** *

* Each item in the list represents a class of SQL operations that normally cause all later statements in a session * using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that * class of SQL operations from the pinning behavior. *

*

* Default: no session pinning filters *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setSessionPinningFilters(java.util.Collection)} or * {@link #withSessionPinningFilters(java.util.Collection)} if you want to override the existing values. *

* * @param sessionPinningFilters * Each item in the list represents a class of SQL operations that normally cause all later statements in a * session using a proxy to be pinned to the same underlying database connection. Including an item in the * list exempts that class of SQL operations from the pinning behavior.

*

* Default: no session pinning filters * @return Returns a reference to this object so that method calls can be chained together. */ public ConnectionPoolConfiguration withSessionPinningFilters(String... sessionPinningFilters) { if (this.sessionPinningFilters == null) { setSessionPinningFilters(new com.amazonaws.internal.SdkInternalList(sessionPinningFilters.length)); } for (String ele : sessionPinningFilters) { this.sessionPinningFilters.add(ele); } return this; } /** *

* Each item in the list represents a class of SQL operations that normally cause all later statements in a session * using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that * class of SQL operations from the pinning behavior. *

*

* Default: no session pinning filters *

* * @param sessionPinningFilters * Each item in the list represents a class of SQL operations that normally cause all later statements in a * session using a proxy to be pinned to the same underlying database connection. Including an item in the * list exempts that class of SQL operations from the pinning behavior.

*

* Default: no session pinning filters * @return Returns a reference to this object so that method calls can be chained together. */ public ConnectionPoolConfiguration withSessionPinningFilters(java.util.Collection sessionPinningFilters) { setSessionPinningFilters(sessionPinningFilters); return this; } /** *

* One or more SQL statements for the proxy to run when opening each new database connection. Typically used with * SET statements to make sure that each connection has identical settings such as time zone and * character set. For multiple statements, use semicolons as the separator. You can also include multiple variables * in a single SET statement, such as SET x=1, y=2. *

*

* Default: no initialization query *

* * @param initQuery * One or more SQL statements for the proxy to run when opening each new database connection. Typically used * with SET statements to make sure that each connection has identical settings such as time * zone and character set. For multiple statements, use semicolons as the separator. You can also include * multiple variables in a single SET statement, such as SET x=1, y=2.

*

* Default: no initialization query */ public void setInitQuery(String initQuery) { this.initQuery = initQuery; } /** *

* One or more SQL statements for the proxy to run when opening each new database connection. Typically used with * SET statements to make sure that each connection has identical settings such as time zone and * character set. For multiple statements, use semicolons as the separator. You can also include multiple variables * in a single SET statement, such as SET x=1, y=2. *

*

* Default: no initialization query *

* * @return One or more SQL statements for the proxy to run when opening each new database connection. Typically used * with SET statements to make sure that each connection has identical settings such as time * zone and character set. For multiple statements, use semicolons as the separator. You can also include * multiple variables in a single SET statement, such as SET x=1, y=2.

*

* Default: no initialization query */ public String getInitQuery() { return this.initQuery; } /** *

* One or more SQL statements for the proxy to run when opening each new database connection. Typically used with * SET statements to make sure that each connection has identical settings such as time zone and * character set. For multiple statements, use semicolons as the separator. You can also include multiple variables * in a single SET statement, such as SET x=1, y=2. *

*

* Default: no initialization query *

* * @param initQuery * One or more SQL statements for the proxy to run when opening each new database connection. Typically used * with SET statements to make sure that each connection has identical settings such as time * zone and character set. For multiple statements, use semicolons as the separator. You can also include * multiple variables in a single SET statement, such as SET x=1, y=2.

*

* Default: no initialization query * @return Returns a reference to this object so that method calls can be chained together. */ public ConnectionPoolConfiguration withInitQuery(String initQuery) { setInitQuery(initQuery); return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getMaxConnectionsPercent() != null) sb.append("MaxConnectionsPercent: ").append(getMaxConnectionsPercent()).append(","); if (getMaxIdleConnectionsPercent() != null) sb.append("MaxIdleConnectionsPercent: ").append(getMaxIdleConnectionsPercent()).append(","); if (getConnectionBorrowTimeout() != null) sb.append("ConnectionBorrowTimeout: ").append(getConnectionBorrowTimeout()).append(","); if (getSessionPinningFilters() != null) sb.append("SessionPinningFilters: ").append(getSessionPinningFilters()).append(","); if (getInitQuery() != null) sb.append("InitQuery: ").append(getInitQuery()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ConnectionPoolConfiguration == false) return false; ConnectionPoolConfiguration other = (ConnectionPoolConfiguration) obj; if (other.getMaxConnectionsPercent() == null ^ this.getMaxConnectionsPercent() == null) return false; if (other.getMaxConnectionsPercent() != null && other.getMaxConnectionsPercent().equals(this.getMaxConnectionsPercent()) == false) return false; if (other.getMaxIdleConnectionsPercent() == null ^ this.getMaxIdleConnectionsPercent() == null) return false; if (other.getMaxIdleConnectionsPercent() != null && other.getMaxIdleConnectionsPercent().equals(this.getMaxIdleConnectionsPercent()) == false) return false; if (other.getConnectionBorrowTimeout() == null ^ this.getConnectionBorrowTimeout() == null) return false; if (other.getConnectionBorrowTimeout() != null && other.getConnectionBorrowTimeout().equals(this.getConnectionBorrowTimeout()) == false) return false; if (other.getSessionPinningFilters() == null ^ this.getSessionPinningFilters() == null) return false; if (other.getSessionPinningFilters() != null && other.getSessionPinningFilters().equals(this.getSessionPinningFilters()) == false) return false; if (other.getInitQuery() == null ^ this.getInitQuery() == null) return false; if (other.getInitQuery() != null && other.getInitQuery().equals(this.getInitQuery()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getMaxConnectionsPercent() == null) ? 0 : getMaxConnectionsPercent().hashCode()); hashCode = prime * hashCode + ((getMaxIdleConnectionsPercent() == null) ? 0 : getMaxIdleConnectionsPercent().hashCode()); hashCode = prime * hashCode + ((getConnectionBorrowTimeout() == null) ? 0 : getConnectionBorrowTimeout().hashCode()); hashCode = prime * hashCode + ((getSessionPinningFilters() == null) ? 0 : getSessionPinningFilters().hashCode()); hashCode = prime * hashCode + ((getInitQuery() == null) ? 0 : getInitQuery().hashCode()); return hashCode; } @Override public ConnectionPoolConfiguration clone() { try { return (ConnectionPoolConfiguration) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }