AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::RDS::DBProxyTargetGroup

CfnDBProxyTargetGroup

The `AWS::RDS::DBProxyTargetGroup` resource represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster. This data type is used as a response element in the `DescribeDBProxyTargetGroups` action. For information about RDS Proxy for Amazon RDS, see [Managing Connections with Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html) in the *Amazon RDS User Guide* . For information about RDS Proxy for Amazon Aurora, see [Managing Connections with Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy.html) in the *Amazon Aurora User Guide* . For a sample template that creates a DB proxy and registers a DB instance, see [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#aws-resource-rds-dbproxy--examples) in AWS::RDS::DBProxy. > Limitations apply to RDS Proxy, including DB engine version limitations and AWS Region limitations. > > For information about limitations that apply to RDS Proxy for Amazon RDS, see [Limitations for RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html#rds-proxy.limitations) in the *Amazon RDS User Guide* . > > For information about that apply to RDS Proxy for Amazon Aurora, see [Limitations for RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy.html#rds-proxy.limitations) in the *Amazon Aurora User Guide* .

Import

import { CfnDBProxyTargetGroup } from 'aws-cdk-lib/aws-rds';

Or use the module namespace:

import * as rds from 'aws-cdk-lib/aws-rds';
// rds.CfnDBProxyTargetGroup

Properties

Configuration passed to the constructor as CfnDBProxyTargetGroupProps.

dbProxyNameRequired
string | IDBProxyRef

The identifier of the `DBProxy` that is associated with the `DBProxyTargetGroup` .

targetGroupNameRequired
string

The identifier for the target group. > Currently, this property must be set to `default` .

connectionPoolConfigurationInfoOptional
IResolvable | ConnectionPoolConfigurationInfoFormatProperty

Displays the settings that control the size and behavior of the connection pool associated with a `DBProxyTarget` .

dbClusterIdentifiersOptional
string | IDBClusterRef[]

One or more DB cluster identifiers.

dbInstanceIdentifiersOptional
string[]

One or more DB instance identifiers.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Get the Amazon RDS Cheat Sheet

Everything you need to know about Amazon RDS on one page. HD quality, print-friendly.

Download Free Infographic