Package 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.106.0 (build e852934)", date="2025-01-25T00:21:02.560Z") @Stability(Stable) public interface IDatabaseCluster extends software.amazon.jsii.JsiiSerializable, IResource, IConnectable, ISecretAttachmentTarget
Create a clustered database with a given number of instances.

  • Method Details

    • getClusterArn

      @Stability(Stable) @NotNull String getClusterArn()
      The ARN of the database cluster.

    • getClusterEndpoint

      @Stability(Stable) @NotNull Endpoint getClusterEndpoint()
      The endpoint to use for read/write operations.

    • getClusterIdentifier

      @Stability(Stable) @NotNull String getClusterIdentifier()
      Identifier of the cluster.

    • getClusterReadEndpoint

      @Stability(Stable) @NotNull Endpoint getClusterReadEndpoint()
      Endpoint to use for load-balanced read-only operations.

    • getClusterResourceIdentifier

      @Stability(Stable) @NotNull String getClusterResourceIdentifier()
      The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP.

      This AWS Region-unique identifier is used in things like IAM authentication policies.

    • getInstanceEndpoints

      @Stability(Stable) @NotNull List<Endpoint> getInstanceEndpoints()
      Endpoints which address each individual replica.

    • getInstanceIdentifiers

      @Stability(Stable) @NotNull List<String> getInstanceIdentifiers()
      Identifiers of the replicas.

    • getEngine

      @Stability(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(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.

    • grantConnect

      @Stability(Stable) @NotNull Grant grantConnect(@NotNull IGrantable grantee, @NotNull String dbUser)
      Grant the given identity connection access to the Cluster.

      Parameters:
      grantee - the Principal to grant the permissions to. This parameter is required.
      dbUser - the name of the database user to allow connecting. This parameter is required.

    • grantDataApiAccess

      @Stability(Stable) @NotNull Grant grantDataApiAccess(@NotNull IGrantable grantee)
      Grant the given identity to access to the Data API.

      Parameters:
      grantee - The principal to grant access to. This parameter is required.

    • metric

      @Stability(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(Stable) @NotNull Metric metric(@NotNull String metricName)
      Return the given named metric for this DBCluster.

      Parameters:
      metricName - This parameter is required.

    • metricCPUUtilization

      @Stability(Stable) @NotNull Metric metricCPUUtilization(@Nullable MetricOptions props)
      The percentage of CPU utilization.

      Average over 5 minutes

      Parameters:
      props -

    • metricCPUUtilization

      @Stability(Stable) @NotNull Metric metricCPUUtilization()
      The percentage of CPU utilization.

      Average over 5 minutes

    • metricDatabaseConnections

      @Stability(Stable) @NotNull Metric metricDatabaseConnections(@Nullable MetricOptions props)
      The number of database connections in use.

      Average over 5 minutes

      Parameters:
      props -

    • metricDatabaseConnections

      @Stability(Stable) @NotNull Metric metricDatabaseConnections()
      The number of database connections in use.

      Average over 5 minutes

    • metricDeadlocks

      @Stability(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(Stable) @NotNull Metric metricDeadlocks()
      The average number of deadlocks in the database per second.

      Average over 5 minutes

    • metricEngineUptime

      @Stability(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(Stable) @NotNull Metric metricEngineUptime()
      The amount of time that the instance has been running, in seconds.

      Average over 5 minutes

    • metricFreeableMemory

      @Stability(Stable) @NotNull Metric metricFreeableMemory(@Nullable MetricOptions props)
      The amount of available random access memory, in bytes.

      Average over 5 minutes

      Parameters:
      props -

    • metricFreeableMemory

      @Stability(Stable) @NotNull Metric metricFreeableMemory()
      The amount of available random access memory, in bytes.

      Average over 5 minutes

    • metricFreeLocalStorage

      @Stability(Stable) @NotNull Metric metricFreeLocalStorage(@Nullable MetricOptions props)
      The amount of local storage available, in bytes.

      Average over 5 minutes

      Parameters:
      props -

    • metricFreeLocalStorage

      @Stability(Stable) @NotNull Metric metricFreeLocalStorage()
      The amount of local storage available, in bytes.

      Average over 5 minutes

    • metricNetworkReceiveThroughput

      @Stability(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(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(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(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(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(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(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(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(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(Stable) @NotNull Metric metricTotalBackupStorageBilled()
      The total amount of backup storage in bytes for which you are billed.

      Average over 5 minutes

    • metricVolumeBytesUsed

      @Stability(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(Stable) @NotNull Metric metricVolumeBytesUsed()
      The amount of storage used by your Aurora DB instance, in bytes.

      Average over 5 minutes

    • metricVolumeReadIOPs

      @Stability(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(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(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(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