1.204.0

interface CfnDBInstanceProps

LanguageType name
.NETAmazon.CDK.AWS.DocDB.CfnDBInstanceProps
Javasoftware.amazon.awscdk.services.docdb.CfnDBInstanceProps
Pythonaws_cdk.aws_docdb.CfnDBInstanceProps
TypeScript @aws-cdk/aws-docdb » CfnDBInstanceProps

Properties for defining a CfnDBInstance.

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 cfnDBInstanceProps: docdb.CfnDBInstanceProps = {
  dbClusterIdentifier: 'dbClusterIdentifier',
  dbInstanceClass: 'dbInstanceClass',

  // the properties below are optional
  autoMinorVersionUpgrade: false,
  availabilityZone: 'availabilityZone',
  dbInstanceIdentifier: 'dbInstanceIdentifier',
  enablePerformanceInsights: false,
  preferredMaintenanceWindow: 'preferredMaintenanceWindow',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
dbClusterIdentifierstringThe identifier of the cluster that the instance will belong to.
dbInstanceClassstringThe compute and memory capacity of the instance;
autoMinorVersionUpgrade?boolean | IResolvableThis parameter does not apply to Amazon DocumentDB.
availabilityZone?stringThe Amazon EC2 Availability Zone that the instance is created in.
dbInstanceIdentifier?stringThe instance identifier. This parameter is stored as a lowercase string.
enablePerformanceInsights?boolean | IResolvableAWS::DocDB::DBInstance.EnablePerformanceInsights.
preferredMaintenanceWindow?stringThe time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
tags?CfnTag[]The tags to be assigned to the instance.

dbClusterIdentifier

Type: string

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

dbInstanceClass

Type: 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.

autoMinorVersionUpgrade?

Type: boolean | IResolvable (optional)

This parameter does not apply to Amazon DocumentDB.

Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

availabilityZone?

Type: string (optional)

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

dbInstanceIdentifier?

Type: string (optional)

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

enablePerformanceInsights?

Type: boolean | IResolvable (optional)

AWS::DocDB::DBInstance.EnablePerformanceInsights.

preferredMaintenanceWindow?

Type: string (optional)

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.

tags?

Type: CfnTag[] (optional)

The tags to be assigned to the instance.

You can assign up to 10 tags to an instance.

← PreviousNext →