@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-28T21:34:30.452Z")
public class DatabaseCluster
extends DatabaseClusterBase
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");
| Modifier and Type | Class and Description |
|---|---|
static class |
DatabaseCluster.Builder
A fluent builder for
DatabaseCluster. |
IDatabaseCluster.Jsii$Default| Modifier | Constructor and Description |
|---|---|
protected |
DatabaseCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
DatabaseCluster(software.amazon.jsii.JsiiObjectRef objRef) |
|
DatabaseCluster(software.constructs.Construct scope,
java.lang.String id,
DatabaseClusterProps props) |
| Modifier and Type | Method and Description |
|---|---|
SecretRotation |
addRotationMultiUser(java.lang.String id,
RotationMultiUserOptions options)
Adds the multi user rotation to this cluster.
|
SecretRotation |
addRotationSingleUser()
Adds the single user rotation of the master password to this cluster.
|
SecretRotation |
addRotationSingleUser(RotationSingleUserOptions options)
Adds the single user rotation of the master password to this cluster.
|
static IDatabaseCluster |
fromDatabaseClusterAttributes(software.constructs.Construct scope,
java.lang.String id,
DatabaseClusterAttributes attrs)
Import an existing DatabaseCluster from properties.
|
Endpoint |
getClusterEndpoint()
The endpoint to use for read/write operations.
|
java.lang.String |
getClusterIdentifier()
Identifier of the cluster.
|
Endpoint |
getClusterReadEndpoint()
Endpoint to use for load-balanced read-only operations.
|
Connections |
getConnections()
Access to the network connections.
|
IClusterEngine |
getEngine()
The engine for this Cluster.
|
java.util.List<Endpoint> |
getInstanceEndpoints()
Endpoints which address each individual replica.
|
java.util.List<java.lang.String> |
getInstanceIdentifiers()
Identifiers of the replicas.
|
SecretRotationApplication |
getMultiUserRotationApplication()
Application for multi user rotation to this cluster.
|
protected CfnDBClusterProps |
getNewCfnProps() |
ISecret |
getSecret()
The secret attached to this cluster.
|
protected java.util.List<ISecurityGroup> |
getSecurityGroups() |
SecretRotationApplication |
getSingleUserRotationApplication()
Application for single user rotation of the master password to this cluster.
|
protected ISubnetGroup |
getSubnetGroup() |
IVpc |
getVpc()
The VPC network to place the cluster in.
|
SubnetSelection |
getVpcSubnets()
The cluster's subnets.
|
addProxy, asSecretAttachmentTarget, metric, metric, metricCPUUtilization, metricCPUUtilization, metricDatabaseConnections, metricDatabaseConnections, metricDeadlocks, metricDeadlocks, metricEngineUptime, metricEngineUptime, metricFreeableMemory, metricFreeableMemory, metricFreeLocalStorage, metricFreeLocalStorage, metricNetworkReceiveThroughput, metricNetworkReceiveThroughput, metricNetworkThroughput, metricNetworkThroughput, metricNetworkTransmitThroughput, metricNetworkTransmitThroughput, metricSnapshotStorageUsed, metricSnapshotStorageUsed, metricTotalBackupStorageBilled, metricTotalBackupStorageBilled, metricVolumeBytesUsed, metricVolumeBytesUsed, metricVolumeReadIOPs, metricVolumeReadIOPs, metricVolumeWriteIOPs, metricVolumeWriteIOPsapplyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResourcegetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validateclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitapplyRemovalPolicy, getEnv, getStackgetNodeprotected DatabaseCluster(software.amazon.jsii.JsiiObjectRef objRef)
protected DatabaseCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public DatabaseCluster(software.constructs.Construct scope,
java.lang.String id,
DatabaseClusterProps props)
scope - This parameter is required.id - This parameter is required.props - This parameter is required.public static IDatabaseCluster fromDatabaseClusterAttributes(software.constructs.Construct scope, java.lang.String id, DatabaseClusterAttributes attrs)
scope - This parameter is required.id - This parameter is required.attrs - This parameter is required.public SecretRotation addRotationMultiUser(java.lang.String id, RotationMultiUserOptions options)
id - This parameter is required.options - This parameter is required.public SecretRotation addRotationSingleUser(RotationSingleUserOptions options)
options - public SecretRotation addRotationSingleUser()
public Endpoint getClusterEndpoint()
getClusterEndpoint in interface IDatabaseClustergetClusterEndpoint in class DatabaseClusterBasepublic java.lang.String getClusterIdentifier()
getClusterIdentifier in interface IDatabaseClustergetClusterIdentifier in class DatabaseClusterBasepublic Endpoint getClusterReadEndpoint()
getClusterReadEndpoint in interface IDatabaseClustergetClusterReadEndpoint in class DatabaseClusterBasepublic Connections getConnections()
getConnections in interface IConnectablegetConnections in class DatabaseClusterBasepublic java.util.List<Endpoint> getInstanceEndpoints()
getInstanceEndpoints in interface IDatabaseClustergetInstanceEndpoints in class DatabaseClusterBasepublic java.util.List<java.lang.String> getInstanceIdentifiers()
getInstanceIdentifiers in interface IDatabaseClustergetInstanceIdentifiers in class DatabaseClusterBasepublic SecretRotationApplication getMultiUserRotationApplication()
protected CfnDBClusterProps getNewCfnProps()
protected java.util.List<ISecurityGroup> getSecurityGroups()
public SecretRotationApplication getSingleUserRotationApplication()
protected ISubnetGroup getSubnetGroup()
public IVpc getVpc()
public IClusterEngine getEngine()
Never undefined.
getEngine in interface IDatabaseClustergetEngine in class DatabaseClusterBasepublic ISecret getSecret()
public SubnetSelection getVpcSubnets()