# DatabaseInstanceBase A new or imported database instance. Extends: Construct › Resource › DatabaseInstanceBase Implements: IResource, IConnectable, IDatabaseInstance, ISecretAttachmentTarget, IEnvironmentAware, IDBInstanceRef, IConstruct, IDependable Superclass of: DatabaseInstance, DatabaseInstanceFromSnapshot, DatabaseInstanceReadReplica - Source: [`aws-rds/lib/instance.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-rds/lib/instance.ts#L149) - 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 { aws_ec2 as ec2 } from 'aws-cdk-lib'; import { aws_rds as rds } from 'aws-cdk-lib'; declare const instanceEngine: rds.IInstanceEngine; declare const securityGroup: ec2.SecurityGroup; const databaseInstanceBase = rds.DatabaseInstanceBase.fromDatabaseInstanceAttributes(this, 'MyDatabaseInstanceBase', { instanceEndpointAddress: 'instanceEndpointAddress', instanceIdentifier: 'instanceIdentifier', port: 123, securityGroups: [securityGroup], // the properties below are optional engine: instanceEngine, instanceResourceId: 'instanceResourceId', }); ``` ## Initializer ```ts new DatabaseInstanceBase(scope: Construct, id: string, props?: ResourceProps) ``` ## Construct Props - `account`: string = the resource is in the same account as the stack it belongs to — The AWS account ID this resource belongs to. **Default:** the resource is in the same account as the stack it belongs to - `environmentFromArn`: string = take environment from `account`, `region` parameters, or use Stack environment. — ARN to deduce region and account from. The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources. Cannot be supplied together with either `account` or `region`. **Default:** take environment from `account`, `region` parameters, or use Stack environment. - `physicalName`: string = The physical name will be allocated by CloudFormation at deployment time — The value passed in by users to the physical name prop of the resource. - `undefined` implies that a physical name will be allocated by CloudFormation during deployment. - a concrete value implies a specific physical name - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation. **Default:** The physical name will be allocated by CloudFormation at deployment time - `region`: string = the resource is in the same region as the stack it belongs to — The AWS region this resource belongs to. **Default:** the resource is in the same region as the stack it belongs to ## Properties - `connections`: [Connections](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.Connections.html) (required) — Access to network connections. - `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_rds.DBInstanceReference.html) (required) — A reference to this database instance. - `engine`: [IInstanceEngine](/cdk/api/v2/docs/aws-cdk-lib.aws_rds.IInstanceEngine.html) — The engine of this database Instance. May be not known for imported Instances if it wasn't provided explicitly, or for read replicas. - `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_rds.Endpoint.html) (required) — The instance endpoint. - `instanceIdentifier`: string (required) — The instance identifier. - `instanceResourceId`: string — The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed. - `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node. - `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this resource is defined. ## Methods - `addProxy(id: string, options: DatabaseProxyOptions): DatabaseProxy` — Add a new db proxy to this instance. - `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`). - `asSecretAttachmentTarget(): SecretAttachmentTargetProps` — Renders the secret attachment target specifications. - `fromDatabaseInstanceAttributes(scope: Construct, id: string, attrs: DatabaseInstanceAttributes): IDatabaseInstance` (static) — Import an existing database instance. - `fromLookup(scope: Construct, id: string, options: DatabaseInstanceLookupOptions): IDatabaseInstance` (static) — Lookup an existing DatabaseInstance using instanceIdentifier. - `grantConnect(grantee: IGrantable, dbUser?: string): Grant` — [disable-awslint:no-grants]. - `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. - `metric(metricName: string, props?: MetricOptions): Metric` — Return the given named metric for this DBInstance. - `metricCPUUtilization(props?: MetricOptions): Metric` — The percentage of CPU utilization. Average over 5 minutes - `metricDatabaseConnections(props?: MetricOptions): Metric` — The number of database connections in use. Average over 5 minutes - `metricFreeableMemory(props?: MetricOptions): Metric` — The amount of available random access memory. Average over 5 minutes - `metricFreeStorageSpace(props?: MetricOptions): Metric` — The amount of available storage space. Average over 5 minutes - `metricReadIOPS(props?: MetricOptions): Metric` — The average number of disk read I/O operations per second. The average number of disk write I/O operations per second. Average over 5 minutes - `metricWriteIOPS(props?: MetricOptions): Metric` — The average number of disk write I/O operations per second. The average number of disk read I/O operations per second. Average over 5 minutes - `onEvent(id: string, options?: OnEventOptions): Rule` — Defines a CloudWatch event rule which triggers for instance events. Use `rule.addEventPattern(pattern)` to specify a filter. - `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.