AWS CDK Reference

Appearance

v2.275.0

CfnDBInstanceProps Struct ​

Properties for defining a CfnDBInstance.

Source
Generated code
Type last changed
v2.114.0 · 5 Dec 2023

Example ​

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

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

Properties ​

autoMinorVersionUpgradeoptionalboolean | IResolvableauto_minor_version_upgradeoptionaltyping.Union[bool, IResolvable]autoMinorVersionUpgradeoptionalBooleanAutoMinorVersionUpgradeoptionalboolAutoMinorVersionUpgradeoptionalinterface{}#
This parameter does not apply to Amazon DocumentDB.

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

Default: false

availabilityZoneoptionalstringavailability_zoneoptionalstravailabilityZoneoptionalStringAvailabilityZoneoptionalstringAvailabilityZoneoptional*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

caCertificateIdentifieroptionalstringca_certificate_identifieroptionalstrcaCertificateIdentifieroptionalStringCaCertificateIdentifieroptionalstringCaCertificateIdentifieroptional*string#
The identifier of the CA certificate for this DB instance.
certificateRotationRestartoptionalboolean | IResolvablecertificate_rotation_restartoptionaltyping.Union[bool, IResolvable]certificateRotationRestartoptionalBooleanCertificateRotationRestartoptionalboolCertificateRotationRestartoptionalinterface{}#
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
notes

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 and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide .

dbClusterIdentifierstringdb_cluster_identifierstrdbClusterIdentifierStringDbClusterIdentifierstringDbClusterIdentifier*stringrequired#
The identifier of the cluster that the instance will belong to.
dbInstanceClassstringdb_instance_classstrdbInstanceClassStringDbInstanceClassstringDbInstanceClass*stringrequired#
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.

dbInstanceIdentifieroptionalstringdb_instance_identifieroptionalstrdbInstanceIdentifieroptionalStringDbInstanceIdentifieroptionalstringDbInstanceIdentifieroptional*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

enablePerformanceInsightsoptionalboolean | IResolvableenable_performance_insightsoptionaltyping.Union[bool, IResolvable]enablePerformanceInsightsoptionalBooleanEnablePerformanceInsightsoptionalboolEnablePerformanceInsightsoptionalinterface{}#
A value that indicates whether to enable Performance Insights for the DB Instance.

For more information, see Using Amazon Performance Insights .

preferredMaintenanceWindowoptionalstringpreferred_maintenance_windowoptionalstrpreferredMaintenanceWindowoptionalStringPreferredMaintenanceWindowoptionalstringPreferredMaintenanceWindowoptional*string#
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
notes

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.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags to be assigned to the instance.

You can assign up to 10 tags to an instance.