AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::DocDBElastic::Cluster

CfnCluster

Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.

Import

import { CfnCluster } from 'aws-cdk-lib/aws-docdbelastic';

Or use the module namespace:

import * as docdbelastic from 'aws-cdk-lib/aws-docdbelastic';
// docdbelastic.CfnCluster

Properties

Configuration passed to the constructor as CfnClusterProps.

adminUserNameRequired
string

The name of the Amazon DocumentDB elastic clusters administrator. *Constraints* : - Must be from 1 to 63 letters or numbers. - The first character must be a letter. - Cannot be a reserved word.

authTypeRequired
string

The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are `PLAIN_TEXT` or `SECRET_ARN` .

clusterNameRequired
string

The name of the new elastic cluster. 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`

shardCapacityRequired
number

The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

shardCountRequired
number

The number of shards assigned to the elastic cluster. Maximum is 32.

adminUserPasswordOptional
string

The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters. *Constraints* : - Must contain from 8 to 100 characters. - Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@). - A valid `AdminUserName` entry is also required.

backupRetentionPeriodOptional
number

The number of days for which automatic snapshots are retained.

kmsKeyIdOptional
string | IKeyRef

The KMS key identifier to use to encrypt the new elastic cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

preferredBackupWindowOptional
string

The daily time range during which automated backups are created if automated backups are enabled, as determined by `backupRetentionPeriod` .

preferredMaintenanceWindowOptional
string

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). *Format* : `ddd:hh24:mi-ddd:hh24:mi` *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. *Valid days* : Mon, Tue, Wed, Thu, Fri, Sat, Sun *Constraints* : Minimum 30-minute window.

shardInstanceCountOptional
number

The number of replica instances applying to all shards in the cluster. A `shardInstanceCount` value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

subnetIdsOptional
string[]

The Amazon EC2 subnet IDs for the new elastic cluster.

tagsOptional
CfnTag[]

The tags to be assigned to the new elastic cluster.

vpcSecurityGroupIdsOptional
string | ISecurityGroupRef[]

A list of EC2 VPC security groups to associate with the new elastic cluster.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-docdbelastic
CFN TypeAWS::DocDBElastic::Cluster
Properties14

External Links