DatabaseProxyOptions

All Known Subinterfaces:: DatabaseProxyProps

All Known Implementing Classes:: DatabaseProxyOptions.Jsii$Proxy, DatabaseProxyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:48.850Z")
public interface DatabaseProxyOptions

Options for a new DatabaseProxy.

Example:

 Vpc vpc;
 SecurityGroup securityGroup;
 Secret[] secrets;
 DatabaseInstance dbInstance;
 DatabaseProxy proxy = dbInstance.addProxy("proxy", DatabaseProxyOptions.builder()
         .borrowTimeout(Duration.seconds(30))
         .maxConnectionsPercent(50)
         .secrets(secrets)
         .vpc(vpc)
         .build());

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`DatabaseProxyOptions.Builder` A builder for `DatabaseProxyOptions`
`static class`	`DatabaseProxyOptions.Jsii$Proxy` An implementation for `DatabaseProxyOptions`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static DatabaseProxyOptions.Builder`	`builder()`
`default Duration`	`getBorrowTimeout()` The duration for a proxy to wait for a connection to become available in the connection pool.
`default java.lang.String`	`getDbProxyName()` The identifier for the proxy.
`default java.lang.Boolean`	`getDebugLogging()` Whether the proxy includes detailed information about SQL statements in its logs.
`default java.lang.Boolean`	`getIamAuth()` Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
`default Duration`	`getIdleClientTimeout()` The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
`default java.lang.String`	`getInitQuery()` One or more SQL statements for the proxy to run when opening each new database connection.
`default java.lang.Number`	`getMaxConnectionsPercent()` The maximum size of the connection pool for each target in a target group.
`default java.lang.Number`	`getMaxIdleConnectionsPercent()` Controls how actively the proxy closes idle database connections in the connection pool.
`default java.lang.Boolean`	`getRequireTLS()` A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
`default IRole`	`getRole()` IAM role that the proxy uses to access secrets in AWS Secrets Manager.
`java.util.List<ISecret>`	`getSecrets()` The secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.
`default java.util.List<ISecurityGroup>`	`getSecurityGroups()` One or more VPC security groups to associate with the new proxy.
`default java.util.List<SessionPinningFilter>`	`getSessionPinningFilters()` 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.
`IVpc`	`getVpc()` The VPC to associate with the new proxy.
`default SubnetSelection`	`getVpcSubnets()` The subnets used by the proxy.

- Method Detail
  - getSecrets
```
java.util.List<ISecret> getSecrets()
```
    The secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.
    These secrets are stored within Amazon Secrets Manager. One or more secrets are required.
  - getVpc
```
IVpc getVpc()
```
    The VPC to associate with the new proxy.
  - getBorrowTimeout
```
default Duration getBorrowTimeout()
```
    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.
    Default: cdk.Duration.seconds(120)
  - getDbProxyName
```
default java.lang.String getDbProxyName()
```
    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.
    Default: - Generated by CloudFormation (recommended)
  - getDebugLogging
```
default java.lang.Boolean getDebugLogging()
```
    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.
    Default: false
  - getIamAuth
```
default java.lang.Boolean getIamAuth()
```
    Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
    Default: false
  - getIdleClientTimeout
```
default Duration getIdleClientTimeout()
```
    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.
    Default: cdk.Duration.minutes(30)
  - getInitQuery
```
default java.lang.String getInitQuery()
```
    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.
    Default: - no initialization query
  - getMaxConnectionsPercent
```
default java.lang.Number getMaxConnectionsPercent()
```
    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
    Default: 100
  - getMaxIdleConnectionsPercent
```
default java.lang.Number getMaxIdleConnectionsPercent()
```
    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
    Default: 50
  - getRequireTLS
```
default java.lang.Boolean getRequireTLS()
```
    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.
    Default: true
  - getRole
```
default IRole getRole()
```
    IAM role that the proxy uses to access secrets in AWS Secrets Manager.
    Default: - A role will automatically be created
  - getSecurityGroups
```
default java.util.List<ISecurityGroup> getSecurityGroups()
```
    One or more VPC security groups to associate with the new proxy.
    Default: - No security groups
  - getSessionPinningFilters
```
default java.util.List<SessionPinningFilter> getSessionPinningFilters()
```
    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
  - getVpcSubnets
```
default SubnetSelection getVpcSubnets()
```
    The subnets used by the proxy.
    Default: - the VPC default strategy if not specified.
  - builder
```
static DatabaseProxyOptions.Builder builder()
```
    Returns:
    
    a DatabaseProxyOptions.Builder of DatabaseProxyOptions

Interface DatabaseProxyOptions

Nested Class Summary

Method Summary

Method Detail

getSecrets

getVpc

getBorrowTimeout

getDbProxyName

getDebugLogging

getIamAuth

getIdleClientTimeout

getInitQuery

getMaxConnectionsPercent

getMaxIdleConnectionsPercent

getRequireTLS

getRole

getSecurityGroups

getSessionPinningFilters

getVpcSubnets

builder