Class DatabaseInstanceBase

(experimental) A new or imported database instance.

Inheritance

object

Resource

DatabaseInstanceBase

DatabaseInstance

Implements

IDatabaseInstance

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.Neptune.Alpha

Assembly: Amazon.CDK.AWS.Neptune.Alpha.dll

Syntax (csharp)

public abstract class DatabaseInstanceBase : Resource, IDatabaseInstance, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public MustInherit Class DatabaseInstanceBase Inherits Resource Implements IDatabaseInstance, IResource, IConstruct, IDependable, IEnvironmentAware

Remarks

Stability: Experimental

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.Neptune.Alpha;

             var databaseInstanceBase = DatabaseInstanceBase.FromDatabaseInstanceAttributes(this, "MyDatabaseInstanceBase", new DatabaseInstanceAttributes {
                 InstanceEndpointAddress = "instanceEndpointAddress",
                 InstanceIdentifier = "instanceIdentifier",
                 Port = 123
             });

Synopsis

Constructors

DatabaseInstanceBase(Construct, string, IResourceProps?)

(experimental) A new or imported database instance.

Properties

DbInstanceEndpointAddress	(experimental) The instance endpoint address.
DbInstanceEndpointPort	(experimental) The instance endpoint port.
InstanceEndpoint	(experimental) The instance endpoint.
InstanceIdentifier	(experimental) The instance identifier.

Methods

FromDatabaseInstanceAttributes(Construct, string, IDatabaseInstanceAttributes)	(experimental) Import an existing database instance.
Metric(string, IMetricOptions?)	(experimental) Return the given named metric associated with this database instance.

Constructors

DatabaseInstanceBase(Construct, string, IResourceProps?)

(experimental) A new or imported database instance.

protected DatabaseInstanceBase(Construct scope, string id, IResourceProps? props = null)

Parameters

scope Construct

id string

props IResourceProps

Remarks

Stability: Experimental

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.Neptune.Alpha;

             var databaseInstanceBase = DatabaseInstanceBase.FromDatabaseInstanceAttributes(this, "MyDatabaseInstanceBase", new DatabaseInstanceAttributes {
                 InstanceEndpointAddress = "instanceEndpointAddress",
                 InstanceIdentifier = "instanceIdentifier",
                 Port = 123
             });

Properties

DbInstanceEndpointAddress

(experimental) The instance endpoint address.

public abstract string DbInstanceEndpointAddress { get; }

Property Value

string

Remarks

Stability: Experimental

Inheritdoc: true

DbInstanceEndpointPort

(experimental) The instance endpoint port.

public abstract string DbInstanceEndpointPort { get; }

Property Value

string

Remarks

Stability: Experimental

Inheritdoc: true

InstanceEndpoint

(experimental) The instance endpoint.

public abstract Endpoint InstanceEndpoint { get; }

Property Value

Endpoint

Remarks

Stability: Experimental

Inheritdoc: true

InstanceIdentifier

(experimental) The instance identifier.

public abstract string InstanceIdentifier { get; }

Property Value

string

Remarks

Stability: Experimental

Inheritdoc: true

Methods

FromDatabaseInstanceAttributes(Construct, string, IDatabaseInstanceAttributes)

(experimental) Import an existing database instance.

public static IDatabaseInstance FromDatabaseInstanceAttributes(Construct scope, string id, IDatabaseInstanceAttributes attrs)

Parameters

scope Construct

id string

attrs IDatabaseInstanceAttributes

Returns

IDatabaseInstance

Remarks

Stability: Experimental

Metric(string, IMetricOptions?)

(experimental) Return the given named metric associated with this database instance.

public virtual Metric Metric(string metricName, IMetricOptions? props = null)

Parameters

metricName string

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

Inheritdoc: true

Implements

IDatabaseInstance

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware