Skip to content
v2.276.0

CfnDBProxyTargetGroupProps Struct ​

Properties for defining a CfnDBProxyTargetGroup.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_rds as rds } from 'aws-cdk-lib';
const cfnDBProxyTargetGroupProps: rds.CfnDBProxyTargetGroupProps = {
  dbProxyName: 'dbProxyName',
  targetGroupName: 'targetGroupName',

  // the properties below are optional
  connectionPoolConfigurationInfo: {
    connectionBorrowTimeout: 123,
    initQuery: 'initQuery',
    maxConnectionsPercent: 123,
    maxIdleConnectionsPercent: 123,
    sessionPinningFilters: ['sessionPinningFilters'],
  },
  dbClusterIdentifiers: ['dbClusterIdentifiers'],
  dbInstanceIdentifiers: ['dbInstanceIdentifiers'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rds as rds

cfn_db_proxy_target_group_props = rds.CfnDBProxyTargetGroupProps(
    db_proxy_name="dbProxyName",
    target_group_name="targetGroupName",

    # the properties below are optional
    connection_pool_configuration_info=rds.CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty(
        connection_borrow_timeout=123,
        init_query="initQuery",
        max_connections_percent=123,
        max_idle_connections_percent=123,
        session_pinning_filters=["sessionPinningFilters"]
    ),
    db_cluster_identifiers=["dbClusterIdentifiers"],
    db_instance_identifiers=["dbInstanceIdentifiers"],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.rds.*;

CfnDBProxyTargetGroupProps cfnDBProxyTargetGroupProps = CfnDBProxyTargetGroupProps.builder()
        .dbProxyName("dbProxyName")
        .targetGroupName("targetGroupName")

        // the properties below are optional
        .connectionPoolConfigurationInfo(ConnectionPoolConfigurationInfoFormatProperty.builder()
                .connectionBorrowTimeout(123)
                .initQuery("initQuery")
                .maxConnectionsPercent(123)
                .maxIdleConnectionsPercent(123)
                .sessionPinningFilters(List.of("sessionPinningFilters"))
                .build())
        .dbClusterIdentifiers(List.of("dbClusterIdentifiers"))
        .dbInstanceIdentifiers(List.of("dbInstanceIdentifiers"))
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RDS;

var cfnDBProxyTargetGroupProps = new CfnDBProxyTargetGroupProps {
    DbProxyName = "dbProxyName",
    TargetGroupName = "targetGroupName",

    // the properties below are optional
    ConnectionPoolConfigurationInfo = new ConnectionPoolConfigurationInfoFormatProperty {
        ConnectionBorrowTimeout = 123,
        InitQuery = "initQuery",
        MaxConnectionsPercent = 123,
        MaxIdleConnectionsPercent = 123,
        SessionPinningFilters = new [] { "sessionPinningFilters" }
    },
    DbClusterIdentifiers = new [] { "dbClusterIdentifiers" },
    DbInstanceIdentifiers = new [] { "dbInstanceIdentifiers" },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnDBProxyTargetGroupProps := &CfnDBProxyTargetGroupProps{
	DbProxyName: jsii.String("dbProxyName"),
	TargetGroupName: jsii.String("targetGroupName"),

	// the properties below are optional
	ConnectionPoolConfigurationInfo: &ConnectionPoolConfigurationInfoFormatProperty{
		ConnectionBorrowTimeout: jsii.Number(123),
		InitQuery: jsii.String("initQuery"),
		MaxConnectionsPercent: jsii.Number(123),
		MaxIdleConnectionsPercent: jsii.Number(123),
		SessionPinningFilters: []*string{
			jsii.String("sessionPinningFilters"),
		},
	},
	DbClusterIdentifiers: []interface{}{
		jsii.String("dbClusterIdentifiers"),
	},
	DbInstanceIdentifiers: []*string{
		jsii.String("dbInstanceIdentifiers"),
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

connectionPoolConfigurationInfooptionalIResolvable | CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatPropertyconnection_pool_configuration_infooptionaltyping.Union[IResolvable, ConnectionPoolConfigurationInfoFormatProperty]connectionPoolConfigurationInfooptionalIResolvableConnectionPoolConfigurationInfooptionalIResolvableConnectionPoolConfigurationInfooptionalinterface{}#
Displays the settings that control the size and behavior of the connection pool associated with a `DBProxyTarget` .
dbClusterIdentifiersoptionalstring | IDBClusterRef[]db_cluster_identifiersoptionaltyping.List[typing.Union[str, IDBClusterRef]]dbClusterIdentifiersoptionalList<String>DbClusterIdentifiersoptionalstring[]DbClusterIdentifiersoptional*[]interface{}#
One or more DB cluster identifiers.
dbInstanceIdentifiersoptionalstring[]db_instance_identifiersoptionaltyping.List[str]dbInstanceIdentifiersoptionalList<String>DbInstanceIdentifiersoptionalstring[]DbInstanceIdentifiersoptional*[]*string#
One or more DB instance identifiers.
dbProxyNamestring | IDBProxyRefdb_proxy_nametyping.Union[str, IDBProxyRef]dbProxyNameStringDbProxyNamestringDbProxyNameinterface{}required#
The identifier of the `DBProxy` that is associated with the `DBProxyTargetGroup` .
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to this resource.
targetGroupNamestringtarget_group_namestrtargetGroupNameStringTargetGroupNamestringTargetGroupName*stringrequired#
The identifier for the target group.

Currently, this property must be set to default .