Package software.amazon.awscdk.services.neptune.alpha

Interface IDatabaseCluster

All Superinterfaces:

IConnectable, software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IDatabaseCluster.Jsii$Default

All Known Implementing Classes:

DatabaseCluster, DatabaseClusterBase, IDatabaseCluster.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-29T22:54:27.969Z")
@Stability(Experimental)
public interface IDatabaseCluster
extends software.amazon.jsii.JsiiSerializable, IResource, IConnectable

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IDatabaseCluster.Jsii$Default	Internal default implementation for IDatabaseCluster.
static final class	IDatabaseCluster.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
Endpoint	getClusterEndpoint()	(experimental) The endpoint to use for read/write operations.
String	getClusterIdentifier()	(experimental) Identifier of the cluster.
Endpoint	getClusterReadEndpoint()	(experimental) Endpoint to use for load-balanced read-only operations.
String	getClusterResourceIdentifier()	(experimental) Resource identifier of the cluster.
Grant	grant(IGrantable grantee, @NotNull String... actions)	(experimental) Grant the given identity the specified actions.
Grant	grantConnect(IGrantable grantee)	(experimental) Grant the given identity connection access to the database.
Metric	metric(String metricName)	(experimental) Return the given named metric associated with this DatabaseCluster instance.
Metric	metric(String metricName, MetricOptions props)	(experimental) Return the given named metric associated with this DatabaseCluster instance.

Methods inherited from interface software.amazon.awscdk.services.ec2.IConnectable

getConnections

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClusterEndpoint

@Stability(Experimental)
@NotNull
Endpoint getClusterEndpoint()

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

getClusterIdentifier

@Stability(Experimental)
@NotNull
String getClusterIdentifier()

(experimental) Identifier of the cluster.

getClusterReadEndpoint

@Stability(Experimental)
@NotNull
Endpoint getClusterReadEndpoint()

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

getClusterResourceIdentifier

@Stability(Experimental)
@NotNull
String getClusterResourceIdentifier()

(experimental) Resource identifier of the cluster.

grant

@Stability(Experimental)
@NotNull
Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 @NotNull String... actions)

(experimental) Grant the given identity the specified actions.

Parameters:

grantee - the identity to be granted the actions. This parameter is required.

actions - the data-access actions. This parameter is required.

See Also:

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

grantConnect

@Stability(Experimental)
@NotNull
Grant grantConnect(@NotNull
 IGrantable grantee)

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

Parameters:

grantee - This parameter is required.

metric

@Stability(Experimental)
@NotNull
Metric metric(@NotNull
 String metricName,
 @Nullable
 MetricOptions props)

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

Parameters:

metricName - This parameter is required.

props -

See Also:

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

metric

@Stability(Experimental)
@NotNull
Metric metric(@NotNull
 String metricName)

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

Parameters:

metricName - This parameter is required.

See Also:

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