Amazon Relational Database Service
API Reference (API Version 2014-10-31)

RegisterDBProxyTargets

Note

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DBClusterIdentifiers.member.N

One or more DB cluster identifiers.

Type: Array of strings

Required: No

DBInstanceIdentifiers.member.N

One or more DB instance identifiers.

Type: Array of strings

Required: No

DBProxyName

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

Type: String

Required: Yes

TargetGroupName

The identifier of the DBProxyTargetGroup.

Type: String

Required: No

Response Elements

The following element is returned by the service.

DBProxyTargets.member.N

One or more DBProxyTarget objects that are created when you register targets with a target group.

Type: Array of DBProxyTarget objects

Errors

For information about the errors that are common to all actions, see Common Errors.

DBClusterNotFoundFault

DBClusterIdentifier doesn't refer to an existing DB cluster.

HTTP Status Code: 404

DBInstanceNotFound

DBInstanceIdentifier doesn't refer to an existing DB instance.

HTTP Status Code: 404

DBProxyNotFoundFault

The specified proxy name doesn't correspond to a proxy owned by your AWS accoutn in the specified AWS Region.

HTTP Status Code: 404

DBProxyTargetAlreadyRegisteredFault

The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.

HTTP Status Code: 400

DBProxyTargetGroupNotFoundFault

The specified target group isn't available for a proxy owned by your AWS account in the specified AWS Region.

HTTP Status Code: 404

InvalidDBClusterStateFault

The requested operation can't be performed while the cluster is in this state.

HTTP Status Code: 400

InvalidDBInstanceState

The DB instance isn't in a valid state.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: