ProxyTargetConfig Struct
The result of binding a ProxyTarget to a DatabaseProxy.
| Source | aws-rds/lib/proxy.ts |
|---|
Example
ts
// 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],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rds as rds
# database_cluster: rds.DatabaseCluster
# database_instance: rds.DatabaseInstance
proxy_target_config = rds.ProxyTargetConfig(
engine_family="engineFamily",
# the properties below are optional
db_clusters=[database_cluster],
db_instances=[database_instance]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.rds.*;
DatabaseCluster databaseCluster;
DatabaseInstance databaseInstance;
ProxyTargetConfig proxyTargetConfig = ProxyTargetConfig.builder()
.engineFamily("engineFamily")
// the properties below are optional
.dbClusters(List.of(databaseCluster))
.dbInstances(List.of(databaseInstance))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RDS;
DatabaseCluster databaseCluster;
DatabaseInstance databaseInstance;
var proxyTargetConfig = new ProxyTargetConfig {
EngineFamily = "engineFamily",
// the properties below are optional
DbClusters = new [] { databaseCluster },
DbInstances = new [] { databaseInstance }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var databaseCluster DatabaseCluster
var databaseInstance DatabaseInstance
proxyTargetConfig := &ProxyTargetConfig{
EngineFamily: jsii.String("engineFamily"),
// the properties below are optional
DbClusters: []IDatabaseCluster{
databaseCluster,
},
DbInstances: []IDatabaseInstance{
databaseInstance,
},
}
Properties
dbClustersoptionalIDatabaseCluster[]db_clustersoptionaltyping.List[IDatabaseCluster]dbClustersoptionalList<IDatabaseCluster>DbClustersoptionalIDatabaseCluster[]DbClustersoptional*[]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.
dbInstancesoptionalIDatabaseInstance[]db_instancesoptionaltyping.List[IDatabaseInstance]dbInstancesoptionalList<IDatabaseInstance>DbInstancesoptionalIDatabaseInstance[]DbInstancesoptional*[]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*string required #The engine family of the database instance or cluster this proxy connects with.