Interface IDatabaseInstanceAttributes

Properties that describe an existing instance.

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IDatabaseInstanceAttributes

Syntax (vb)

Public Interface IDatabaseInstanceAttributes

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.RDS;

IInstanceEngine instanceEngine;
SecurityGroup securityGroup;

var databaseInstanceAttributes = new DatabaseInstanceAttributes {
    InstanceEndpointAddress = "instanceEndpointAddress",
    InstanceIdentifier = "instanceIdentifier",
    Port = 123,
    SecurityGroups = new [] { securityGroup },

    // the properties below are optional
    Engine = instanceEngine,
    InstanceResourceId = "instanceResourceId"
};

Synopsis

Properties

Engine	The engine of the existing database Instance.
InstanceEndpointAddress	The endpoint address.
InstanceIdentifier	The instance identifier.
InstanceResourceId	The AWS Region-unique, immutable identifier for the DB instance.
Port	The database port.
SecurityGroups	The security groups of the instance.

Properties

Engine

The engine of the existing database Instance.

virtual IInstanceEngine Engine { get; }

Property Value

IInstanceEngine

Remarks

Default: - the imported Instance's engine is unknown

InstanceEndpointAddress

The endpoint address.

string InstanceEndpointAddress { get; }

Property Value

System.String

InstanceIdentifier

The instance identifier.

string InstanceIdentifier { get; }

Property Value

System.String

InstanceResourceId

The AWS Region-unique, immutable identifier for the DB instance.

virtual string InstanceResourceId { get; }

Property Value

System.String

Remarks

This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#aws-resource-rds-dbinstance-return-values

Port

The database port.

double Port { get; }

Property Value

System.Double

SecurityGroups

The security groups of the instance.

ISecurityGroup[] SecurityGroups { get; }

Property Value

ISecurityGroup[]