Package software.amazon.awscdk.services.rds

Class DatabaseProxyProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.rds.DatabaseProxyProps.Jsii$Proxy
All Implemented Interfaces:
DatabaseProxyOptions, DatabaseProxyProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
DatabaseProxyProps
@Stability(Stable) @Internal public static final class DatabaseProxyProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements DatabaseProxyProps
An implementation for DatabaseProxyProps

  • 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.DatabaseProxyProps

    DatabaseProxyProps.Builder, DatabaseProxyProps.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(DatabaseProxyProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the DatabaseProxyProps.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 Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final Duration
    getBorrowTimeout()
    The duration for a proxy to wait for a connection to become available in the connection pool.
    final String
    getDbProxyName()
    The identifier for the proxy.
    final Boolean
    getDebugLogging()
    Whether the proxy includes detailed information about SQL statements in its logs.
    final Boolean
    getIamAuth()
    Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
    final Duration
    getIdleClientTimeout()
    The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
    final String
    getInitQuery()
    One or more SQL statements for the proxy to run when opening each new database connection.
    final Number
    getMaxConnectionsPercent()
    The maximum size of the connection pool for each target in a target group.
    final Number
    getMaxIdleConnectionsPercent()
    Controls how actively the proxy closes idle database connections in the connection pool.
    final ProxyTarget
    getProxyTarget()
    DB proxy target: Instance or Cluster.
    final Boolean
    getRequireTLS()
    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.
    final List<ISecret>
    getSecrets()
    The secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.
    final List<ISecurityGroup>
    getSecurityGroups()
    One or more VPC security groups to associate with the new proxy.
    final 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.
    final IVpc
    getVpc()
    The VPC to associate with the new proxy.
    final SubnetSelection
    getVpcSubnets()
    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

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • 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

      protected Jsii$Proxy(DatabaseProxyProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the DatabaseProxyProps.Builder.

  • Method Details

    • getProxyTarget

      public final ProxyTarget getProxyTarget()
      Description copied from interface: DatabaseProxyProps
      DB proxy target: Instance or Cluster.
      Specified by:
      getProxyTarget in interface DatabaseProxyProps

    • getSecrets

      public final List<ISecret> 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 interface DatabaseProxyOptions

    • getVpc

      public final IVpc getVpc()
      Description copied from interface: DatabaseProxyOptions
      The VPC to associate with the new proxy.
      Specified by:
      getVpc in interface DatabaseProxyOptions

    • getBorrowTimeout

      public final Duration 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 interface DatabaseProxyOptions

    • getDbProxyName

      public final String 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 interface DatabaseProxyOptions

    • getDebugLogging

      public final Boolean 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 interface DatabaseProxyOptions

    • getIamAuth

      public final Boolean 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 interface DatabaseProxyOptions

    • getIdleClientTimeout

      public final Duration 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 interface DatabaseProxyOptions

    • getInitQuery

      public final String 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 interface DatabaseProxyOptions

    • getMaxConnectionsPercent

      public final Number 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 interface DatabaseProxyOptions

    • getMaxIdleConnectionsPercent

      public final Number 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 interface DatabaseProxyOptions

    • getRequireTLS

      public final Boolean 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 interface DatabaseProxyOptions

    • getRole

      public final IRole 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 interface DatabaseProxyOptions

    • getSecurityGroups

      public final List<ISecurityGroup> 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 interface DatabaseProxyOptions

    • getSessionPinningFilters

      public final List<SessionPinningFilter> 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 interface DatabaseProxyOptions

    • getVpcSubnets

      public final SubnetSelection getVpcSubnets()
      Description copied from interface: DatabaseProxyOptions
      The subnets used by the proxy.

      Default: - the VPC default strategy if not specified.

      Specified by:
      getVpcSubnets in interface DatabaseProxyOptions

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object