software.amazon.awscdk.services.rds

Class DatabaseCluster

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.rds.DatabaseClusterBase

software.amazon.awscdk.services.rds.DatabaseCluster

All Implemented Interfaces:

IResource, IConnectable, IDatabaseCluster, ISecretAttachmentTarget, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.434Z")
 @Stability(value=Stable)
public class DatabaseCluster
extends DatabaseClusterBase

Create a clustered database with a given number of instances.

Example:

 Vpc vpc;
 DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
         .engine(DatabaseClusterEngine.auroraMysql(AuroraMysqlClusterEngineProps.builder().version(AuroraMysqlEngineVersion.VER_2_08_1).build()))
         .credentials(Credentials.fromGeneratedSecret("clusteradmin")) // Optional - will default to 'admin' username and generated password
         .instanceProps(InstanceProps.builder()
                 // optional , defaults to t3.medium
                 .instanceType(InstanceType.of(InstanceClass.BURSTABLE2, InstanceSize.SMALL))
                 .vpcSubnets(SubnetSelection.builder()
                         .subnetType(SubnetType.PRIVATE_WITH_EGRESS)
                         .build())
                 .vpc(vpc)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatabaseCluster.Builder A fluent builder for DatabaseCluster.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.IDatabaseCluster

IDatabaseCluster.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	DatabaseCluster(software.constructs.Construct scope, String id, DatabaseClusterProps props)
protected	DatabaseCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DatabaseCluster(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
SecretRotation	addRotationMultiUser(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, String id, DatabaseClusterAttributes attrs) Import an existing DatabaseCluster from properties.
Endpoint	getClusterEndpoint() The endpoint to use for read/write operations.
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.
List<Endpoint>	getInstanceEndpoints() Endpoints which address each individual replica.
List<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 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.

Methods inherited from class software.amazon.awscdk.services.rds.DatabaseClusterBase

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, metricVolumeWriteIOPs

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

DatabaseCluster

protected DatabaseCluster(software.amazon.jsii.JsiiObjectRef objRef)

DatabaseCluster

protected DatabaseCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

DatabaseCluster

@Stability(value=Stable)
public DatabaseCluster(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                DatabaseClusterProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromDatabaseClusterAttributes

@Stability(value=Stable)
 @NotNull
public static IDatabaseCluster fromDatabaseClusterAttributes(@NotNull
                                                                                                software.constructs.Construct scope,
                                                                                                @NotNull
                                                                                                String id,
                                                                                                @NotNull
                                                                                                DatabaseClusterAttributes attrs)

Import an existing DatabaseCluster from properties.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addRotationMultiUser

@Stability(value=Stable)
 @NotNull
public SecretRotation addRotationMultiUser(@NotNull
                                                                              String id,
                                                                              @NotNull
                                                                              RotationMultiUserOptions options)

Adds the multi user rotation to this cluster.

See Alternating users rotation strategy

Parameters:

id - This parameter is required.

options - This parameter is required.

addRotationSingleUser

@Stability(value=Stable)
 @NotNull
public SecretRotation addRotationSingleUser(@Nullable
                                                                               RotationSingleUserOptions options)

Adds the single user rotation of the master password to this cluster.

See Single user rotation strategy

Parameters:

options -

addRotationSingleUser

@Stability(value=Stable)
 @NotNull
public SecretRotation addRotationSingleUser()

Adds the single user rotation of the master password to this cluster.

See Single user rotation strategy

getClusterEndpoint

@Stability(value=Stable)
 @NotNull
public Endpoint getClusterEndpoint()

The endpoint to use for read/write operations.

Specified by:

getClusterEndpoint in interface IDatabaseCluster

Specified by:

getClusterEndpoint in class DatabaseClusterBase

getClusterIdentifier

@Stability(value=Stable)
 @NotNull
public String getClusterIdentifier()

Identifier of the cluster.

Specified by:

getClusterIdentifier in interface IDatabaseCluster

Specified by:

getClusterIdentifier in class DatabaseClusterBase

getClusterReadEndpoint

@Stability(value=Stable)
 @NotNull
public Endpoint getClusterReadEndpoint()

Endpoint to use for load-balanced read-only operations.

Specified by:

getClusterReadEndpoint in interface IDatabaseCluster

Specified by:

getClusterReadEndpoint in class DatabaseClusterBase

getConnections

@Stability(value=Stable)
 @NotNull
public Connections getConnections()

Access to the network connections.

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in class DatabaseClusterBase

getInstanceEndpoints

@Stability(value=Stable)
 @NotNull
public List<Endpoint> getInstanceEndpoints()

Endpoints which address each individual replica.

Specified by:

getInstanceEndpoints in interface IDatabaseCluster

Specified by:

getInstanceEndpoints in class DatabaseClusterBase

getInstanceIdentifiers

@Stability(value=Stable)
 @NotNull
public List<String> getInstanceIdentifiers()

Identifiers of the replicas.

Specified by:

getInstanceIdentifiers in interface IDatabaseCluster

Specified by:

getInstanceIdentifiers in class DatabaseClusterBase

getMultiUserRotationApplication

@Stability(value=Stable)
 @NotNull
public SecretRotationApplication getMultiUserRotationApplication()

Application for multi user rotation to this cluster.

getNewCfnProps

@Stability(value=Stable)
 @NotNull
protected CfnDBClusterProps getNewCfnProps()

getSecurityGroups

@Stability(value=Stable)
 @NotNull
protected List<ISecurityGroup> getSecurityGroups()

getSingleUserRotationApplication

@Stability(value=Stable)
 @NotNull
public SecretRotationApplication getSingleUserRotationApplication()

Application for single user rotation of the master password to this cluster.

getSubnetGroup

@Stability(value=Stable)
 @NotNull
protected ISubnetGroup getSubnetGroup()

getVpc

@Stability(value=Stable)
 @NotNull
public IVpc getVpc()

The VPC network to place the cluster in.

getEngine

@Stability(value=Stable)
 @Nullable
public IClusterEngine getEngine()

The engine for this Cluster.

Never undefined.

Specified by:

getEngine in interface IDatabaseCluster

Specified by:

getEngine in class DatabaseClusterBase

getSecret

@Stability(value=Stable)
 @Nullable
public ISecret getSecret()

The secret attached to this cluster.

getVpcSubnets

@Stability(value=Stable)
 @Nullable
public SubnetSelection getVpcSubnets()

The cluster's subnets.