DatabaseCluster
Create a clustered database with a given number of instances.
Import
import { DatabaseCluster } from 'aws-cdk-lib/aws-docdb';Or use the module namespace:
import * as docdb from 'aws-cdk-lib/aws-docdb';
// docdb.DatabaseClusterProperties
Configuration passed to the constructor as DatabaseClusterProps.
masterUserRequiredLoginUsername and password for the administrative user.
vpcRequiredIVpcWhat subnets to run the DocumentDB instances in. Must be at least 2 subnets in two different AZs.
backupOptionalBackupPropsBackup settings.
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.
caCertificateOptionalCaCertificateThe identifier of the CA certificate used for the instances. Specifying or updating this property triggers a reboot.
Default: - DocumentDB will choose a certificate authority
cloudWatchLogsRetentionOptionalRetentionDaysThe 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`.
Default: - logs never expire
cloudWatchLogsRetentionRoleOptionalIRoleThe IAM role for the Lambda function associated with the custom resource that sets the retention policy.
Default: - a new role is created.
copyTagsToSnapshotOptionalbooleanWhether to copy tags to the snapshot when a snapshot is created.
Default: - false
dbClusterNameOptionalstringAn optional identifier for the cluster.
Default: - A name is automatically generated.
deletionProtectionOptionalbooleanSpecifies whether this cluster can be deleted. If deletionProtection is enabled, the cluster cannot be deleted unless it is modified and deletionProtection is disabled. deletionProtection protects clusters from being accidentally deleted.
Default: - false
enablePerformanceInsightsOptionalbooleanA value that indicates whether to enable Performance Insights for the instances in the DB Cluster.
Default: - false
engineVersionOptionalstringWhat version of the database to start.
Default: - the latest major version
exportAuditLogsToCloudWatchOptionalbooleanWhether the audit logs should be exported to CloudWatch. Note that you also have to configure the audit log export in the Cluster's Parameter Group.
Default: false
exportProfilerLogsToCloudWatchOptionalbooleanWhether the profiler logs should be exported to CloudWatch. Note that you also have to configure the profiler log export in the Cluster's Parameter Group.
Default: false
instanceIdentifierBaseOptionalstringBase identifier for instances. Every replica is named by appending the replica number to this string, 1-based. Only applicable for provisioned clusters.
Default: - `dbClusterName` is used with the word "Instance" appended. If `dbClusterName` is not provided, the
identifier is automatically generated.
instanceRemovalPolicyOptionalRemovalPolicyThe removal policy to apply to the cluster's instances. Cannot be set to `SNAPSHOT`.
Default: - `RemovalPolicy.DESTROY` when `removalPolicy` is set to `SNAPSHOT`, `removalPolicy` otherwise.
instancesOptionalnumberNumber of DocDB compute instances.
Default: 1
instanceTypeOptionalInstanceTypeWhat type of instance to start for the replicas. Required for provisioned clusters, not applicable for serverless clusters.
Default: None
kmsKeyOptionalIKeyThe KMS key for storage encryption.
Default: - default master key.
parameterGroupOptionalIDBClusterParameterGroupRefThe DB parameter group to associate with the instance.
Default: no parameter group
portOptionalnumberThe port the DocumentDB cluster will listen on.
Default: DatabaseCluster.DEFAULT_PORT
preferredMaintenanceWindowOptionalstringA weekly time range in which maintenance should preferably execute. Must be at least 30 minutes long. Example: 'tue:04:17-tue:04:47'
Default: - 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.
removalPolicyOptionalRemovalPolicyThe removal policy to apply when the cluster and its instances are removed or replaced during a stack update, or when the stack is deleted. This removal policy also applies to the implicit security group created for the cluster if one is not supplied as a parameter. When set to `SNAPSHOT`, the removal policy for the instances and the security group will default to `DESTROY` as those resources do not support the policy. Use the `instanceRemovalPolicy` and `securityGroupRemovalPolicy` to change the behavior.
Default: - Retain cluster.
securityGroupOptionalISecurityGroupSecurity group.
Default: a new security group is created.
securityGroupRemovalPolicyOptionalRemovalPolicyThe removal policy to apply to the cluster's security group. Cannot be set to `SNAPSHOT`.
Default: - `RemovalPolicy.DESTROY` when `removalPolicy` is set to `SNAPSHOT`, `removalPolicy` otherwise.
serverlessV2ScalingConfigurationOptionalServerlessV2ScalingConfigurationServerlessV2 scaling configuration. When specified, the cluster will be created as a serverless cluster.
Default: None
storageEncryptedOptionalbooleanWhether to enable storage encryption.
Default: true
storageTypeOptionalStorageTypeThe storage type of the DocDB cluster. I/O-optimized storage is supported starting with engine version 5.0.0.
Default: StorageType.STANDARD
vpcSubnetsOptionalSubnetSelectionWhere to place the instances within the VPC.
Default: private subnets
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-docdb