Skip to content
v2.273.0

DatabaseInstanceAttributes Struct ​

Properties that describe an existing instance.

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 databaseInstanceAttributes: rds.DatabaseInstanceAttributes = {
  instanceEndpointAddress: 'instanceEndpointAddress',
  instanceIdentifier: 'instanceIdentifier',
  port: 123,
  securityGroups: [securityGroup],

  // the properties below are optional
  engine: instanceEngine,
  instanceResourceId: 'instanceResourceId',
};

Properties ​

engineIInstanceEngineengineIInstanceEngineengineIInstanceEngineEngineIInstanceEngineEngineIInstanceEngine= the imported Instance's engine i…#
The engine of the existing database Instance.
default

Default: the imported Instance's engine is unknown

instanceEndpointAddressstringinstance_endpoint_addressstrinstanceEndpointAddressStringInstanceEndpointAddressstringInstanceEndpointAddress*stringrequired#
The endpoint address.
instanceIdentifierstringinstance_identifierstrinstanceIdentifierStringInstanceIdentifierstringInstanceIdentifier*stringrequired#
The instance identifier.
instanceResourceIdstringinstance_resource_idstrinstanceResourceIdStringInstanceResourceIdstringInstanceResourceId*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.

portnumberportint | floatportNumberPortdoublePort*float64required#
The database port.
securityGroupsISecurityGroup[]security_groupstyping.List[ISecurityGroup]securityGroupsList<ISecurityGroup>SecurityGroupsISecurityGroup[]SecurityGroups*[]ISecurityGrouprequired#
The security groups of the instance.