software.amazon.awscdk.services.docdb

Class DatabaseCluster

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.docdb.DatabaseCluster

All Implemented Interfaces:

IConstruct, IDependable, IResource, IDatabaseCluster, IConnectable, ISecretAttachmentTarget

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:45.115Z")
public class DatabaseCluster
extends Resource
implements IDatabaseCluster

Create a clustered database with a given number of instances.

Example:

 Vpc vpc;
 DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
         .masterUser(Login.builder()
                 .username("myuser") // NOTE: 'admin' is reserved by DocumentDB
                 .excludeCharacters("\"@/:") // optional, defaults to the set "\"@/" and is also used for eventually created rotations
                 .secretName("/myapp/mydocdb/masteruser")
                 .build())
         .instanceType(InstanceType.of(InstanceClass.R5, InstanceSize.LARGE))
         .vpcSubnets(SubnetSelection.builder()
                 .subnetType(SubnetType.PUBLIC)
                 .build())
         .vpc(vpc)
         .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 interface software.amazon.awscdk.services.docdb.IDatabaseCluster

IDatabaseCluster.Jsii$Default, IDatabaseCluster.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Number	DEFAULT_NUM_INSTANCES The default number of instances in the DocDB cluster if none are specified.
static java.lang.Number	DEFAULT_PORT The default port Document DB listens on.

Constructor Summary

Constructors

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)

Method Summary

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(Duration automaticallyAfter) Adds the single user rotation of the master password to this cluster.
void	addSecurityGroups(ISecurityGroup... securityGroups) Adds security groups to this cluster.
SecretAttachmentTargetProps	asSecretAttachmentTarget() Renders the secret attachment target specifications.
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.
java.lang.String	getClusterResourceIdentifier() The resource id for the cluster;
Connections	getConnections() The connections object to implement IConnectable.
java.util.List<Endpoint>	getInstanceEndpoints() Endpoints which address each individual replica.
java.util.List<java.lang.String>	getInstanceIdentifiers() Identifiers of the replicas.
ISecret	getSecret() The secret attached to this cluster.
java.lang.String	getSecurityGroupId() Security group identifier of this database.

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Field Detail

DEFAULT_NUM_INSTANCES

public static final java.lang.Number DEFAULT_NUM_INSTANCES

The default number of instances in the DocDB cluster if none are specified.

DEFAULT_PORT

public static final java.lang.Number DEFAULT_PORT

The default port Document DB listens on.

Constructor Detail

DatabaseCluster

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

DatabaseCluster

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

DatabaseCluster

public DatabaseCluster(software.constructs.Construct scope,
                       java.lang.String id,
                       DatabaseClusterProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromDatabaseClusterAttributes

public static IDatabaseCluster fromDatabaseClusterAttributes(software.constructs.Construct scope,
                                                             java.lang.String id,
                                                             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

public SecretRotation addRotationMultiUser(java.lang.String id,
                                           RotationMultiUserOptions options)

Adds the multi user rotation to this cluster.

Parameters:

id - This parameter is required.

options - This parameter is required.

addRotationSingleUser

public SecretRotation addRotationSingleUser(Duration automaticallyAfter)

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

Parameters:

automaticallyAfter - Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.

addRotationSingleUser

public SecretRotation addRotationSingleUser()

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

addSecurityGroups

public void addSecurityGroups(ISecurityGroup... securityGroups)

Adds security groups to this cluster.

Parameters:

securityGroups - The security groups to add. This parameter is required.

asSecretAttachmentTarget

public SecretAttachmentTargetProps asSecretAttachmentTarget()

Renders the secret attachment target specifications.

Specified by:

asSecretAttachmentTarget in interface ISecretAttachmentTarget

getClusterEndpoint

public Endpoint getClusterEndpoint()

The endpoint to use for read/write operations.

Specified by:

getClusterEndpoint in interface IDatabaseCluster

getClusterIdentifier

public java.lang.String getClusterIdentifier()

Identifier of the cluster.

Specified by:

getClusterIdentifier in interface IDatabaseCluster

getClusterReadEndpoint

public Endpoint getClusterReadEndpoint()

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

Specified by:

getClusterReadEndpoint in interface IDatabaseCluster

getClusterResourceIdentifier

public java.lang.String getClusterResourceIdentifier()

The resource id for the cluster;

for example: cluster-ABCD1234EFGH5678IJKL90MNOP. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.

getConnections

public Connections getConnections()

The connections object to implement IConnectable.

Specified by:

getConnections in interface IConnectable

getInstanceEndpoints

public java.util.List<Endpoint> getInstanceEndpoints()

Endpoints which address each individual replica.

Specified by:

getInstanceEndpoints in interface IDatabaseCluster

getInstanceIdentifiers

public java.util.List<java.lang.String> getInstanceIdentifiers()

Identifiers of the replicas.

Specified by:

getInstanceIdentifiers in interface IDatabaseCluster

getSecurityGroupId

public java.lang.String getSecurityGroupId()

Security group identifier of this database.

Specified by:

getSecurityGroupId in interface IDatabaseCluster

getSecret

public ISecret getSecret()

The secret attached to this cluster.