Class DatabaseProxyOptions.Jsii$Proxy
- All Implemented Interfaces:
DatabaseProxyOptions
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
DatabaseProxyOptions
DatabaseProxyOptions
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.DatabaseProxyOptions
DatabaseProxyOptions.Builder, DatabaseProxyOptions.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Jsii$Proxy
(DatabaseProxyOptions.Builder builder) Constructor that initializes the object based on literal property values passed by theDatabaseProxyOptions.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Duration
The duration for a proxy to wait for a connection to become available in the connection pool.final ClientPasswordAuthType
Specifies the details of authentication used by a proxy to log in as a specific database user.final String
The identifier for the proxy.final Boolean
Whether the proxy includes detailed information about SQL statements in its logs.final Boolean
Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.final Duration
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.final String
One or more SQL statements for the proxy to run when opening each new database connection.final Number
The maximum size of the connection pool for each target in a target group.final Number
Controls how actively the proxy closes idle database connections in the connection pool.final Boolean
A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.final IRole
getRole()
IAM role that the proxy uses to access secrets in AWS Secrets Manager.The secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.final List<ISecurityGroup>
One or more VPC security groups to associate with the new proxy.final List<SessionPinningFilter>
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.final IVpc
getVpc()
The VPC to associate with the new proxy.final SubnetSelection
The subnets used by the proxy.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theDatabaseProxyOptions.Builder
.
-
-
Method Details
-
getSecrets
Description copied from interface:DatabaseProxyOptions
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.
- Specified by:
getSecrets
in interfaceDatabaseProxyOptions
-
getVpc
Description copied from interface:DatabaseProxyOptions
The VPC to associate with the new proxy.- Specified by:
getVpc
in interfaceDatabaseProxyOptions
-
getBorrowTimeout
Description copied from interface:DatabaseProxyOptions
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)
- Specified by:
getBorrowTimeout
in interfaceDatabaseProxyOptions
-
getClientPasswordAuthType
Description copied from interface:DatabaseProxyOptions
Specifies the details of authentication used by a proxy to log in as a specific database user.Default: - CloudFormation defaults will apply given the specified database engine.
- Specified by:
getClientPasswordAuthType
in interfaceDatabaseProxyOptions
-
getDbProxyName
Description copied from interface:DatabaseProxyOptions
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)
- Specified by:
getDbProxyName
in interfaceDatabaseProxyOptions
-
getDebugLogging
Description copied from interface:DatabaseProxyOptions
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
- Specified by:
getDebugLogging
in interfaceDatabaseProxyOptions
-
getIamAuth
Description copied from interface:DatabaseProxyOptions
Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.Default: false
- Specified by:
getIamAuth
in interfaceDatabaseProxyOptions
-
getIdleClientTimeout
Description copied from interface:DatabaseProxyOptions
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)
- Specified by:
getIdleClientTimeout
in interfaceDatabaseProxyOptions
-
getInitQuery
Description copied from interface:DatabaseProxyOptions
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
- Specified by:
getInitQuery
in interfaceDatabaseProxyOptions
-
getMaxConnectionsPercent
Description copied from interface:DatabaseProxyOptions
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
- Specified by:
getMaxConnectionsPercent
in interfaceDatabaseProxyOptions
-
getMaxIdleConnectionsPercent
Description copied from interface:DatabaseProxyOptions
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
- Specified by:
getMaxIdleConnectionsPercent
in interfaceDatabaseProxyOptions
-
getRequireTLS
Description copied from interface:DatabaseProxyOptions
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
- Specified by:
getRequireTLS
in interfaceDatabaseProxyOptions
-
getRole
Description copied from interface:DatabaseProxyOptions
IAM role that the proxy uses to access secrets in AWS Secrets Manager.Default: - A role will automatically be created
- Specified by:
getRole
in interfaceDatabaseProxyOptions
-
getSecurityGroups
Description copied from interface:DatabaseProxyOptions
One or more VPC security groups to associate with the new proxy.Default: - No security groups
- Specified by:
getSecurityGroups
in interfaceDatabaseProxyOptions
-
getSessionPinningFilters
Description copied from interface:DatabaseProxyOptions
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
- Specified by:
getSessionPinningFilters
in interfaceDatabaseProxyOptions
-
getVpcSubnets
Description copied from interface:DatabaseProxyOptions
The subnets used by the proxy.Default: - the VPC default strategy if not specified.
- Specified by:
getVpcSubnets
in interfaceDatabaseProxyOptions
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-