AWS::RDS::DBProxyTargetGroup - AWS CloudFormation
SyntaxPropertiesReturn values

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.

Note

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::RDS::DBProxyTargetGroup",
  "Properties" : {
      "ConnectionPoolConfigurationInfo" : ConnectionPoolConfigurationInfoFormat,
      "DBClusterIdentifiers" : [ String, ... ],
      "DBInstanceIdentifiers" : [ String, ... ],
      "DBProxyName" : String,
      "TargetGroupName" : String
    }
}

YAML

Type: AWS::RDS::DBProxyTargetGroup
Properties:
  ConnectionPoolConfigurationInfo: 
    ConnectionPoolConfigurationInfoFormat
  DBClusterIdentifiers: 
    - String
  DBInstanceIdentifiers: 
    - String
  DBProxyName: String
  TargetGroupName: String

Properties

ConnectionPoolConfigurationInfo

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

Required: No

Type: ConnectionPoolConfigurationInfoFormat

Update requires: No interruption

DBClusterIdentifiers

One or more DB cluster identifiers.

Required: No

Type: Array of String

Update requires: No interruption

DBInstanceIdentifiers

One or more DB instance identifiers.

Required: No

Type: Array of String

Update requires: No interruption

DBProxyName

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

Required: Yes

Type: String

Pattern: [A-z][0-z]*

Maximum: 64

Update requires: Replacement

TargetGroupName

The identifier for the target group.

Note

Currently, this property must be set to default.

Required: Yes

Type: String

Allowed values: default

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the target group.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

TargetGroupArn

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