interface ProxyTargetConfig

Language	Type name
.NET	Amazon.CDK.AWS.RDS.ProxyTargetConfig
Java	software.amazon.awscdk.services.rds.ProxyTargetConfig
Python	aws_cdk.aws_rds.ProxyTargetConfig
TypeScript (source)	@aws-cdk/aws-rds » ProxyTargetConfig

Obtainable from ProxyTarget.bind()

The result of binding a ProxyTarget to a DatabaseProxy.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as rds from '@aws-cdk/aws-rds';

declare const databaseCluster: rds.DatabaseCluster;
declare const databaseInstance: rds.DatabaseInstance;
const proxyTargetConfig: rds.ProxyTargetConfig = {
  engineFamily: 'engineFamily',

  // the properties below are optional
  dbClusters: [databaseCluster],
  dbInstances: [databaseInstance],
};

Properties

Name	Type	Description
engineFamily	string	The engine family of the database instance or cluster this proxy connects with.
dbClusters?	IDatabaseCluster[]	The database clusters to which this proxy connects.
dbInstances?	IDatabaseInstance[]	The database instances to which this proxy connects.

---

engineFamily

Type: string

The engine family of the database instance or cluster this proxy connects with.

---

dbClusters?

Type: IDatabaseCluster[] (optional, default: undefined if dbInstances is set.)

The database clusters to which this proxy connects.

Either this or dbInstances will be set and the other undefined.

---

dbInstances?

Type: IDatabaseInstance[] (optional, default: undefined if dbClusters is set.)

The database instances to which this proxy connects.

Either this or dbClusters will be set and the other undefined.