interface CfnDBClusterProps

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

Properties for defining a CfnDBCluster.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_docdb as docdb } from 'aws-cdk-lib';
const cfnDBClusterProps: docdb.CfnDBClusterProps = {
  availabilityZones: ['availabilityZones'],
  backupRetentionPeriod: 123,
  copyTagsToSnapshot: false,
  dbClusterIdentifier: 'dbClusterIdentifier',
  dbClusterParameterGroupName: 'dbClusterParameterGroupName',
  dbSubnetGroupName: 'dbSubnetGroupName',
  deletionProtection: false,
  enableCloudwatchLogsExports: ['enableCloudwatchLogsExports'],
  engineVersion: 'engineVersion',
  kmsKeyId: 'kmsKeyId',
  masterUsername: 'masterUsername',
  masterUserPassword: 'masterUserPassword',
  port: 123,
  preferredBackupWindow: 'preferredBackupWindow',
  preferredMaintenanceWindow: 'preferredMaintenanceWindow',
  restoreToTime: 'restoreToTime',
  restoreType: 'restoreType',
  serverlessV2ScalingConfiguration: {
    maxCapacity: 123,
    minCapacity: 123,
  },
  snapshotIdentifier: 'snapshotIdentifier',
  sourceDbClusterIdentifier: 'sourceDbClusterIdentifier',
  storageEncrypted: false,
  storageType: 'storageType',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  useLatestRestorableTime: false,
  vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
};

Properties

Name	Type	Description
availabilityZones?	`string[]`	A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
backupRetentionPeriod?	`number`	The number of days for which automated backups are retained. You must specify a minimum value of 1.
copyTagsToSnapshot?	`boolean \|` `IResolvable`	Set to `true` to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise `false` .
dbClusterIdentifier?	`string`	The cluster identifier. This parameter is stored as a lowercase string.
dbClusterParameterGroupName?	`string`	The name of the cluster parameter group to associate with this cluster.
dbSubnetGroupName?	`string`	A subnet group to associate with this cluster.
deletionProtection?	`boolean \|` `IResolvable`	Protects clusters from being accidentally deleted.
enableCloudwatchLogsExports?	`string[]`	The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.
engineVersion?	`string`	The version number of the database engine to use.
kmsKeyId?	`string`	The AWS KMS key identifier for an encrypted cluster.
masterUserPassword?	`string`	The password for the master database user.
masterUsername?	`string`	The name of the master user for the cluster.
port?	`number`	Specifies the port that the database engine is listening on.
preferredBackupWindow?	`string`	The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter.
preferredMaintenanceWindow?	`string`	The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
restoreToTime?	`string`	The date and time to restore the cluster to.
restoreType?	`string`	The type of restore to be performed. You can specify one of the following values:.
serverlessV2ScalingConfiguration?	`IResolvable` `\|` `ServerlessV2ScalingConfigurationProperty`
snapshotIdentifier?	`string`	The identifier for the snapshot or cluster snapshot to restore from.
sourceDbClusterIdentifier?	`string`	The identifier of the source cluster from which to restore.
storageEncrypted?	`boolean \|` `IResolvable`	Specifies whether the cluster is encrypted.
storageType?	`string`	The storage type to associate with the DB cluster.
tags?	`CfnTag[]`	The tags to be assigned to the cluster.
useLatestRestorableTime?	`boolean \|` `IResolvable`	A value that is set to `true` to restore the cluster to the latest restorable backup time, and `false` otherwise.
vpcSecurityGroupIds?	`string[]`	A list of EC2 VPC security groups to associate with this cluster.

availabilityZones?

Type: string[] (optional)

A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

backupRetentionPeriod?

Type: number (optional)

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

Must be a value from 1 to 35.

copyTagsToSnapshot?

Type: boolean | IResolvable (optional)

Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false .

The default is false .

dbClusterIdentifier?

Type: string (optional)

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster

dbClusterParameterGroupName?

Type: string (optional)

The name of the cluster parameter group to associate with this cluster.

dbSubnetGroupName?

Type: string (optional)

A subnet group to associate with this cluster.

Constraints: Must match the name of an existing DBSubnetGroup . Must not be default.

Example: mySubnetgroup

deletionProtection?

Type: boolean | IResolvable (optional)

Protects clusters from being accidentally deleted.

If enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled.

enableCloudwatchLogsExports?

Type: string[] (optional)

The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.

You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations .

engineVersion?

Type: string (optional)

The version number of the database engine to use.

The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

Changing the EngineVersion will start an in-place engine version upgrade. Note that in-place engine version upgrade will cause downtime in the cluster. See Amazon DocumentDB in-place major version upgrade before starting an in-place engine version upgrade.

kmsKeyId?

Type: string (optional)

The AWS KMS key identifier for an encrypted cluster.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If an encryption key is not specified in KmsKeyId :

If the StorageEncrypted parameter is true , Amazon DocumentDB uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Regions .

masterUserPassword?

Type: string (optional)

The password for the master database user.

This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

masterUsername?

Type: string (optional)

The name of the master user for the cluster.

Constraints:

Must be from 1 to 63 letters or numbers.
The first character must be a letter.
Cannot be a reserved word for the chosen database engine.

port?

Type: number (optional)

Specifies the port that the database engine is listening on.

preferredBackupWindow?

Type: string (optional)

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region .

Constraints:

Must be in the format hh24:mi-hh24:mi .
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

preferredMaintenanceWindow?

Type: string (optional)

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is 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.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

restoreToTime?

Type: string (optional)

The date and time to restore the cluster to.

Valid values: A time in Universal Coordinated Time (UTC) format.

Constraints:

Must be before the latest restorable time for the instance.
Must be specified if the UseLatestRestorableTime parameter is not provided.
Cannot be specified if the UseLatestRestorableTime parameter is true .
Cannot be specified if the RestoreType parameter is copy-on-write .

Example: 2015-03-07T23:45:00Z

restoreType?

Type: string (optional)

The type of restore to be performed. You can specify one of the following values:.

full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

serverlessV2ScalingConfiguration?

Type: IResolvable | ServerlessV2ScalingConfigurationProperty (optional)

snapshotIdentifier?

Type: string (optional)

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

Must match the identifier of an existing snapshot.

sourceDbClusterIdentifier?

Type: string (optional)

The identifier of the source cluster from which to restore.

Constraints:

Must match the identifier of an existing DBCluster .

storageEncrypted?

Type: boolean | IResolvable (optional)

Specifies whether the cluster is encrypted.

If you specify SourceDBClusterIdentifier or SnapshotIdentifier and don’t specify StorageEncrypted , the encryption property is inherited from the source cluster or snapshot (unless KMSKeyId is specified, in which case the restored cluster will be encrypted with that KMS key). If the source is encrypted and StorageEncrypted is specified to be true, the restored cluster will be encrypted (if you want to use a different KMS key, specify the KMSKeyId property as well). If the source is unencrypted and StorageEncrypted is specified to be true, then the KMSKeyId property must be specified. If the source is encrypted, don’t specify StorageEncrypted to be false as opting out of encryption is not allowed.

storageType?

Type: string (optional)

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide .

Valid values for storage type - standard | iopt1

Default value is standard

When you create a DocumentDB DB cluster with the storage type set to iopt1 , the storage type is returned in the response. The storage type isn't returned when you set it to standard .

tags?

Type: CfnTag[] (optional)

The tags to be assigned to the cluster.

useLatestRestorableTime?

Type: boolean | IResolvable (optional)

A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if the RestoreToTime parameter is provided.

vpcSecurityGroupIds?

Type: string[] (optional)

A list of EC2 VPC security groups to associate with this cluster.