# DatabaseInstance A database instance. Extends: Construct › Resource › DatabaseInstance Implements: IResource, IDatabaseInstance, IEnvironmentAware, IDBInstanceRef, IConstruct, IDependable - CloudFormation: [`AWS::DocDB::DBInstance`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-docdb-dbinstance.html) - L1 type: [`CfnDBInstance`](/cdk/api/v2/docs/aws-cdk-lib.aws_docdb.CfnDBInstance.html) - Source: [`aws-docdb/lib/instance.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-docdb/lib/instance.ts#L207) - Type last changed: v2.235.0 · 15 Jan 2026 ## Example ```ts // The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import * as cdk from 'aws-cdk-lib'; import { aws_docdb as docdb } from 'aws-cdk-lib'; import { aws_ec2 as ec2 } from 'aws-cdk-lib'; import { aws_rds as rds } from 'aws-cdk-lib'; import { aws_docdb as interfaces_docdb } from 'aws-cdk-lib/interfaces'; declare const caCertificate: rds.CaCertificate; declare const dBClusterRef: interfaces_docdb.IDBClusterRef; declare const instanceType: ec2.InstanceType; const databaseInstance = new docdb.DatabaseInstance(this, 'MyDatabaseInstance', { cluster: dBClusterRef, instanceType: instanceType, // the properties below are optional autoMinorVersionUpgrade: false, availabilityZone: 'availabilityZone', caCertificate: caCertificate, dbInstanceName: 'dbInstanceName', enablePerformanceInsights: false, preferredMaintenanceWindow: 'preferredMaintenanceWindow', removalPolicy: cdk.RemovalPolicy.DESTROY, }); ``` ## Initializer ```ts new DatabaseInstance(scope: Construct, id: string, props: DatabaseInstanceProps) ``` ## Construct Props - `autoMinorVersionUpgrade`: boolean = true — Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window. - `availabilityZone`: string — The name of the Availability Zone where the DB instance will be located. **Default:** no preference - `caCertificate`: [CaCertificate](/cdk/api/v2/docs/aws-cdk-lib.aws_rds.CaCertificate.html) — The identifier of the CA certificate for this DB instance. **Default:** DocumentDB will choose a certificate authority Specifying or updating this property triggers a reboot. - `cluster`: [IDBClusterRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_docdb.IDBClusterRef.html) (required) — The DocumentDB database cluster the instance should launch into. - `dbInstanceName`: string — A name for the DB instance. **Default:** a CloudFormation generated name If you specify a name, AWS CloudFormation converts it to lowercase. - `enablePerformanceInsights`: boolean = false — A value that indicates whether to enable Performance Insights for the DB Instance. - `instanceType`: [InstanceType](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.InstanceType.html) (required) — The name of the compute and memory capacity classes. - `preferredMaintenanceWindow`: string — The weekly time range (in UTC) during which system maintenance can occur. **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. To see the time blocks available, see https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html#maintenance-window Format: `ddd:hh24:mi-ddd:hh24:mi` Constraint: Minimum 30-minute window - `removalPolicy`: [RemovalPolicy](/cdk/api/v2/docs/aws-cdk-lib.RemovalPolicy.html) = RemovalPolicy.Retain — The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update. ## Properties - `cluster`: [IDatabaseCluster](/cdk/api/v2/docs/aws-cdk-lib.aws_docdb.IDatabaseCluster.html) (required) — The instance's database cluster. - `dbInstanceEndpointAddress`: string (required) — The instance endpoint address. - `dbInstanceEndpointPort`: string (required) — The instance endpoint port. - `dbInstanceRef`: [DBInstanceReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_docdb.DBInstanceReference.html) (required) — A reference to this instance. - `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required) — The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be different than the stack they were imported into. - `instanceArn`: string (required) — The instance arn. - `instanceEndpoint`: [Endpoint](/cdk/api/v2/docs/aws-cdk-lib.aws_docdb.Endpoint.html) (required) — The instance endpoint. - `instanceIdentifier`: string (required) — The instance identifier. - `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node. - `PROPERTY_INJECTION_ID`: string (required) (static) — Uniquely identifies this class. - `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this resource is defined. ## Methods - `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource. When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default. **Parameters** - `strength` — - The reference strength to use for this resource. - `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource. 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`). - `fromDatabaseInstanceAttributes(scope: Construct, id: string, attrs: DatabaseInstanceAttributes): IDatabaseInstance` (static) — Import an existing database instance. - `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. **Parameters** - `x` — Any object. **Returns:** true if `x` is an object created from a class which extends `Construct`. - `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise. - `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource. - `toString(): string` — Returns a string representation of this construct. - `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs.