Package software.amazon.awscdk.services.rds

Class CfnDBProxyTargetGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.rds.CfnDBProxyTargetGroup
All Implemented Interfaces:
IInspectable, IDBProxyTargetGroupRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:46.925Z") @Stability(Stable) public class CfnDBProxyTargetGroup extends CfnResource implements IInspectable, IDBProxyTargetGroupRef
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 in the Amazon RDS User Guide .

For information about RDS Proxy for Amazon Aurora, see Managing Connections with Amazon RDS Proxy in the Amazon Aurora User Guide .

For a sample template that creates a DB proxy and registers a DB instance, see 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 in the Amazon RDS User Guide .

For information about that apply to RDS Proxy for Amazon Aurora, see Limitations for RDS Proxy in the Amazon Aurora User Guide .

Example: 

 // 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.*;
 CfnDBProxyTargetGroup cfnDBProxyTargetGroup = CfnDBProxyTargetGroup.Builder.create(this, "MyCfnDBProxyTargetGroup")
         .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"))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDBProxyTargetGroup

      protected CfnDBProxyTargetGroup(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDBProxyTargetGroup

      protected CfnDBProxyTargetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDBProxyTargetGroup

      @Stability(Stable) public CfnDBProxyTargetGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDBProxyTargetGroupProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrTargetGroupArn

      @Stability(Stable) @NotNull public String getAttrTargetGroupArn()
      The Amazon Resource Name (ARN) representing the target group.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDbProxyTargetGroupRef

      @Stability(Stable) @NotNull public DBProxyTargetGroupReference getDbProxyTargetGroupRef()
      A reference to a DBProxyTargetGroup resource.
      Specified by:
      getDbProxyTargetGroupRef in interface IDBProxyTargetGroupRef

    • getDbProxyName

      @Stability(Stable) @NotNull public String getDbProxyName()
      The identifier of the DBProxy that is associated with the DBProxyTargetGroup .

    • setDbProxyName

      @Stability(Stable) public void setDbProxyName(@NotNull String value)
      The identifier of the DBProxy that is associated with the DBProxyTargetGroup .

    • getTargetGroupName

      @Stability(Stable) @NotNull public String getTargetGroupName()
      The identifier for the target group.

    • setTargetGroupName

      @Stability(Stable) public void setTargetGroupName(@NotNull String value)
      The identifier for the target group.

    • getConnectionPoolConfigurationInfo

      @Stability(Stable) @Nullable public Object getConnectionPoolConfigurationInfo()
      Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget .

      Returns union: either IResolvable or CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty

    • setConnectionPoolConfigurationInfo

      @Stability(Stable) public void setConnectionPoolConfigurationInfo(@Nullable IResolvable value)
      Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget .

    • setConnectionPoolConfigurationInfo

      @Stability(Stable) public void setConnectionPoolConfigurationInfo(@Nullable CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty value)
      Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget .

    • getDbClusterIdentifiers

      @Stability(Stable) @Nullable public List<String> getDbClusterIdentifiers()
      One or more DB cluster identifiers.

    • setDbClusterIdentifiers

      @Stability(Stable) public void setDbClusterIdentifiers(@Nullable List<String> value)
      One or more DB cluster identifiers.

    • getDbInstanceIdentifiers

      @Stability(Stable) @Nullable public List<String> getDbInstanceIdentifiers()
      One or more DB instance identifiers.

    • setDbInstanceIdentifiers

      @Stability(Stable) public void setDbInstanceIdentifiers(@Nullable List<String> value)
      One or more DB instance identifiers.