AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::DocDB::DBInstance

CfnDBInstance

The `AWS::DocDB::DBInstance` Amazon DocumentDB (with MongoDB compatibility) resource describes a DBInstance. For more information, see [DBInstance](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBInstance.html) in the *Amazon DocumentDB Developer Guide* .

Import

import { CfnDBInstance } from 'aws-cdk-lib/aws-docdb';

Or use the module namespace:

import * as docdb from 'aws-cdk-lib/aws-docdb';
// docdb.CfnDBInstance

Properties

Configuration passed to the constructor as CfnDBInstanceProps.

dbClusterIdentifierRequired
string

The identifier of the cluster that the instance will belong to.

dbInstanceClassRequired
string

The compute and memory capacity of the instance; for example, `db.m4.large` . If you change the class of an instance there can be some interruption in the cluster's service.

autoMinorVersionUpgradeOptional
boolean | IResolvable

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set. Default: `false`

availabilityZoneOptional
string

The Amazon EC2 Availability Zone that the instance is created in. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region . Example: `us-east-1d`

caCertificateIdentifierOptional
string

The identifier of the CA certificate for this DB instance.

certificateRotationRestartOptional
boolean | IResolvable

Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. > Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, see [Updating Your Amazon DocumentDB TLS Certificates](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) and [Encrypting Data in Transit](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) in the *Amazon DocumentDB Developer Guide* .

dbInstanceIdentifierOptional
string

The instance 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: `mydbinstance`

enablePerformanceInsightsOptional
boolean | IResolvable

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) .

preferredMaintenanceWindowOptional
string

The time range each week 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.

tagsOptional
CfnTag[]

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

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