Show / Hide Table of Contents

Class DatabaseInstance

(experimental) A database instance.

Inheritance
System.Object
Construct
Resource
DatabaseInstance
Implements
IDatabaseInstance
IResource
IConstruct
Constructs.IConstruct
IDependable
Inherited Members
Resource.IsResource(IConstruct)
Resource.ApplyRemovalPolicy(RemovalPolicy)
Resource.GeneratePhysicalName()
Resource.GetResourceArnAttribute(String, IArnComponents)
Resource.GetResourceNameAttribute(String)
Resource.Env
Resource.PhysicalName
Resource.Stack
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK.AWS.DocDB
Assembly: Amazon.CDK.AWS.DocDB.dll
Syntax (csharp)
public class DatabaseInstance : Resource, IDatabaseInstance, IResource, IConstruct, IConstruct, IDependable
Syntax (vb)
Public Class DatabaseInstance
    Inherits Resource
    Implements IDatabaseInstance, IResource, IConstruct, IConstruct, IDependable
Remarks

Stability: Experimental

Resource: AWS::DocDB::DBInstance

Synopsis

Constructors

DatabaseInstance(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

DatabaseInstance(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

DatabaseInstance(Construct, String, IDatabaseInstanceProps)

Properties

Cluster

(experimental) The instance's database cluster.

DbInstanceEndpointAddress

(experimental) The instance endpoint address.

DbInstanceEndpointPort

(experimental) The instance endpoint port.

InstanceArn

(experimental) The instance arn.

InstanceEndpoint

(experimental) The instance endpoint.

InstanceIdentifier

(experimental) The instance identifier.

Methods

FromDatabaseInstanceAttributes(Construct, String, IDatabaseInstanceAttributes)

(experimental) Import an existing database instance.

Constructors

DatabaseInstance(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected DatabaseInstance(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

DatabaseInstance(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected DatabaseInstance(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

DatabaseInstance(Construct, String, IDatabaseInstanceProps)

public DatabaseInstance(Construct scope, string id, IDatabaseInstanceProps props)
Parameters
scope Constructs.Construct
id System.String
props IDatabaseInstanceProps
Remarks

Stability: Experimental

Properties

Cluster

(experimental) The instance's database cluster.

public virtual IDatabaseCluster Cluster { get; }
Property Value

IDatabaseCluster

Remarks

Stability: Experimental

DbInstanceEndpointAddress

(experimental) The instance endpoint address.

public virtual string DbInstanceEndpointAddress { get; }
Property Value

System.String

Remarks

Stability: Experimental

Inheritdoc: true

DbInstanceEndpointPort

(experimental) The instance endpoint port.

public virtual string DbInstanceEndpointPort { get; }
Property Value

System.String

Remarks

Stability: Experimental

Inheritdoc: true

InstanceArn

(experimental) The instance arn.

public virtual string InstanceArn { get; }
Property Value

System.String

Remarks

Stability: Experimental

InstanceEndpoint

(experimental) The instance endpoint.

public virtual Endpoint InstanceEndpoint { get; }
Property Value

Endpoint

Remarks

Stability: Experimental

Inheritdoc: true

InstanceIdentifier

(experimental) The instance identifier.

public virtual string InstanceIdentifier { get; }
Property Value

System.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 Constructs.Construct
id System.String
attrs IDatabaseInstanceAttributes
Returns

IDatabaseInstance

Remarks

Stability: Experimental

Implements

IDatabaseInstance
IResource
IConstruct
Constructs.IConstruct
IDependable
Back to top Generated by DocFX