DatabaseClusterProps Struct
Properties for a new database cluster.
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,
deletionProtection: true, // Enable deletion protection.
});
Properties
backupoptionalBackupPropsbackupoptionalBackupPropsbackupoptionalBackupPropsBackupoptionalBackupPropsBackupoptionalBackupProps#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.
caCertificateoptionalCaCertificateca_certificateoptionalCaCertificatecaCertificateoptionalCaCertificateCaCertificateoptionalCaCertificateCaCertificateoptionalCaCertificate#Default: DocumentDB will choose a certificate authority
Specifying or updating this property triggers a reboot.
cloudWatchLogsRetentionoptionalRetentionDayscloud_watch_logs_retentionoptionalRetentionDayscloudWatchLogsRetentionoptionalRetentionDaysCloudWatchLogsRetentionoptionalRetentionDaysCloudWatchLogsRetentionoptionalRetentionDays#Default: logs never expire
When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to Infinity.
cloudWatchLogsRetentionRoleoptionalIRolecloud_watch_logs_retention_roleoptionalIRolecloudWatchLogsRetentionRoleoptionalIRoleCloudWatchLogsRetentionRoleoptionalIRoleCloudWatchLogsRetentionRoleoptionalIRole#Default: a new role is created.
copyTagsToSnapshotoptionalbooleancopy_tags_to_snapshotoptionalboolcopyTagsToSnapshotoptionalBooleanCopyTagsToSnapshotoptionalboolCopyTagsToSnapshotoptional*bool= false#dbClusterNameoptionalstringdb_cluster_nameoptionalstrdbClusterNameoptionalStringDbClusterNameoptionalstringDbClusterNameoptional*string#Default: A name is automatically generated.
deletionProtectionoptionalbooleandeletion_protectionoptionalbooldeletionProtectionoptionalBooleanDeletionProtectionoptionalboolDeletionProtectionoptional*bool= false#If deletionProtection is enabled, the cluster cannot be deleted unless it is modified and deletionProtection is disabled. deletionProtection protects clusters from being accidentally deleted.
enablePerformanceInsightsoptionalbooleanenable_performance_insightsoptionalboolenablePerformanceInsightsoptionalBooleanEnablePerformanceInsightsoptionalboolEnablePerformanceInsightsoptional*bool= false#engineVersionoptionalstringengine_versionoptionalstrengineVersionoptionalStringEngineVersionoptionalstringEngineVersionoptional*string#Default: the latest major version
exportAuditLogsToCloudWatchoptionalbooleanexport_audit_logs_to_cloud_watchoptionalboolexportAuditLogsToCloudWatchoptionalBooleanExportAuditLogsToCloudWatchoptionalboolExportAuditLogsToCloudWatchoptional*bool= false#Note that you also have to configure the audit log export in the Cluster's Parameter Group.
exportProfilerLogsToCloudWatchoptionalbooleanexport_profiler_logs_to_cloud_watchoptionalboolexportProfilerLogsToCloudWatchoptionalBooleanExportProfilerLogsToCloudWatchoptionalboolExportProfilerLogsToCloudWatchoptional*bool= false#Note that you also have to configure the profiler log export in the Cluster's Parameter Group.
instanceIdentifierBaseoptionalstringinstance_identifier_baseoptionalstrinstanceIdentifierBaseoptionalStringInstanceIdentifierBaseoptionalstringInstanceIdentifierBaseoptional*string#Default: dbClusterName is used with the word "Instance" appended. If dbClusterName is not provided, the identifier is automatically generated.
Every replica is named by appending the replica number to this string, 1-based. Only applicable for provisioned clusters.
instanceMaintenanceWindowoptionalstringinstance_maintenance_windowoptionalstrinstanceMaintenanceWindowoptionalStringInstanceMaintenanceWindowoptionalstringInstanceMaintenanceWindowoptional*string#Default: 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.
notes
The cluster-level preferredMaintenanceWindow applies to cluster-wide maintenance events; this prop applies to each auto-created instance independently. To use the same window for both, set this prop to the same value as preferredMaintenanceWindow.
Format: ddd:hh24:mi-ddd:hh24:mi. Must be at least 30 minutes long. Example: 'sat:09:00-sat:09:30'
Only applicable to provisioned clusters; has no effect on serverless clusters because they do not create instances.
instanceRemovalPolicyoptionalRemovalPolicyinstance_removal_policyoptionalRemovalPolicyinstanceRemovalPolicyoptionalRemovalPolicyInstanceRemovalPolicyoptionalRemovalPolicyInstanceRemovalPolicyoptionalRemovalPolicy#Default: RemovalPolicy.DESTROY when removalPolicy is set to SNAPSHOT, removalPolicy otherwise.
Cannot be set to SNAPSHOT.
instancesoptionalnumberinstancesoptionalint | floatinstancesoptionalNumberInstancesoptionaldoubleInstancesoptional*float64= 1#instanceTypeoptionalInstanceTypeinstance_typeoptionalInstanceTypeinstanceTypeoptionalInstanceTypeInstanceTypeoptionalInstanceTypeInstanceTypeoptionalInstanceType= None#Required for provisioned clusters, not applicable for serverless clusters.
Default: default master key.
manageMasterUserPasswordoptionalbooleanmanage_master_user_passwordoptionalboolmanageMasterUserPasswordoptionalBooleanManageMasterUserPasswordoptionalboolManageMasterUserPasswordoptional*bool= false#notes
When set to true, Amazon DocumentDB will automatically generate and manage the master user password in AWS Secrets Manager. This provides enhanced security and automatic password rotation capabilities.
Constraint: You can't manage the master user password with AWS Secrets Manager if masterUser.password is specified.
The secret property of the cluster is not set when using this option. See the module README for how to access the managed secret.
masterUserSecretKmsKeyoptionalIKeymaster_user_secret_kms_keyoptionalIKeymasterUserSecretKmsKeyoptionalIKeyMasterUserSecretKmsKeyoptionalIKeyMasterUserSecretKmsKeyoptionalIKey#Default: default AWS managed key aws/secretsmanager
notes
This setting is valid only if the master user password is managed by Amazon DocumentDB in AWS Secrets Manager for the DB cluster (i.e. when manageMasterUserPassword is true). If you don't specify this property, then the aws/secretsmanager KMS key is used to encrypt the secret.
parameterGroupoptionalIDBClusterParameterGroupRefparameter_groupoptionalIDBClusterParameterGroupRefparameterGroupoptionalIDBClusterParameterGroupRefParameterGroupoptionalIDBClusterParameterGroupRefParameterGroupoptionalIDBClusterParameterGroupRef#Default: no parameter group
portoptionalnumberportoptionalint | floatportoptionalNumberPortoptionaldoublePortoptional*float64= DatabaseCluster.DEFAULT_PORT#preferredMaintenanceWindowoptionalstringpreferred_maintenance_windowoptionalstrpreferredMaintenanceWindowoptionalStringPreferredMaintenanceWindowoptionalstringPreferredMaintenanceWindowoptional*string#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.
Must be at least 30 minutes long.
Example: 'tue:04:17-tue:04:47'
removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy#Default: Retain cluster.
notes
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.
securityGroupoptionalISecurityGroupsecurity_groupoptionalISecurityGroupsecurityGroupoptionalISecurityGroupSecurityGroupoptionalISecurityGroupSecurityGroupoptionalISecurityGroup#Default: a new security group is created.
securityGroupRemovalPolicyoptionalRemovalPolicysecurity_group_removal_policyoptionalRemovalPolicysecurityGroupRemovalPolicyoptionalRemovalPolicySecurityGroupRemovalPolicyoptionalRemovalPolicySecurityGroupRemovalPolicyoptionalRemovalPolicy#Default: RemovalPolicy.DESTROY when removalPolicy is set to SNAPSHOT, removalPolicy otherwise.
Cannot be set to SNAPSHOT.
serverlessV2ScalingConfigurationoptionalServerlessV2ScalingConfigurationserverless_v2_scaling_configurationoptionalServerlessV2ScalingConfigurationserverlessV2ScalingConfigurationoptionalServerlessV2ScalingConfigurationServerlessV2ScalingConfigurationoptionalServerlessV2ScalingConfigurationServerlessV2ScalingConfigurationoptionalServerlessV2ScalingConfiguration= None#When specified, the cluster will be created as a serverless cluster.
storageEncryptedoptionalbooleanstorage_encryptedoptionalboolstorageEncryptedoptionalBooleanStorageEncryptedoptionalboolStorageEncryptedoptional*bool= true#storageTypeoptionalStorageTypestorage_typeoptionalStorageTypestorageTypeoptionalStorageTypeStorageTypeoptionalStorageTypeStorageTypeoptionalStorageType= StorageType.STANDARD#I/O-optimized storage is supported starting with engine version 5.0.0.
Must be at least 2 subnets in two different AZs.
vpcSubnetsoptionalSubnetSelectionvpc_subnetsoptionalSubnetSelectionvpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelection#Default: private subnets