Class CfnDBProxyTargetGroup
The AWS::RDS::DBProxyTargetGroup
resource represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDBProxyTargetGroup : CfnResource, IInspectable
Syntax (vb)
Public Class CfnDBProxyTargetGroup
Inherits CfnResource
Implements IInspectable
Remarks
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 .
CloudformationResource: AWS::RDS::DBProxyTargetGroup
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RDS;
var cfnDBProxyTargetGroup = new CfnDBProxyTargetGroup(this, "MyCfnDBProxyTargetGroup", new CfnDBProxyTargetGroupProps {
DbProxyName = "dbProxyName",
TargetGroupName = "targetGroupName",
// the properties below are optional
ConnectionPoolConfigurationInfo = new ConnectionPoolConfigurationInfoFormatProperty {
ConnectionBorrowTimeout = 123,
InitQuery = "initQuery",
MaxConnectionsPercent = 123,
MaxIdleConnectionsPercent = 123,
SessionPinningFilters = new [] { "sessionPinningFilters" }
},
DbClusterIdentifiers = new [] { "dbClusterIdentifiers" },
DbInstanceIdentifiers = new [] { "dbInstanceIdentifiers" }
});
Synopsis
Constructors
CfnDBProxyTargetGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDBProxyTargetGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDBProxyTargetGroup(Construct, String, ICfnDBProxyTargetGroupProps) |
Properties
AttrTargetGroupArn | The Amazon Resource Name (ARN) representing the target group. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ConnectionPoolConfigurationInfo | Displays the settings that control the size and behavior of the connection pool associated with a |
DbClusterIdentifiers | One or more DB cluster identifiers. |
DbInstanceIdentifiers | One or more DB instance identifiers. |
DbProxyName | The identifier of the |
TargetGroupName | The identifier for the target group. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDBProxyTargetGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDBProxyTargetGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDBProxyTargetGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDBProxyTargetGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDBProxyTargetGroup(Construct, String, ICfnDBProxyTargetGroupProps)
public CfnDBProxyTargetGroup(Construct scope, string id, ICfnDBProxyTargetGroupProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDBProxyTargetGroupProps
Resource properties.
Properties
AttrTargetGroupArn
The Amazon Resource Name (ARN) representing the target group.
public virtual string AttrTargetGroupArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: TargetGroupArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ConnectionPoolConfigurationInfo
Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget
.
public virtual object ConnectionPoolConfigurationInfo { get; set; }
Property Value
System.Object
DbClusterIdentifiers
One or more DB cluster identifiers.
public virtual string[] DbClusterIdentifiers { get; set; }
Property Value
System.String[]
DbInstanceIdentifiers
One or more DB instance identifiers.
public virtual string[] DbInstanceIdentifiers { get; set; }
Property Value
System.String[]
DbProxyName
The identifier of the DBProxy
that is associated with the DBProxyTargetGroup
.
public virtual string DbProxyName { get; set; }
Property Value
System.String
TargetGroupName
The identifier for the target group.
public virtual string TargetGroupName { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>