class CfnDBCluster (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.DocDB.CfnDBCluster`
Java	`software.amazon.awscdk.services.docdb.CfnDBCluster`
Python	`aws_cdk.aws_docdb.CfnDBCluster`
TypeScript	`@aws-cdk/aws-docdb` » `CfnDBCluster`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::DocDB::DBCluster.

The AWS::DocDB::DBCluster Amazon DocumentDB (with MongoDB compatibility) resource describes a DBCluster. Amazon DocumentDB is a fully managed, MongoDB-compatible document database engine. For more information, see DBCluster in the Amazon DocumentDB Developer Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as docdb from '@aws-cdk/aws-docdb';
const cfnDBCluster = new docdb.CfnDBCluster(this, 'MyCfnDBCluster', /* all optional props */ {
  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',
  snapshotIdentifier: 'snapshotIdentifier',
  sourceDbClusterIdentifier: 'sourceDbClusterIdentifier',
  storageEncrypted: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  useLatestRestorableTime: false,
  vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
});

Initializer

new CfnDBCluster(scope: Construct, id: string, props?: CfnDBClusterProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnDBClusterProps — - resource properties.

Create a new AWS::DocDB::DBCluster.

Construct Props

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`	`AWS::DocDB::DBCluster.CopyTagsToSnapshot`.
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`	`AWS::DocDB::DBCluster.RestoreToTime`.
restoreType?	`string`	`AWS::DocDB::DBCluster.RestoreType`.
snapshotIdentifier?	`string`	The identifier for the snapshot or cluster snapshot to restore from.
sourceDbClusterIdentifier?	`string`	`AWS::DocDB::DBCluster.SourceDBClusterIdentifier`.
storageEncrypted?	`boolean \|` `IResolvable`	Specifies whether the cluster is encrypted.
tags?	`CfnTag[]`	The tags to be assigned to the cluster.
useLatestRestorableTime?	`boolean \|` `IResolvable`	`AWS::DocDB::DBCluster.UseLatestRestorableTime`.
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)

AWS::DocDB::DBCluster.CopyTagsToSnapshot.

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.

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)

AWS::DocDB::DBCluster.RestoreToTime.

restoreType?

Type: string (optional)

AWS::DocDB::DBCluster.RestoreType.

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)

AWS::DocDB::DBCluster.SourceDBClusterIdentifier.

storageEncrypted?

Type: boolean | IResolvable (optional)

Specifies whether the cluster is encrypted.

tags?

Type: CfnTag[] (optional)

The tags to be assigned to the cluster.

useLatestRestorableTime?

Type: boolean | IResolvable (optional)

AWS::DocDB::DBCluster.UseLatestRestorableTime.

vpcSecurityGroupIds?

Type: string[] (optional)

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

Properties

Name	Type	Description
attrClusterResourceId	`string`	The resource id for the cluster;
attrEndpoint	`string`	The connection endpoint for the cluster, such as `sample-cluster.cluster-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com` .
attrPort	`string`	The port number on which the cluster accepts connections.
attrReadEndpoint	`string`	The reader endpoint for the cluster.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	The tags to be assigned to the cluster.
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`	`AWS::DocDB::DBCluster.CopyTagsToSnapshot`.
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`	`AWS::DocDB::DBCluster.RestoreToTime`.
restoreType?	`string`	`AWS::DocDB::DBCluster.RestoreType`.
snapshotIdentifier?	`string`	The identifier for the snapshot or cluster snapshot to restore from.
sourceDbClusterIdentifier?	`string`	`AWS::DocDB::DBCluster.SourceDBClusterIdentifier`.
storageEncrypted?	`boolean \|` `IResolvable`	Specifies whether the cluster is encrypted.
useLatestRestorableTime?	`boolean \|` `IResolvable`	`AWS::DocDB::DBCluster.UseLatestRestorableTime`.
vpcSecurityGroupIds?	`string[]`	A list of EC2 VPC security groups to associate with this cluster.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrClusterResourceId

Type: string

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.

attrEndpoint

Type: string

The connection endpoint for the cluster, such as sample-cluster.cluster-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com .

attrPort

Type: string

The port number on which the cluster accepts connections.

For example: 27017 .

attrReadEndpoint

Type: string

The reader endpoint for the cluster.

For example: sample-cluster.cluster-ro-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com .

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

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)

AWS::DocDB::DBCluster.CopyTagsToSnapshot.

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.

kmsKeyId?

Type: string (optional)

The AWS KMS key identifier for an encrypted cluster.

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)

AWS::DocDB::DBCluster.RestoreToTime.

restoreType?

Type: string (optional)

AWS::DocDB::DBCluster.RestoreType.

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)

AWS::DocDB::DBCluster.SourceDBClusterIdentifier.

storageEncrypted?

Type: boolean | IResolvable (optional)

Specifies whether the cluster is encrypted.

useLatestRestorableTime?

Type: boolean | IResolvable (optional)

AWS::DocDB::DBCluster.UseLatestRestorableTime.

vpcSecurityGroupIds?

Type: string[] (optional)

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

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }