Class DatabaseProxyProps.Builder
java.lang.Object
software.amazon.awscdk.services.rds.DatabaseProxyProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<DatabaseProxyProps>
- Enclosing interface:
DatabaseProxyProps
@Stability(Stable)
public static final class DatabaseProxyProps.Builder
extends Object
implements software.amazon.jsii.Builder<DatabaseProxyProps>
A builder for
DatabaseProxyProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionborrowTimeout
(Duration borrowTimeout) Sets the value ofDatabaseProxyOptions.getBorrowTimeout()
build()
Builds the configured instance.clientPasswordAuthType
(ClientPasswordAuthType clientPasswordAuthType) Sets the value ofDatabaseProxyOptions.getClientPasswordAuthType()
dbProxyName
(String dbProxyName) Sets the value ofDatabaseProxyOptions.getDbProxyName()
debugLogging
(Boolean debugLogging) Sets the value ofDatabaseProxyOptions.getDebugLogging()
Sets the value ofDatabaseProxyOptions.getIamAuth()
idleClientTimeout
(Duration idleClientTimeout) Sets the value ofDatabaseProxyOptions.getIdleClientTimeout()
Sets the value ofDatabaseProxyOptions.getInitQuery()
maxConnectionsPercent
(Number maxConnectionsPercent) Sets the value ofDatabaseProxyOptions.getMaxConnectionsPercent()
maxIdleConnectionsPercent
(Number maxIdleConnectionsPercent) Sets the value ofDatabaseProxyOptions.getMaxIdleConnectionsPercent()
proxyTarget
(ProxyTarget proxyTarget) Sets the value ofDatabaseProxyProps.getProxyTarget()
requireTls
(Boolean requireTls) Sets the value ofinvalid @link
DatabaseProxyProps#getRequireTls
Sets the value ofDatabaseProxyOptions.getRole()
Sets the value ofDatabaseProxyOptions.getSecrets()
securityGroups
(List<? extends ISecurityGroup> securityGroups) Sets the value ofDatabaseProxyOptions.getSecurityGroups()
sessionPinningFilters
(List<? extends SessionPinningFilter> sessionPinningFilters) Sets the value ofDatabaseProxyOptions.getSessionPinningFilters()
Sets the value ofDatabaseProxyOptions.getVpc()
vpcSubnets
(SubnetSelection vpcSubnets) Sets the value ofDatabaseProxyOptions.getVpcSubnets()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
proxyTarget
Sets the value ofDatabaseProxyProps.getProxyTarget()
- Parameters:
proxyTarget
- DB proxy target: Instance or Cluster. This parameter is required.- Returns:
this
-
secrets
Sets the value ofDatabaseProxyOptions.getSecrets()
- Parameters:
secrets
- The secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. This parameter is required. These secrets are stored within Amazon Secrets Manager. One or more secrets are required.- Returns:
this
-
vpc
Sets the value ofDatabaseProxyOptions.getVpc()
- Parameters:
vpc
- The VPC to associate with the new proxy. This parameter is required.- Returns:
this
-
borrowTimeout
Sets the value ofDatabaseProxyOptions.getBorrowTimeout()
- Parameters:
borrowTimeout
- The duration 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.Value must be between 1 second and 1 hour, or
Duration.seconds(0)
to represent unlimited.- Returns:
this
-
clientPasswordAuthType
@Stability(Stable) public DatabaseProxyProps.Builder clientPasswordAuthType(ClientPasswordAuthType clientPasswordAuthType) Sets the value ofDatabaseProxyOptions.getClientPasswordAuthType()
- Parameters:
clientPasswordAuthType
- Specifies the details of authentication used by a proxy to log in as a specific database user.- Returns:
this
-
dbProxyName
Sets the value ofDatabaseProxyOptions.getDbProxyName()
- Parameters:
dbProxyName
- The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.- Returns:
this
-
debugLogging
Sets the value ofDatabaseProxyOptions.getDebugLogging()
- Parameters:
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.- Returns:
this
-
iamAuth
Sets the value ofDatabaseProxyOptions.getIamAuth()
- Parameters:
iamAuth
- Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.- Returns:
this
-
idleClientTimeout
Sets the value ofDatabaseProxyOptions.getIdleClientTimeout()
- Parameters:
idleClientTimeout
- The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.- Returns:
this
-
initQuery
Sets the value ofDatabaseProxyOptions.getInitQuery()
- Parameters:
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.not currently supported for PostgreSQL.
- Returns:
this
-
maxConnectionsPercent
@Stability(Stable) public DatabaseProxyProps.Builder maxConnectionsPercent(Number maxConnectionsPercent) Sets the value ofDatabaseProxyOptions.getMaxConnectionsPercent()
- Parameters:
maxConnectionsPercent
- The maximum size of the connection pool for each target in a target group. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.1-100
- Returns:
this
-
maxIdleConnectionsPercent
@Stability(Stable) public DatabaseProxyProps.Builder maxIdleConnectionsPercent(Number maxIdleConnectionsPercent) Sets the value ofDatabaseProxyOptions.getMaxIdleConnectionsPercent()
- Parameters:
maxIdleConnectionsPercent
- Controls how actively the proxy closes idle database connections in the connection pool. A high value enables the proxy to leave a high percentage of idle connections open. A low value causes the proxy to close idle client connections and return the underlying database connections to the connection pool. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.between 0 and MaxConnectionsPercent
- Returns:
this
-
requireTls
Sets the value ofinvalid @link
DatabaseProxyProps#getRequireTls
- Parameters:
requireTls
- A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.- Returns:
this
-
role
Sets the value ofDatabaseProxyOptions.getRole()
- Parameters:
role
- IAM role that the proxy uses to access secrets in AWS Secrets Manager.- Returns:
this
-
securityGroups
@Stability(Stable) public DatabaseProxyProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups) Sets the value ofDatabaseProxyOptions.getSecurityGroups()
- Parameters:
securityGroups
- One or more VPC security groups to associate with the new proxy.- Returns:
this
-
sessionPinningFilters
@Stability(Stable) public DatabaseProxyProps.Builder sessionPinningFilters(List<? extends SessionPinningFilter> sessionPinningFilters) Sets the value ofDatabaseProxyOptions.getSessionPinningFilters()
- Parameters:
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.- Returns:
this
-
vpcSubnets
Sets the value ofDatabaseProxyOptions.getVpcSubnets()
- Parameters:
vpcSubnets
- The subnets used by the proxy.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<DatabaseProxyProps>
- Returns:
- a new instance of
DatabaseProxyProps
- Throws:
NullPointerException
- if any required attribute was not provided
-