Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. rds
  5. DbProxyTargetGroup

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.DbProxyTargetGroup

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource schema for AWS::RDS::DBProxyTargetGroup

Create DbProxyTargetGroup Resource

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

Constructor syntax

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

@overload
def DbProxyTargetGroup(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       db_proxy_name: Optional[str] = None,
                       target_group_name: Optional[DbProxyTargetGroupTargetGroupName] = None,
                       connection_pool_configuration_info: Optional[DbProxyTargetGroupConnectionPoolConfigurationInfoFormatArgs] = None,
                       db_cluster_identifiers: Optional[Sequence[str]] = None,
                       db_instance_identifiers: Optional[Sequence[str]] = None)
func NewDbProxyTargetGroup(ctx *Context, name string, args DbProxyTargetGroupArgs, opts ...ResourceOption) (*DbProxyTargetGroup, error)
public DbProxyTargetGroup(string name, DbProxyTargetGroupArgs args, CustomResourceOptions? opts = null)
public DbProxyTargetGroup(String name, DbProxyTargetGroupArgs args)
public DbProxyTargetGroup(String name, DbProxyTargetGroupArgs args, CustomResourceOptions options)

type: aws-native:rds:DbProxyTargetGroup
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. DbProxyTargetGroupArgs
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. DbProxyTargetGroupArgs
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. DbProxyTargetGroupArgs
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. DbProxyTargetGroupArgs
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. DbProxyTargetGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DbProxyTargetGroup 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 DbProxyTargetGroup resource accepts the following input properties:

DbProxyName This property is required. string
The identifier for the proxy.
TargetGroupName This property is required. Pulumi.AwsNative.Rds.DbProxyTargetGroupTargetGroupName
The identifier for the DBProxyTargetGroup
ConnectionPoolConfigurationInfo Pulumi.AwsNative.Rds.Inputs.DbProxyTargetGroupConnectionPoolConfigurationInfoFormat
Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget .
DbClusterIdentifiers List<string>
One or more DB cluster identifiers.
DbInstanceIdentifiers List<string>
One or more DB instance identifiers.
DbProxyName This property is required. string
The identifier for the proxy.
TargetGroupName This property is required. DbProxyTargetGroupTargetGroupName
The identifier for the DBProxyTargetGroup
ConnectionPoolConfigurationInfo DbProxyTargetGroupConnectionPoolConfigurationInfoFormatArgs
Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget .
DbClusterIdentifiers []string
One or more DB cluster identifiers.
DbInstanceIdentifiers []string
One or more DB instance identifiers.
dbProxyName This property is required. String
The identifier for the proxy.
targetGroupName This property is required. DbProxyTargetGroupTargetGroupName
The identifier for the DBProxyTargetGroup
connectionPoolConfigurationInfo DbProxyTargetGroupConnectionPoolConfigurationInfoFormat
Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget .
dbClusterIdentifiers List<String>
One or more DB cluster identifiers.
dbInstanceIdentifiers List<String>
One or more DB instance identifiers.
dbProxyName This property is required. string
The identifier for the proxy.
targetGroupName This property is required. DbProxyTargetGroupTargetGroupName
The identifier for the DBProxyTargetGroup
connectionPoolConfigurationInfo DbProxyTargetGroupConnectionPoolConfigurationInfoFormat
Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget .
dbClusterIdentifiers string[]
One or more DB cluster identifiers.
dbInstanceIdentifiers string[]
One or more DB instance identifiers.
db_proxy_name This property is required. str
The identifier for the proxy.
target_group_name This property is required. DbProxyTargetGroupTargetGroupName
The identifier for the DBProxyTargetGroup
connection_pool_configuration_info DbProxyTargetGroupConnectionPoolConfigurationInfoFormatArgs
Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget .
db_cluster_identifiers Sequence[str]
One or more DB cluster identifiers.
db_instance_identifiers Sequence[str]
One or more DB instance identifiers.
dbProxyName This property is required. String
The identifier for the proxy.
targetGroupName This property is required. "default"
The identifier for the DBProxyTargetGroup
connectionPoolConfigurationInfo Property Map
Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget .
dbClusterIdentifiers List<String>
One or more DB cluster identifiers.
dbInstanceIdentifiers List<String>
One or more DB instance identifiers.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
TargetGroupArn string
The Amazon Resource Name (ARN) representing the target group.
Id string
The provider-assigned unique ID for this managed resource.
TargetGroupArn string
The Amazon Resource Name (ARN) representing the target group.
id String
The provider-assigned unique ID for this managed resource.
targetGroupArn String
The Amazon Resource Name (ARN) representing the target group.
id string
The provider-assigned unique ID for this managed resource.
targetGroupArn string
The Amazon Resource Name (ARN) representing the target group.
id str
The provider-assigned unique ID for this managed resource.
target_group_arn str
The Amazon Resource Name (ARN) representing the target group.
id String
The provider-assigned unique ID for this managed resource.
targetGroupArn String
The Amazon Resource Name (ARN) representing the target group.

Supporting Types

DbProxyTargetGroupConnectionPoolConfigurationInfoFormat
, DbProxyTargetGroupConnectionPoolConfigurationInfoFormatArgs

ConnectionBorrowTimeout int
The number of seconds for a proxy to wait for a connection to become available in the connection pool.
InitQuery string
One or more SQL statements for the proxy to run when opening each new database connection.
MaxConnectionsPercent int
The maximum size of the connection pool for each target in a target group.
MaxIdleConnectionsPercent int
Controls how actively the proxy closes idle database connections in the connection pool.
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.
ConnectionBorrowTimeout int
The number of seconds for a proxy to wait for a connection to become available in the connection pool.
InitQuery string
One or more SQL statements for the proxy to run when opening each new database connection.
MaxConnectionsPercent int
The maximum size of the connection pool for each target in a target group.
MaxIdleConnectionsPercent int
Controls how actively the proxy closes idle database connections in the connection pool.
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.
connectionBorrowTimeout Integer
The number of seconds for a proxy to wait for a connection to become available in the connection pool.
initQuery String
One or more SQL statements for the proxy to run when opening each new database connection.
maxConnectionsPercent Integer
The maximum size of the connection pool for each target in a target group.
maxIdleConnectionsPercent Integer
Controls how actively the proxy closes idle database connections in the connection pool.
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.
connectionBorrowTimeout number
The number of seconds for a proxy to wait for a connection to become available in the connection pool.
initQuery string
One or more SQL statements for the proxy to run when opening each new database connection.
maxConnectionsPercent number
The maximum size of the connection pool for each target in a target group.
maxIdleConnectionsPercent number
Controls how actively the proxy closes idle database connections in the connection pool.
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.
connection_borrow_timeout int
The number of seconds for a proxy to wait for a connection to become available in the connection pool.
init_query str
One or more SQL statements for the proxy to run when opening each new database connection.
max_connections_percent int
The maximum size of the connection pool for each target in a target group.
max_idle_connections_percent int
Controls how actively the proxy closes idle database connections in the connection pool.
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.
connectionBorrowTimeout Number
The number of seconds for a proxy to wait for a connection to become available in the connection pool.
initQuery String
One or more SQL statements for the proxy to run when opening each new database connection.
maxConnectionsPercent Number
The maximum size of the connection pool for each target in a target group.
maxIdleConnectionsPercent Number
Controls how actively the proxy closes idle database connections in the connection pool.
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.

DbProxyTargetGroupTargetGroupName
, DbProxyTargetGroupTargetGroupNameArgs

Default
default
DbProxyTargetGroupTargetGroupNameDefault
default
Default
default
Default
default
DEFAULT
default
"default"
default

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native