interface DatabaseInstanceAttributes
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.RDS.DatabaseInstanceAttributes |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsrds#DatabaseInstanceAttributes |
Java | software.amazon.awscdk.services.rds.DatabaseInstanceAttributes |
Python | aws_cdk.aws_rds.DatabaseInstanceAttributes |
TypeScript (source) | aws-cdk-lib » aws_rds » DatabaseInstanceAttributes |
Properties that describe an existing instance.
Example
// 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
Name | Type | Description |
---|---|---|
instance | string | The endpoint address. |
instance | string | The instance identifier. |
port | number | The database port. |
security | ISecurity [] | The security groups of the instance. |
engine? | IInstance | The engine of the existing database Instance. |
instance | string | The AWS Region-unique, immutable identifier for the DB instance. |
instanceEndpointAddress
Type:
string
The endpoint address.
instanceIdentifier
Type:
string
The instance identifier.
port
Type:
number
The database port.
securityGroups
Type:
ISecurity
[]
The security groups of the instance.
engine?
Type:
IInstance
(optional, default: the imported Instance's engine is unknown)
The engine of the existing database Instance.
instanceResourceId?
Type:
string
(optional)
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.