aws-cdk-lib.aws_rds.ProxyTargetConfig

ProxyTargetConfig Struct

The result of binding a ProxyTarget to a DatabaseProxy.

Source

aws-rds/lib/proxy.ts

Example

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

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

dbClusters?optionalIDatabaseCluster[]db_clusters?optionaltyping.List[IDatabaseCluster]dbClusters?optionalList<IDatabaseCluster>DbClusters?optionalIDatabaseCluster[]DbClusters?optional*[]IDatabaseCluster#

The database clusters to which this proxy connects.

Default: undefined if dbInstances is set.

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

dbInstances?optionalIDatabaseInstance[]db_instances?optionaltyping.List[IDatabaseInstance]dbInstances?optionalList<IDatabaseInstance>DbInstances?optionalIDatabaseInstance[]DbInstances?optional*[]IDatabaseInstance#

The database instances to which this proxy connects.

Default: undefined if dbClusters is set.

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

engineFamilystringengine_familystrengineFamilyStringEngineFamilystringEngineFamily*stringrequired#

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