Package software.amazon.awscdk.services.rds

Interface ProxyTargetConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ProxyTargetConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:48.817Z")
@Stability(Stable)
public interface ProxyTargetConfig
extends software.amazon.jsii.JsiiSerializable

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 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ProxyTargetConfig.Builder	A builder for ProxyTargetConfig
static final class	ProxyTargetConfig.Jsii$Proxy	An implementation for ProxyTargetConfig

Method Summary

Modifier and Type	Method	Description
static ProxyTargetConfig.Builder	builder()
default List<IDatabaseCluster>	getDbClusters()	The database clusters to which this proxy connects.
default List<IDatabaseInstance>	getDbInstances()	The database instances to which this proxy connects.
String	getEngineFamily()	The engine family of the database instance or cluster this proxy connects with.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEngineFamily

@Stability(Stable)
@NotNull
String getEngineFamily()

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

getDbClusters

@Stability(Stable)
@Nullable
default List<IDatabaseCluster> getDbClusters()

The database clusters to which this proxy connects.

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

Default: - `undefined` if `dbInstances` is set.

getDbInstances

@Stability(Stable)
@Nullable
default List<IDatabaseInstance> getDbInstances()

The database instances to which this proxy connects.

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

Default: - `undefined` if `dbClusters` is set.

builder

@Stability(Stable)
static ProxyTargetConfig.Builder builder()

Returns:

a ProxyTargetConfig.Builder of ProxyTargetConfig