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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.420Z")
 @Stability(value=Stable)
public class CfnDBProxyTargetGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::RDS::DBProxyTargetGroup`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDBProxyTargetGroup.Builder A fluent builder for CfnDBProxyTargetGroup.
static interface	CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty Specifies the settings that control the size and behavior of the connection pool associated with a `DBProxyTargetGroup` .

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDBProxyTargetGroup(software.constructs.Construct scope, String id, CfnDBProxyTargetGroupProps props) Create a new `AWS::RDS::DBProxyTargetGroup`.
protected	CfnDBProxyTargetGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDBProxyTargetGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrTargetGroupArn() The Amazon Resource Name (ARN) representing the target group.
protected Map<String,Object>	getCfnProperties()
Object	getConnectionPoolConfigurationInfo() Settings that control the size and behavior of the connection pool associated with a `DBProxyTargetGroup` .
List<String>	getDbClusterIdentifiers() One or more DB cluster identifiers.
List<String>	getDbInstanceIdentifiers() One or more DB instance identifiers.
String	getDbProxyName() The identifier of the `DBProxy` that is associated with the `DBProxyTargetGroup` .
String	getTargetGroupName() The identifier for the target group.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConnectionPoolConfigurationInfo(CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty value) Settings that control the size and behavior of the connection pool associated with a `DBProxyTargetGroup` .
void	setConnectionPoolConfigurationInfo(IResolvable value) Settings that control the size and behavior of the connection pool associated with a `DBProxyTargetGroup` .
void	setDbClusterIdentifiers(List<String> value) One or more DB cluster identifiers.
void	setDbInstanceIdentifiers(List<String> value) One or more DB instance identifiers.
void	setDbProxyName(String value) The identifier of the `DBProxy` that is associated with the `DBProxyTargetGroup` .
void	setTargetGroupName(String value) The identifier for the target group.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDBProxyTargetGroup

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

CfnDBProxyTargetGroup

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

CfnDBProxyTargetGroup

@Stability(value=Stable)
public CfnDBProxyTargetGroup(@NotNull
                                                      software.constructs.Construct scope,
                                                      @NotNull
                                                      String id,
                                                      @NotNull
                                                      CfnDBProxyTargetGroupProps props)

Create a new `AWS::RDS::DBProxyTargetGroup`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrTargetGroupArn()

The Amazon Resource Name (ARN) representing the target group.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDbProxyName

@Stability(value=Stable)
 @NotNull
public String getDbProxyName()

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

setDbProxyName

@Stability(value=Stable)
public void setDbProxyName(@NotNull
                                                    String value)

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

getTargetGroupName

@Stability(value=Stable)
 @NotNull
public String getTargetGroupName()

The identifier for the target group.

Currently, this property must be set to default .

setTargetGroupName

@Stability(value=Stable)
public void setTargetGroupName(@NotNull
                                                        String value)

The identifier for the target group.

Currently, this property must be set to default .

getConnectionPoolConfigurationInfo

@Stability(value=Stable)
 @Nullable
public Object getConnectionPoolConfigurationInfo()

Settings that control the size and behavior of the connection pool associated with a `DBProxyTargetGroup` .

setConnectionPoolConfigurationInfo

@Stability(value=Stable)
public void setConnectionPoolConfigurationInfo(@Nullable
                                                                        CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty value)

Settings that control the size and behavior of the connection pool associated with a `DBProxyTargetGroup` .

setConnectionPoolConfigurationInfo

@Stability(value=Stable)
public void setConnectionPoolConfigurationInfo(@Nullable
                                                                        IResolvable value)

Settings that control the size and behavior of the connection pool associated with a `DBProxyTargetGroup` .

getDbClusterIdentifiers

@Stability(value=Stable)
 @Nullable
public List<String> getDbClusterIdentifiers()

One or more DB cluster identifiers.

setDbClusterIdentifiers

@Stability(value=Stable)
public void setDbClusterIdentifiers(@Nullable
                                                             List<String> value)

One or more DB cluster identifiers.

getDbInstanceIdentifiers

@Stability(value=Stable)
 @Nullable
public List<String> getDbInstanceIdentifiers()

One or more DB instance identifiers.

setDbInstanceIdentifiers

@Stability(value=Stable)
public void setDbInstanceIdentifiers(@Nullable
                                                              List<String> value)

One or more DB instance identifiers.