Package software.amazon.awscdk.services.rds

Interface DatabaseProxyProps

All Superinterfaces:

DatabaseProxyOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DatabaseProxyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.170Z")
@Stability(Stable)
public interface DatabaseProxyProps
extends software.amazon.jsii.JsiiSerializable, DatabaseProxyOptions

Construction properties for a DatabaseProxy.

Example:

 Vpc vpc;
 DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
         .engine(DatabaseClusterEngine.AURORA)
         .instanceProps(InstanceProps.builder().vpc(vpc).build())
         .build();
 DatabaseProxy proxy = DatabaseProxy.Builder.create(this, "Proxy")
         .proxyTarget(ProxyTarget.fromCluster(cluster))
         .secrets(List.of(cluster.getSecret()))
         .vpc(vpc)
         .build();
 Role role = Role.Builder.create(this, "DBProxyRole").assumedBy(new AccountPrincipal(this.account)).build();
 proxy.grantConnect(role, "admin");
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DatabaseProxyProps.Builder	builder()
ProxyTarget	getProxyTarget()	DB proxy target: Instance or Cluster.

Methods inherited from interface software.amazon.awscdk.services.rds.DatabaseProxyOptions

getBorrowTimeout, getDbProxyName, getDebugLogging, getIamAuth, getIdleClientTimeout, getInitQuery, getMaxConnectionsPercent, getMaxIdleConnectionsPercent, getRequireTLS, getRole, getSecrets, getSecurityGroups, getSessionPinningFilters, getVpc, getVpcSubnets

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getProxyTarget

@Stability(Stable)
@NotNull
ProxyTarget getProxyTarget()

DB proxy target: Instance or Cluster.

builder

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

Returns:

a DatabaseProxyProps.Builder of DatabaseProxyProps