Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. rds
  5. ProxyDefaultTargetGroup
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.rds.ProxyDefaultTargetGroup

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Provides a resource to manage an RDS DB proxy default target group resource.

The aws.rds.ProxyDefaultTargetGroup behaves differently from normal resources, in that the provider does not create or destroy this resource, since it implicitly exists as part of an RDS DB Proxy. On the provider resource creation it is automatically imported and on resource destruction, the provider performs no actions in RDS.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.rds.Proxy("example", {
    name: "example",
    debugLogging: false,
    engineFamily: "MYSQL",
    idleClientTimeout: 1800,
    requireTls: true,
    roleArn: exampleAwsIamRole.arn,
    vpcSecurityGroupIds: [exampleAwsSecurityGroup.id],
    vpcSubnetIds: [exampleAwsSubnet.id],
    auths: [{
        authScheme: "SECRETS",
        description: "example",
        iamAuth: "DISABLED",
        secretArn: exampleAwsSecretsmanagerSecret.arn,
    }],
    tags: {
        Name: "example",
        Key: "value",
    },
});
const exampleProxyDefaultTargetGroup = new aws.rds.ProxyDefaultTargetGroup("example", {
    dbProxyName: example.name,
    connectionPoolConfig: {
        connectionBorrowTimeout: 120,
        initQuery: "SET x=1, y=2",
        maxConnectionsPercent: 100,
        maxIdleConnectionsPercent: 50,
        sessionPinningFilters: ["EXCLUDE_VARIABLE_SETS"],
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.rds.Proxy("example",
    name="example",
    debug_logging=False,
    engine_family="MYSQL",
    idle_client_timeout=1800,
    require_tls=True,
    role_arn=example_aws_iam_role["arn"],
    vpc_security_group_ids=[example_aws_security_group["id"]],
    vpc_subnet_ids=[example_aws_subnet["id"]],
    auths=[{
        "auth_scheme": "SECRETS",
        "description": "example",
        "iam_auth": "DISABLED",
        "secret_arn": example_aws_secretsmanager_secret["arn"],
    }],
    tags={
        "Name": "example",
        "Key": "value",
    })
example_proxy_default_target_group = aws.rds.ProxyDefaultTargetGroup("example",
    db_proxy_name=example.name,
    connection_pool_config={
        "connection_borrow_timeout": 120,
        "init_query": "SET x=1, y=2",
        "max_connections_percent": 100,
        "max_idle_connections_percent": 50,
        "session_pinning_filters": ["EXCLUDE_VARIABLE_SETS"],
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := rds.NewProxy(ctx, "example", &rds.ProxyArgs{
			Name:              pulumi.String("example"),
			DebugLogging:      pulumi.Bool(false),
			EngineFamily:      pulumi.String("MYSQL"),
			IdleClientTimeout: pulumi.Int(1800),
			RequireTls:        pulumi.Bool(true),
			RoleArn:           pulumi.Any(exampleAwsIamRole.Arn),
			VpcSecurityGroupIds: pulumi.StringArray{
				exampleAwsSecurityGroup.Id,
			},
			VpcSubnetIds: pulumi.StringArray{
				exampleAwsSubnet.Id,
			},
			Auths: rds.ProxyAuthArray{
				&rds.ProxyAuthArgs{
					AuthScheme:  pulumi.String("SECRETS"),
					Description: pulumi.String("example"),
					IamAuth:     pulumi.String("DISABLED"),
					SecretArn:   pulumi.Any(exampleAwsSecretsmanagerSecret.Arn),
				},
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example"),
				"Key":  pulumi.String("value"),
			},
		})
		if err != nil {
			return err
		}
		_, err = rds.NewProxyDefaultTargetGroup(ctx, "example", &rds.ProxyDefaultTargetGroupArgs{
			DbProxyName: example.Name,
			ConnectionPoolConfig: &rds.ProxyDefaultTargetGroupConnectionPoolConfigArgs{
				ConnectionBorrowTimeout:   pulumi.Int(120),
				InitQuery:                 pulumi.String("SET x=1, y=2"),
				MaxConnectionsPercent:     pulumi.Int(100),
				MaxIdleConnectionsPercent: pulumi.Int(50),
				SessionPinningFilters: pulumi.StringArray{
					pulumi.String("EXCLUDE_VARIABLE_SETS"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Rds.Proxy("example", new()
    {
        Name = "example",
        DebugLogging = false,
        EngineFamily = "MYSQL",
        IdleClientTimeout = 1800,
        RequireTls = true,
        RoleArn = exampleAwsIamRole.Arn,
        VpcSecurityGroupIds = new[]
        {
            exampleAwsSecurityGroup.Id,
        },
        VpcSubnetIds = new[]
        {
            exampleAwsSubnet.Id,
        },
        Auths = new[]
        {
            new Aws.Rds.Inputs.ProxyAuthArgs
            {
                AuthScheme = "SECRETS",
                Description = "example",
                IamAuth = "DISABLED",
                SecretArn = exampleAwsSecretsmanagerSecret.Arn,
            },
        },
        Tags = 
        {
            { "Name", "example" },
            { "Key", "value" },
        },
    });

    var exampleProxyDefaultTargetGroup = new Aws.Rds.ProxyDefaultTargetGroup("example", new()
    {
        DbProxyName = example.Name,
        ConnectionPoolConfig = new Aws.Rds.Inputs.ProxyDefaultTargetGroupConnectionPoolConfigArgs
        {
            ConnectionBorrowTimeout = 120,
            InitQuery = "SET x=1, y=2",
            MaxConnectionsPercent = 100,
            MaxIdleConnectionsPercent = 50,
            SessionPinningFilters = new[]
            {
                "EXCLUDE_VARIABLE_SETS",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.Proxy;
import com.pulumi.aws.rds.ProxyArgs;
import com.pulumi.aws.rds.inputs.ProxyAuthArgs;
import com.pulumi.aws.rds.ProxyDefaultTargetGroup;
import com.pulumi.aws.rds.ProxyDefaultTargetGroupArgs;
import com.pulumi.aws.rds.inputs.ProxyDefaultTargetGroupConnectionPoolConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Proxy("example", ProxyArgs.builder()
            .name("example")
            .debugLogging(false)
            .engineFamily("MYSQL")
            .idleClientTimeout(1800)
            .requireTls(true)
            .roleArn(exampleAwsIamRole.arn())
            .vpcSecurityGroupIds(exampleAwsSecurityGroup.id())
            .vpcSubnetIds(exampleAwsSubnet.id())
            .auths(ProxyAuthArgs.builder()
                .authScheme("SECRETS")
                .description("example")
                .iamAuth("DISABLED")
                .secretArn(exampleAwsSecretsmanagerSecret.arn())
                .build())
            .tags(Map.ofEntries(
                Map.entry("Name", "example"),
                Map.entry("Key", "value")
            ))
            .build());

        var exampleProxyDefaultTargetGroup = new ProxyDefaultTargetGroup("exampleProxyDefaultTargetGroup", ProxyDefaultTargetGroupArgs.builder()
            .dbProxyName(example.name())
            .connectionPoolConfig(ProxyDefaultTargetGroupConnectionPoolConfigArgs.builder()
                .connectionBorrowTimeout(120)
                .initQuery("SET x=1, y=2")
                .maxConnectionsPercent(100)
                .maxIdleConnectionsPercent(50)
                .sessionPinningFilters("EXCLUDE_VARIABLE_SETS")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:rds:Proxy
    properties:
      name: example
      debugLogging: false
      engineFamily: MYSQL
      idleClientTimeout: 1800
      requireTls: true
      roleArn: ${exampleAwsIamRole.arn}
      vpcSecurityGroupIds:
        - ${exampleAwsSecurityGroup.id}
      vpcSubnetIds:
        - ${exampleAwsSubnet.id}
      auths:
        - authScheme: SECRETS
          description: example
          iamAuth: DISABLED
          secretArn: ${exampleAwsSecretsmanagerSecret.arn}
      tags:
        Name: example
        Key: value
  exampleProxyDefaultTargetGroup:
    type: aws:rds:ProxyDefaultTargetGroup
    name: example
    properties:
      dbProxyName: ${example.name}
      connectionPoolConfig:
        connectionBorrowTimeout: 120
        initQuery: SET x=1, y=2
        maxConnectionsPercent: 100
        maxIdleConnectionsPercent: 50
        sessionPinningFilters:
          - EXCLUDE_VARIABLE_SETS
Copy

Create ProxyDefaultTargetGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ProxyDefaultTargetGroup(name: string, args: ProxyDefaultTargetGroupArgs, opts?: CustomResourceOptions);
@overload
def ProxyDefaultTargetGroup(resource_name: str,
                            args: ProxyDefaultTargetGroupArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def ProxyDefaultTargetGroup(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            db_proxy_name: Optional[str] = None,
                            connection_pool_config: Optional[ProxyDefaultTargetGroupConnectionPoolConfigArgs] = None)
func NewProxyDefaultTargetGroup(ctx *Context, name string, args ProxyDefaultTargetGroupArgs, opts ...ResourceOption) (*ProxyDefaultTargetGroup, error)
public ProxyDefaultTargetGroup(string name, ProxyDefaultTargetGroupArgs args, CustomResourceOptions? opts = null)
public ProxyDefaultTargetGroup(String name, ProxyDefaultTargetGroupArgs args)
public ProxyDefaultTargetGroup(String name, ProxyDefaultTargetGroupArgs args, CustomResourceOptions options)

type: aws:rds:ProxyDefaultTargetGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ProxyDefaultTargetGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ProxyDefaultTargetGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ProxyDefaultTargetGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ProxyDefaultTargetGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ProxyDefaultTargetGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var proxyDefaultTargetGroupResource = new Aws.Rds.ProxyDefaultTargetGroup("proxyDefaultTargetGroupResource", new()
{
    DbProxyName = "string",
    ConnectionPoolConfig = new Aws.Rds.Inputs.ProxyDefaultTargetGroupConnectionPoolConfigArgs
    {
        ConnectionBorrowTimeout = 0,
        InitQuery = "string",
        MaxConnectionsPercent = 0,
        MaxIdleConnectionsPercent = 0,
        SessionPinningFilters = new[]
        {
            "string",
        },
    },
});
Copy
example, err := rds.NewProxyDefaultTargetGroup(ctx, "proxyDefaultTargetGroupResource", &rds.ProxyDefaultTargetGroupArgs{
	DbProxyName: pulumi.String("string"),
	ConnectionPoolConfig: &rds.ProxyDefaultTargetGroupConnectionPoolConfigArgs{
		ConnectionBorrowTimeout:   pulumi.Int(0),
		InitQuery:                 pulumi.String("string"),
		MaxConnectionsPercent:     pulumi.Int(0),
		MaxIdleConnectionsPercent: pulumi.Int(0),
		SessionPinningFilters: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})
Copy
var proxyDefaultTargetGroupResource = new ProxyDefaultTargetGroup("proxyDefaultTargetGroupResource", ProxyDefaultTargetGroupArgs.builder()
    .dbProxyName("string")
    .connectionPoolConfig(ProxyDefaultTargetGroupConnectionPoolConfigArgs.builder()
        .connectionBorrowTimeout(0)
        .initQuery("string")
        .maxConnectionsPercent(0)
        .maxIdleConnectionsPercent(0)
        .sessionPinningFilters("string")
        .build())
    .build());
Copy
proxy_default_target_group_resource = aws.rds.ProxyDefaultTargetGroup("proxyDefaultTargetGroupResource",
    db_proxy_name="string",
    connection_pool_config={
        "connection_borrow_timeout": 0,
        "init_query": "string",
        "max_connections_percent": 0,
        "max_idle_connections_percent": 0,
        "session_pinning_filters": ["string"],
    })
Copy
const proxyDefaultTargetGroupResource = new aws.rds.ProxyDefaultTargetGroup("proxyDefaultTargetGroupResource", {
    dbProxyName: "string",
    connectionPoolConfig: {
        connectionBorrowTimeout: 0,
        initQuery: "string",
        maxConnectionsPercent: 0,
        maxIdleConnectionsPercent: 0,
        sessionPinningFilters: ["string"],
    },
});
Copy
type: aws:rds:ProxyDefaultTargetGroup
properties:
    connectionPoolConfig:
        connectionBorrowTimeout: 0
        initQuery: string
        maxConnectionsPercent: 0
        maxIdleConnectionsPercent: 0
        sessionPinningFilters:
            - string
    dbProxyName: string
Copy

ProxyDefaultTargetGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ProxyDefaultTargetGroup resource accepts the following input properties:

DbProxyName
This property is required.
Changes to this property will trigger replacement.
string
Name of the RDS DB Proxy.
ConnectionPoolConfig ProxyDefaultTargetGroupConnectionPoolConfig
The settings that determine the size and behavior of the connection pool for the target group.
DbProxyName
This property is required.
Changes to this property will trigger replacement.
string
Name of the RDS DB Proxy.
ConnectionPoolConfig ProxyDefaultTargetGroupConnectionPoolConfigArgs
The settings that determine the size and behavior of the connection pool for the target group.
dbProxyName
This property is required.
Changes to this property will trigger replacement.
String
Name of the RDS DB Proxy.
connectionPoolConfig ProxyDefaultTargetGroupConnectionPoolConfig
The settings that determine the size and behavior of the connection pool for the target group.
dbProxyName
This property is required.
Changes to this property will trigger replacement.
string
Name of the RDS DB Proxy.
connectionPoolConfig ProxyDefaultTargetGroupConnectionPoolConfig
The settings that determine the size and behavior of the connection pool for the target group.
db_proxy_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the RDS DB Proxy.
connection_pool_config ProxyDefaultTargetGroupConnectionPoolConfigArgs
The settings that determine the size and behavior of the connection pool for the target group.
dbProxyName
This property is required.
Changes to this property will trigger replacement.
String
Name of the RDS DB Proxy.
connectionPoolConfig Property Map
The settings that determine the size and behavior of the connection pool for the target group.

Outputs

All input properties are implicitly available as output properties. Additionally, the ProxyDefaultTargetGroup resource produces the following output properties:

Arn string
The Amazon Resource Name (ARN) representing the target group.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the default target group.
Arn string
The Amazon Resource Name (ARN) representing the target group.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the default target group.
arn String
The Amazon Resource Name (ARN) representing the target group.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the default target group.
arn string
The Amazon Resource Name (ARN) representing the target group.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the default target group.
arn str
The Amazon Resource Name (ARN) representing the target group.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the default target group.
arn String
The Amazon Resource Name (ARN) representing the target group.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the default target group.

Look up Existing ProxyDefaultTargetGroup Resource

Get an existing ProxyDefaultTargetGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ProxyDefaultTargetGroupState, opts?: CustomResourceOptions): ProxyDefaultTargetGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        connection_pool_config: Optional[ProxyDefaultTargetGroupConnectionPoolConfigArgs] = None,
        db_proxy_name: Optional[str] = None,
        name: Optional[str] = None) -> ProxyDefaultTargetGroup
func GetProxyDefaultTargetGroup(ctx *Context, name string, id IDInput, state *ProxyDefaultTargetGroupState, opts ...ResourceOption) (*ProxyDefaultTargetGroup, error)
public static ProxyDefaultTargetGroup Get(string name, Input<string> id, ProxyDefaultTargetGroupState? state, CustomResourceOptions? opts = null)
public static ProxyDefaultTargetGroup get(String name, Output<String> id, ProxyDefaultTargetGroupState state, CustomResourceOptions options)
resources:  _:    type: aws:rds:ProxyDefaultTargetGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string
The Amazon Resource Name (ARN) representing the target group.
ConnectionPoolConfig ProxyDefaultTargetGroupConnectionPoolConfig
The settings that determine the size and behavior of the connection pool for the target group.
DbProxyName Changes to this property will trigger replacement. string
Name of the RDS DB Proxy.
Name string
The name of the default target group.
Arn string
The Amazon Resource Name (ARN) representing the target group.
ConnectionPoolConfig ProxyDefaultTargetGroupConnectionPoolConfigArgs
The settings that determine the size and behavior of the connection pool for the target group.
DbProxyName Changes to this property will trigger replacement. string
Name of the RDS DB Proxy.
Name string
The name of the default target group.
arn String
The Amazon Resource Name (ARN) representing the target group.
connectionPoolConfig ProxyDefaultTargetGroupConnectionPoolConfig
The settings that determine the size and behavior of the connection pool for the target group.
dbProxyName Changes to this property will trigger replacement. String
Name of the RDS DB Proxy.
name String
The name of the default target group.
arn string
The Amazon Resource Name (ARN) representing the target group.
connectionPoolConfig ProxyDefaultTargetGroupConnectionPoolConfig
The settings that determine the size and behavior of the connection pool for the target group.
dbProxyName Changes to this property will trigger replacement. string
Name of the RDS DB Proxy.
name string
The name of the default target group.
arn str
The Amazon Resource Name (ARN) representing the target group.
connection_pool_config ProxyDefaultTargetGroupConnectionPoolConfigArgs
The settings that determine the size and behavior of the connection pool for the target group.
db_proxy_name Changes to this property will trigger replacement. str
Name of the RDS DB Proxy.
name str
The name of the default target group.
arn String
The Amazon Resource Name (ARN) representing the target group.
connectionPoolConfig Property Map
The settings that determine the size and behavior of the connection pool for the target group.
dbProxyName Changes to this property will trigger replacement. String
Name of the RDS DB Proxy.
name String
The name of the default target group.

Supporting Types

ProxyDefaultTargetGroupConnectionPoolConfig
, ProxyDefaultTargetGroupConnectionPoolConfigArgs

ConnectionBorrowTimeout int
The number of seconds 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.
InitQuery string
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. This setting is empty by default. 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.
MaxConnectionsPercent int
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.
MaxIdleConnectionsPercent int
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.
SessionPinningFilters List<string>
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. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.
ConnectionBorrowTimeout int
The number of seconds 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.
InitQuery string
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. This setting is empty by default. 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.
MaxConnectionsPercent int
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.
MaxIdleConnectionsPercent int
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.
SessionPinningFilters []string
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. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.
connectionBorrowTimeout Integer
The number of seconds 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.
initQuery String
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. This setting is empty by default. 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.
maxConnectionsPercent Integer
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.
maxIdleConnectionsPercent Integer
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.
sessionPinningFilters List<String>
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. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.
connectionBorrowTimeout number
The number of seconds 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.
initQuery string
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. This setting is empty by default. 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.
maxConnectionsPercent number
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.
maxIdleConnectionsPercent number
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.
sessionPinningFilters string[]
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. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.
connection_borrow_timeout int
The number of seconds 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.
init_query str
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. This setting is empty by default. 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.
max_connections_percent int
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.
max_idle_connections_percent int
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.
session_pinning_filters Sequence[str]
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. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.
connectionBorrowTimeout Number
The number of seconds 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.
initQuery String
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. This setting is empty by default. 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.
maxConnectionsPercent Number
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.
maxIdleConnectionsPercent Number
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.
sessionPinningFilters List<String>
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. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

Import

Using pulumi import, import DB proxy default target groups using the db_proxy_name. For example:

$ pulumi import aws:rds/proxyDefaultTargetGroup:ProxyDefaultTargetGroup example example
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws