software.amazon.awscdk.services.rds

Interface IDatabaseCluster

All Superinterfaces:

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

All Known Subinterfaces:

IDatabaseCluster.Jsii$Default

All Known Implementing Classes:

DatabaseCluster, DatabaseClusterBase, DatabaseClusterFromSnapshot, IDatabaseCluster.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.485Z")
 @Stability(value=Stable)
public interface IDatabaseCluster
extends software.amazon.jsii.JsiiSerializable, IResource, IConnectable, ISecretAttachmentTarget

Create a clustered database with a given number of instances.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
DatabaseProxy	addProxy(String id, DatabaseProxyOptions options) Add a new db proxy to this cluster.
Endpoint	getClusterEndpoint() The endpoint to use for read/write operations.
String	getClusterIdentifier() Identifier of the cluster.
Endpoint	getClusterReadEndpoint() Endpoint to use for load-balanced read-only operations.
default IClusterEngine	getEngine() The engine of this Cluster.
List<Endpoint>	getInstanceEndpoints() Endpoints which address each individual replica.
List<String>	getInstanceIdentifiers() Identifiers of the replicas.
Metric	metric(String metricName) Return the given named metric for this DBCluster.
Metric	metric(String metricName, MetricOptions props) Return the given named metric for this DBCluster.
Metric	metricCPUUtilization() The percentage of CPU utilization.
Metric	metricCPUUtilization(MetricOptions props) The percentage of CPU utilization.
Metric	metricDatabaseConnections() The number of database connections in use.
Metric	metricDatabaseConnections(MetricOptions props) The number of database connections in use.
Metric	metricDeadlocks() The average number of deadlocks in the database per second.
Metric	metricDeadlocks(MetricOptions props) The average number of deadlocks in the database per second.
Metric	metricEngineUptime() The amount of time that the instance has been running, in seconds.
Metric	metricEngineUptime(MetricOptions props) The amount of time that the instance has been running, in seconds.
Metric	metricFreeableMemory() The amount of available random access memory, in bytes.
Metric	metricFreeableMemory(MetricOptions props) The amount of available random access memory, in bytes.
Metric	metricFreeLocalStorage() The amount of local storage available, in bytes.
Metric	metricFreeLocalStorage(MetricOptions props) The amount of local storage available, in bytes.
Metric	metricNetworkReceiveThroughput() The amount of network throughput received from clients by each instance, in bytes per second.
Metric	metricNetworkReceiveThroughput(MetricOptions props) The amount of network throughput received from clients by each instance, in bytes per second.
Metric	metricNetworkThroughput() The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second.
Metric	metricNetworkThroughput(MetricOptions props) The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second.
Metric	metricNetworkTransmitThroughput() The amount of network throughput sent to clients by each instance, in bytes per second.
Metric	metricNetworkTransmitThroughput(MetricOptions props) The amount of network throughput sent to clients by each instance, in bytes per second.
Metric	metricSnapshotStorageUsed() The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.
Metric	metricSnapshotStorageUsed(MetricOptions props) The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.
Metric	metricTotalBackupStorageBilled() The total amount of backup storage in bytes for which you are billed.
Metric	metricTotalBackupStorageBilled(MetricOptions props) The total amount of backup storage in bytes for which you are billed.
Metric	metricVolumeBytesUsed() The amount of storage used by your Aurora DB instance, in bytes.
Metric	metricVolumeBytesUsed(MetricOptions props) The amount of storage used by your Aurora DB instance, in bytes.
Metric	metricVolumeReadIOPs() The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.
Metric	metricVolumeReadIOPs(MetricOptions props) The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.
Metric	metricVolumeWriteIOPs() The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals.
Metric	metricVolumeWriteIOPs(MetricOptions props) The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals.

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getConnections

Methods inherited from interface software.amazon.awscdk.services.secretsmanager.ISecretAttachmentTarget

asSecretAttachmentTarget

Method Detail

getClusterEndpoint

@Stability(value=Stable)
 @NotNull
Endpoint getClusterEndpoint()

The endpoint to use for read/write operations.

getClusterIdentifier

@Stability(value=Stable)
 @NotNull
String getClusterIdentifier()

Identifier of the cluster.

getClusterReadEndpoint

@Stability(value=Stable)
 @NotNull
Endpoint getClusterReadEndpoint()

Endpoint to use for load-balanced read-only operations.

getInstanceEndpoints

@Stability(value=Stable)
 @NotNull
List<Endpoint> getInstanceEndpoints()

Endpoints which address each individual replica.

getInstanceIdentifiers

@Stability(value=Stable)
 @NotNull
List<String> getInstanceIdentifiers()

Identifiers of the replicas.

getEngine

@Stability(value=Stable)
 @Nullable
default IClusterEngine getEngine()

The engine of this Cluster.

May be not known for imported Clusters if it wasn't provided explicitly.

addProxy

@Stability(value=Stable)
 @NotNull
DatabaseProxy addProxy(@NotNull
                                                          String id,
                                                          @NotNull
                                                          DatabaseProxyOptions options)

Add a new db proxy to this cluster.

Parameters:

id - This parameter is required.

options - This parameter is required.

metric

@Stability(value=Stable)
 @NotNull
Metric metric(@NotNull
                                                 String metricName,
                                                 @Nullable
                                                 MetricOptions props)

Return the given named metric for this DBCluster.

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(value=Stable)
 @NotNull
Metric metric(@NotNull
                                                 String metricName)

Return the given named metric for this DBCluster.

Parameters:

metricName - This parameter is required.

metricCPUUtilization

@Stability(value=Stable)
 @NotNull
Metric metricCPUUtilization(@Nullable
                                                               MetricOptions props)

The percentage of CPU utilization.

Average over 5 minutes

Parameters:

props -

metricCPUUtilization

@Stability(value=Stable)
 @NotNull
Metric metricCPUUtilization()

The percentage of CPU utilization.

Average over 5 minutes

metricDatabaseConnections

@Stability(value=Stable)
 @NotNull
Metric metricDatabaseConnections(@Nullable
                                                                    MetricOptions props)

The number of database connections in use.

Average over 5 minutes

Parameters:

props -

metricDatabaseConnections

@Stability(value=Stable)
 @NotNull
Metric metricDatabaseConnections()

The number of database connections in use.

Average over 5 minutes

metricDeadlocks

@Stability(value=Stable)
 @NotNull
Metric metricDeadlocks(@Nullable
                                                          MetricOptions props)

The average number of deadlocks in the database per second.

Average over 5 minutes

Parameters:

props -

metricDeadlocks

@Stability(value=Stable)
 @NotNull
Metric metricDeadlocks()

The average number of deadlocks in the database per second.

Average over 5 minutes

metricEngineUptime

@Stability(value=Stable)
 @NotNull
Metric metricEngineUptime(@Nullable
                                                             MetricOptions props)

The amount of time that the instance has been running, in seconds.

Average over 5 minutes

Parameters:

props -

metricEngineUptime

@Stability(value=Stable)
 @NotNull
Metric metricEngineUptime()

The amount of time that the instance has been running, in seconds.

Average over 5 minutes

metricFreeableMemory

@Stability(value=Stable)
 @NotNull
Metric metricFreeableMemory(@Nullable
                                                               MetricOptions props)

The amount of available random access memory, in bytes.

Average over 5 minutes

Parameters:

props -

metricFreeableMemory

@Stability(value=Stable)
 @NotNull
Metric metricFreeableMemory()

The amount of available random access memory, in bytes.

Average over 5 minutes

metricFreeLocalStorage

@Stability(value=Stable)
 @NotNull
Metric metricFreeLocalStorage(@Nullable
                                                                 MetricOptions props)

The amount of local storage available, in bytes.

Average over 5 minutes

Parameters:

props -

metricFreeLocalStorage

@Stability(value=Stable)
 @NotNull
Metric metricFreeLocalStorage()

The amount of local storage available, in bytes.

Average over 5 minutes

metricNetworkReceiveThroughput

@Stability(value=Stable)
 @NotNull
Metric metricNetworkReceiveThroughput(@Nullable
                                                                         MetricOptions props)

The amount of network throughput received from clients by each instance, in bytes per second.

Average over 5 minutes

Parameters:

props -

metricNetworkReceiveThroughput

@Stability(value=Stable)
 @NotNull
Metric metricNetworkReceiveThroughput()

The amount of network throughput received from clients by each instance, in bytes per second.

Average over 5 minutes

metricNetworkThroughput

@Stability(value=Stable)
 @NotNull
Metric metricNetworkThroughput(@Nullable
                                                                  MetricOptions props)

The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second.

Average over 5 minutes

Parameters:

props -

metricNetworkThroughput

@Stability(value=Stable)
 @NotNull
Metric metricNetworkThroughput()

The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second.

Average over 5 minutes

metricNetworkTransmitThroughput

@Stability(value=Stable)
 @NotNull
Metric metricNetworkTransmitThroughput(@Nullable
                                                                          MetricOptions props)

The amount of network throughput sent to clients by each instance, in bytes per second.

Average over 5 minutes

Parameters:

props -

metricNetworkTransmitThroughput

@Stability(value=Stable)
 @NotNull
Metric metricNetworkTransmitThroughput()

The amount of network throughput sent to clients by each instance, in bytes per second.

Average over 5 minutes

metricSnapshotStorageUsed

@Stability(value=Stable)
 @NotNull
Metric metricSnapshotStorageUsed(@Nullable
                                                                    MetricOptions props)

The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.

Average over 5 minutes

Parameters:

props -

metricSnapshotStorageUsed

@Stability(value=Stable)
 @NotNull
Metric metricSnapshotStorageUsed()

The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.

Average over 5 minutes

metricTotalBackupStorageBilled

@Stability(value=Stable)
 @NotNull
Metric metricTotalBackupStorageBilled(@Nullable
                                                                         MetricOptions props)

The total amount of backup storage in bytes for which you are billed.

Average over 5 minutes

Parameters:

props -

metricTotalBackupStorageBilled

@Stability(value=Stable)
 @NotNull
Metric metricTotalBackupStorageBilled()

The total amount of backup storage in bytes for which you are billed.

Average over 5 minutes

metricVolumeBytesUsed

@Stability(value=Stable)
 @NotNull
Metric metricVolumeBytesUsed(@Nullable
                                                                MetricOptions props)

The amount of storage used by your Aurora DB instance, in bytes.

Average over 5 minutes

Parameters:

props -

metricVolumeBytesUsed

@Stability(value=Stable)
 @NotNull
Metric metricVolumeBytesUsed()

The amount of storage used by your Aurora DB instance, in bytes.

Average over 5 minutes

metricVolumeReadIOPs

@Stability(value=Stable)
 @NotNull
Metric metricVolumeReadIOPs(@Nullable
                                                               MetricOptions props)

The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.

Average over 5 minutes

Parameters:

props -

metricVolumeReadIOPs

@Stability(value=Stable)
 @NotNull
Metric metricVolumeReadIOPs()

The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.

Average over 5 minutes

metricVolumeWriteIOPs

@Stability(value=Stable)
 @NotNull
Metric metricVolumeWriteIOPs(@Nullable
                                                                MetricOptions props)

The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals.

Average over 5 minutes

Parameters:

props -

metricVolumeWriteIOPs

@Stability(value=Stable)
 @NotNull
Metric metricVolumeWriteIOPs()

The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals.

Average over 5 minutes