Interface IDatabaseCluster
- All Superinterfaces:
IConnectable,software.constructs.IConstruct,software.constructs.IDependable,IEnvironmentAware,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.120.0 (build 192dc88)",
date="2025-12-05T22:26:50.265Z")
@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 ClassesModifier and TypeInterfaceDescriptionstatic interfaceInternal default implementation forIDatabaseCluster.static final classA proxy class which represents a concrete javascript instance of this type. -
Method Summary
Modifier and TypeMethodDescription(experimental) The endpoint to use for read/write operations.(experimental) Identifier of the cluster.(experimental) Endpoint to use for load-balanced read-only operations.(experimental) Resource identifier of the cluster.grant(IGrantable grantee, String... actions) (experimental) Grant the given identity the specified actions.grantConnect(IGrantable grantee) (experimental) Grant the given identity connection access to the database.(experimental) Return the given named metric associated with this DatabaseCluster instance.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
getConnectionsMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware
getEnvMethods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getStackMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getClusterEndpoint
(experimental) The endpoint to use for read/write operations. -
getClusterIdentifier
(experimental) Identifier of the cluster. -
getClusterReadEndpoint
(experimental) Endpoint to use for load-balanced read-only operations. -
getClusterResourceIdentifier
(experimental) Resource identifier of the cluster. -
grant
@Stability(Experimental) @NotNull Grant grant(@NotNull IGrantable grantee, @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:
-
grantConnect
(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:
-
metric
(experimental) Return the given named metric associated with this DatabaseCluster instance.- Parameters:
metricName- This parameter is required.- See Also:
-