Interface IDatabaseCluster

(experimental) Create a clustered database with a given number of instances.

Inherited Members
Namespace: Amazon.CDK.AWS.Neptune.Alpha
Assembly: Amazon.CDK.AWS.Neptune.Alpha.dll
Syntax (csharp)
public interface IDatabaseCluster : IResource, IConstruct, IDependable, IEnvironmentAware, IConnectable
Syntax (vb)
Public Interface IDatabaseCluster Inherits IResource, IConstruct, IDependable, IEnvironmentAware, IConnectable
Remarks

Stability: Experimental

Synopsis

Properties

ClusterEndpoint

(experimental) The endpoint to use for read/write operations.
ClusterIdentifier

(experimental) Identifier of the cluster.
ClusterReadEndpoint

(experimental) Endpoint to use for load-balanced read-only operations.
ClusterResourceIdentifier

(experimental) Resource identifier of the cluster.

Methods

Grant(IGrantable, params string[])

(experimental) Grant the given identity the specified actions.
GrantConnect(IGrantable)

(experimental) Grant the given identity connection access to the database.
Metric(string, IMetricOptions?)

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

Properties

ClusterEndpoint

(experimental) The endpoint to use for read/write operations.

Endpoint ClusterEndpoint { get; }
Property Value

Endpoint

Remarks

Stability: Experimental

Attribute: Endpoint,Port

ClusterIdentifier

(experimental) Identifier of the cluster.

string ClusterIdentifier { get; }
Property Value

string

Remarks

Stability: Experimental

ClusterReadEndpoint

(experimental) Endpoint to use for load-balanced read-only operations.

Endpoint ClusterReadEndpoint { get; }
Property Value

Endpoint

Remarks

Stability: Experimental

Attribute: ReadEndpoint

ClusterResourceIdentifier

(experimental) Resource identifier of the cluster.

string ClusterResourceIdentifier { get; }
Property Value

string

Remarks

Stability: Experimental

Attribute: ClusterResourceId

Methods

Grant(IGrantable, params string[])

(experimental) Grant the given identity the specified actions.

Grant Grant(IGrantable grantee, params string[] actions)
Parameters
grantee IGrantable

the identity to be granted the actions.

actions string[]

the data-access actions.

Returns

Grant

Remarks

Stability: Experimental

See: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html

GrantConnect(IGrantable)

(experimental) Grant the given identity connection access to the database.

Grant GrantConnect(IGrantable grantee)
Parameters
grantee IGrantable
Returns

Grant

Remarks

Stability: Experimental

Metric(string, IMetricOptions?)

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

Metric Metric(string metricName, IMetricOptions? props = null)
Parameters
metricName string
props IMetricOptions
Returns

Metric

Remarks

Stability: Experimental

See: https://docs.aws.amazon.com/neptune/latest/userguide/cw-dimensions.html