class DatabaseCluster (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.DocDB.DatabaseCluster`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsdocdb#DatabaseCluster`
Java	`software.amazon.awscdk.services.docdb.DatabaseCluster`
Python	`aws_cdk.aws_docdb.DatabaseCluster`
TypeScript (source)	`aws-cdk-lib` » `aws_docdb` » `DatabaseCluster`

Implements IConstruct, IDependable, IResource, IDatabaseCluster, IConnectable, ISecretAttachmentTarget

Create a clustered database with a given number of instances.

Example

declare const vpc: ec2.Vpc;

const cluster = new docdb.DatabaseCluster(this, 'Database', {
  masterUser: {
    username: 'myuser',
  },
  instanceType: ec2.InstanceType.of(ec2.InstanceClass.MEMORY5, ec2.InstanceSize.LARGE),
  vpcSubnets: {
    subnetType: ec2.SubnetType.PUBLIC,
  },
  vpc,
  removalPolicy: RemovalPolicy.SNAPSHOT,
});

Initializer

new DatabaseCluster(scope: Construct, id: string, props: DatabaseClusterProps)

Parameters

scope Construct
id string
props DatabaseClusterProps

Construct Props

Name	Type	Description
instanceType	`InstanceType`	What type of instance to start for the replicas.
masterUser	`Login`	Username and password for the administrative user.
vpc	`IVpc`	What subnets to run the DocumentDB instances in.
backup?	`BackupProps`	Backup settings.
caCertificate?	`CaCertificate`	The identifier of the CA certificate used for the instances.
cloudWatchLogsRetention?	`RetentionDays`	The number of days log events are kept in CloudWatch Logs.
cloudWatchLogsRetentionRole?	`IRole`	The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
copyTagsToSnapshot?	`boolean`	Whether to copy tags to the snapshot when a snapshot is created.
dbClusterName?	`string`	An optional identifier for the cluster.
deletionProtection?	`boolean`	Specifies whether this cluster can be deleted.
enablePerformanceInsights?	`boolean`	A value that indicates whether to enable Performance Insights for the instances in the DB Cluster.
engineVersion?	`string`	What version of the database to start.
exportAuditLogsToCloudWatch?	`boolean`	Whether the audit logs should be exported to CloudWatch.
exportProfilerLogsToCloudWatch?	`boolean`	Whether the profiler logs should be exported to CloudWatch.
instanceIdentifierBase?	`string`	Base identifier for instances.
instanceRemovalPolicy?	`RemovalPolicy`	The removal policy to apply to the cluster's instances.
instances?	`number`	Number of DocDB compute instances.
kmsKey?	`IKey`	The KMS key for storage encryption.
parameterGroup?	`IClusterParameterGroup`	The DB parameter group to associate with the instance.
port?	`number`	The port the DocumentDB cluster will listen on.
preferredMaintenanceWindow?	`string`	A weekly time range in which maintenance should preferably execute.
removalPolicy?	`RemovalPolicy`	The removal policy to apply when the cluster and its instances are removed or replaced during a stack update, or when the stack is deleted.
securityGroup?	`ISecurityGroup`	Security group.
securityGroupRemovalPolicy?	`RemovalPolicy`	The removal policy to apply to the cluster's security group.
storageEncrypted?	`boolean`	Whether to enable storage encryption.
storageType?	`StorageType`	The storage type of the DocDB cluster.
vpcSubnets?	`SubnetSelection`	Where to place the instances within the VPC.

instanceType

Type: InstanceType

What type of instance to start for the replicas.

masterUser

Type: Login

Username and password for the administrative user.

vpc

Type: IVpc

What subnets to run the DocumentDB instances in.

Must be at least 2 subnets in two different AZs.

backup?

Type: BackupProps (optional, default: Backup retention period for automated backups is 1 day. Backup preferred window is set to a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.)

Backup settings.

caCertificate?

Type: CaCertificate (optional, default: DocumentDB will choose a certificate authority)

The identifier of the CA certificate used for the instances.

Specifying or updating this property triggers a reboot.

cloudWatchLogsRetention?

Type: RetentionDays (optional, default: logs never expire)

The number of days log events are kept in CloudWatch Logs.

When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to Infinity.

cloudWatchLogsRetentionRole?

Type: IRole (optional, default: a new role is created.)

The IAM role for the Lambda function associated with the custom resource that sets the retention policy.