Class: AWSCDK::RDS::CfnDBProxyTargetGroup::ConnectionPoolConfigurationInfoFormatProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
rds/cfn_db_proxy_target_group.rb

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection_borrow_timeout: nil, init_query: nil, max_connections_percent: nil, max_idle_connections_percent: nil, session_pinning_filters: nil) ⇒ ConnectionPoolConfigurationInfoFormatProperty

Returns a new instance of ConnectionPoolConfigurationInfoFormatProperty.

Parameters:

  • connection_borrow_timeout (Numeric, nil) (defaults to: nil) —

    The number of seconds for a proxy to wait for a connection to become available in the connection pool.

  • init_query (String, nil) (defaults to: nil) —

    Add an initialization query, or modify the current one.

  • max_connections_percent (Numeric, nil) (defaults to: nil) —

    The maximum size of the connection pool for each target in a target group.

  • max_idle_connections_percent (Numeric, nil) (defaults to: nil) —

    A value that controls how actively the proxy closes idle database connections in the connection pool.

  • session_pinning_filters (Array<String>, nil) (defaults to: nil) —

    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.



573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'rds/cfn_db_proxy_target_group.rb', line 573

def initialize(connection_borrow_timeout: nil, init_query: nil, max_connections_percent: nil, max_idle_connections_percent: nil, session_pinning_filters: nil)
  @connection_borrow_timeout = connection_borrow_timeout
  Jsii::Type.check_type(@connection_borrow_timeout, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "connectionBorrowTimeout") unless @connection_borrow_timeout.nil?
  @init_query = init_query
  Jsii::Type.check_type(@init_query, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "initQuery") unless @init_query.nil?
  @max_connections_percent = max_connections_percent
  Jsii::Type.check_type(@max_connections_percent, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxConnectionsPercent") unless @max_connections_percent.nil?
  @max_idle_connections_percent = max_idle_connections_percent
  Jsii::Type.check_type(@max_idle_connections_percent, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxIdleConnectionsPercent") unless @max_idle_connections_percent.nil?
  @session_pinning_filters = session_pinning_filters
  Jsii::Type.check_type(@session_pinning_filters, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "sessionPinningFilters") unless @session_pinning_filters.nil?
end

Instance Attribute Details

#connection_borrow_timeout ⇒ Numeric? (readonly)

The number of seconds for a proxy to wait for a connection to become available in the connection pool.

This setting only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.

Default: 120

Constraints:

  • Must be between 0 and 300.

Returns:

  • (Numeric, nil)

See Also:



598
599
600
 
# File 'rds/cfn_db_proxy_target_group.rb', line 598

def connection_borrow_timeout
  @connection_borrow_timeout
end

#init_query ⇒ String? (readonly)

Add an initialization query, or modify the current one.

You can specify one or more SQL statements for the proxy to run when opening each new database connection. The setting is typically used with SET statements to make sure that each connection has identical settings. Make sure the query added here is valid. This is an optional field, so you can choose to leave it empty. For including multiple variables in a single SET statement, use a comma separator.

For example: SET variable1=value1, variable2=value2

Default: no initialization query

Since you can access initialization query as part of target group configuration, it is not protected by authentication or cryptographic methods. Anyone with access to view or manage your proxy target group configuration can view the initialization query. You should not add sensitive data, such as passwords or long-lived encryption keys, to this option.

Returns:

  • (String, nil)

See Also:



611
612
613
 
# File 'rds/cfn_db_proxy_target_group.rb', line 611

def init_query
  @init_query
end

#max_connections_percent ⇒ Numeric? (readonly)

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.

Returns:

  • (Numeric, nil)

See Also:



626
627
628
 
# File 'rds/cfn_db_proxy_target_group.rb', line 626

def max_connections_percent
  @max_connections_percent
end

#max_idle_connections_percent ⇒ Numeric? (readonly)

A value that 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 .

Returns:

  • (Numeric, nil)

See Also:



641
642
643
 
# File 'rds/cfn_db_proxy_target_group.rb', line 641

def max_idle_connections_percent
  @max_idle_connections_percent
end

#session_pinning_filters ⇒ Array<String>? (readonly)

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

Returns:

  • (Array<String>, nil)

See Also:



650
651
652
 
# File 'rds/cfn_db_proxy_target_group.rb', line 650

def session_pinning_filters
  @session_pinning_filters
end

Class Method Details

.jsii_properties ⇒ Object 



652
653
654
655
656
657
658
659
660
 
# File 'rds/cfn_db_proxy_target_group.rb', line 652

def self.jsii_properties
  {
    :connection_borrow_timeout => "connectionBorrowTimeout",
    :init_query => "initQuery",
    :max_connections_percent => "maxConnectionsPercent",
    :max_idle_connections_percent => "maxIdleConnectionsPercent",
    :session_pinning_filters => "sessionPinningFilters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



662
663
664
665
666
667
668
669
670
671
672
 
# File 'rds/cfn_db_proxy_target_group.rb', line 662

def to_jsii
  result = {}
  result.merge!({
    "connectionBorrowTimeout" => @connection_borrow_timeout,
    "initQuery" => @init_query,
    "maxConnectionsPercent" => @max_connections_percent,
    "maxIdleConnectionsPercent" => @max_idle_connections_percent,
    "sessionPinningFilters" => @session_pinning_filters,
  })
  result.compact
end