Class DatabaseClusterBase

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.rds.DatabaseClusterBase
All Implemented Interfaces:
IResource, IConnectable, IDatabaseCluster, ISecretAttachmentTarget, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
Direct Known Subclasses:
DatabaseCluster, DatabaseClusterFromSnapshot

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-18T17:54:23.379Z") @Stability(Stable) public abstract class DatabaseClusterBase extends Resource implements IDatabaseCluster
A new or imported clustered database.
  • Constructor Details

    • DatabaseClusterBase

      protected DatabaseClusterBase(software.amazon.jsii.JsiiObjectRef objRef)
    • DatabaseClusterBase

      protected DatabaseClusterBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • DatabaseClusterBase

      @Stability(Stable) protected DatabaseClusterBase(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable ResourceProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props -
    • DatabaseClusterBase

      @Stability(Stable) protected DatabaseClusterBase(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
  • Method Details

    • addProxy

      @Stability(Stable) @NotNull public DatabaseProxy addProxy(@NotNull String id, @NotNull DatabaseProxyOptions options)
      Add a new db proxy to this cluster.

      Specified by:
      addProxy in interface IDatabaseCluster
      Parameters:
      id - This parameter is required.
      options - This parameter is required.
    • asSecretAttachmentTarget

      @Stability(Stable) @NotNull public SecretAttachmentTargetProps asSecretAttachmentTarget()
      Renders the secret attachment target specifications.
      Specified by:
      asSecretAttachmentTarget in interface ISecretAttachmentTarget
    • grantConnect

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

      Specified by:
      grantConnect in interface IDatabaseCluster
      Parameters:
      grantee - This parameter is required.
      dbUser - This parameter is required.
    • grantDataApiAccess

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

      Specified by:
      grantDataApiAccess in interface IDatabaseCluster
      Parameters:
      grantee - This parameter is required.
    • metric

      @Stability(Stable) @NotNull public Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      Return the given named metric for this DBCluster.

      Specified by:
      metric in interface IDatabaseCluster
      Parameters:
      metricName - This parameter is required.
      props -
    • metric

      @Stability(Stable) @NotNull public Metric metric(@NotNull String metricName)
      Return the given named metric for this DBCluster.

      Specified by:
      metric in interface IDatabaseCluster
      Parameters:
      metricName - This parameter is required.
    • metricCPUUtilization

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

      Average over 5 minutes

      Specified by:
      metricCPUUtilization in interface IDatabaseCluster
      Parameters:
      props -
    • metricCPUUtilization

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

      Average over 5 minutes

      Specified by:
      metricCPUUtilization in interface IDatabaseCluster
    • metricDatabaseConnections

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

      Average over 5 minutes

      Specified by:
      metricDatabaseConnections in interface IDatabaseCluster
      Parameters:
      props -
    • metricDatabaseConnections

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

      Average over 5 minutes

      Specified by:
      metricDatabaseConnections in interface IDatabaseCluster
    • metricDeadlocks

      @Stability(Stable) @NotNull public Metric metricDeadlocks(@Nullable MetricOptions props)
      The average number of deadlocks in the database per second.

      Average over 5 minutes

      Specified by:
      metricDeadlocks in interface IDatabaseCluster
      Parameters:
      props -
    • metricDeadlocks

      @Stability(Stable) @NotNull public Metric metricDeadlocks()
      The average number of deadlocks in the database per second.

      Average over 5 minutes

      Specified by:
      metricDeadlocks in interface IDatabaseCluster
    • metricEngineUptime

      @Stability(Stable) @NotNull public Metric metricEngineUptime(@Nullable MetricOptions props)
      The amount of time that the instance has been running, in seconds.

      Average over 5 minutes

      Specified by:
      metricEngineUptime in interface IDatabaseCluster
      Parameters:
      props -
    • metricEngineUptime

      @Stability(Stable) @NotNull public Metric metricEngineUptime()
      The amount of time that the instance has been running, in seconds.

      Average over 5 minutes

      Specified by:
      metricEngineUptime in interface IDatabaseCluster
    • metricFreeableMemory

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

      Average over 5 minutes

      Specified by:
      metricFreeableMemory in interface IDatabaseCluster
      Parameters:
      props -
    • metricFreeableMemory

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

      Average over 5 minutes

      Specified by:
      metricFreeableMemory in interface IDatabaseCluster
    • metricFreeLocalStorage

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

      Average over 5 minutes

      Specified by:
      metricFreeLocalStorage in interface IDatabaseCluster
      Parameters:
      props -
    • metricFreeLocalStorage

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

      Average over 5 minutes

      Specified by:
      metricFreeLocalStorage in interface IDatabaseCluster
    • metricNetworkReceiveThroughput

      @Stability(Stable) @NotNull public Metric metricNetworkReceiveThroughput(@Nullable MetricOptions props)
      The amount of network throughput received from clients by each instance, in bytes per second.

      Average over 5 minutes

      Specified by:
      metricNetworkReceiveThroughput in interface IDatabaseCluster
      Parameters:
      props -
    • metricNetworkReceiveThroughput

      @Stability(Stable) @NotNull public Metric metricNetworkReceiveThroughput()
      The amount of network throughput received from clients by each instance, in bytes per second.

      Average over 5 minutes

      Specified by:
      metricNetworkReceiveThroughput in interface IDatabaseCluster
    • metricNetworkThroughput

      @Stability(Stable) @NotNull public 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

      Specified by:
      metricNetworkThroughput in interface IDatabaseCluster
      Parameters:
      props -
    • metricNetworkThroughput

      @Stability(Stable) @NotNull public 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

      Specified by:
      metricNetworkThroughput in interface IDatabaseCluster
    • metricNetworkTransmitThroughput

      @Stability(Stable) @NotNull public Metric metricNetworkTransmitThroughput(@Nullable MetricOptions props)
      The amount of network throughput sent to clients by each instance, in bytes per second.

      Average over 5 minutes

      Specified by:
      metricNetworkTransmitThroughput in interface IDatabaseCluster
      Parameters:
      props -
    • metricNetworkTransmitThroughput

      @Stability(Stable) @NotNull public Metric metricNetworkTransmitThroughput()
      The amount of network throughput sent to clients by each instance, in bytes per second.

      Average over 5 minutes

      Specified by:
      metricNetworkTransmitThroughput in interface IDatabaseCluster
    • metricSnapshotStorageUsed

      @Stability(Stable) @NotNull public 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

      Specified by:
      metricSnapshotStorageUsed in interface IDatabaseCluster
      Parameters:
      props -
    • metricSnapshotStorageUsed

      @Stability(Stable) @NotNull public Metric metricSnapshotStorageUsed()
      The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.

      Average over 5 minutes

      Specified by:
      metricSnapshotStorageUsed in interface IDatabaseCluster
    • metricTotalBackupStorageBilled

      @Stability(Stable) @NotNull public Metric metricTotalBackupStorageBilled(@Nullable MetricOptions props)
      The total amount of backup storage in bytes for which you are billed.

      Average over 5 minutes

      Specified by:
      metricTotalBackupStorageBilled in interface IDatabaseCluster
      Parameters:
      props -
    • metricTotalBackupStorageBilled

      @Stability(Stable) @NotNull public Metric metricTotalBackupStorageBilled()
      The total amount of backup storage in bytes for which you are billed.

      Average over 5 minutes

      Specified by:
      metricTotalBackupStorageBilled in interface IDatabaseCluster
    • metricVolumeBytesUsed

      @Stability(Stable) @NotNull public Metric metricVolumeBytesUsed(@Nullable MetricOptions props)
      The amount of storage used by your Aurora DB instance, in bytes.

      Average over 5 minutes

      Specified by:
      metricVolumeBytesUsed in interface IDatabaseCluster
      Parameters:
      props -
    • metricVolumeBytesUsed

      @Stability(Stable) @NotNull public Metric metricVolumeBytesUsed()
      The amount of storage used by your Aurora DB instance, in bytes.

      Average over 5 minutes

      Specified by:
      metricVolumeBytesUsed in interface IDatabaseCluster
    • metricVolumeReadIOPs

      @Stability(Stable) @NotNull public 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

      Specified by:
      metricVolumeReadIOPs in interface IDatabaseCluster
      Parameters:
      props -
    • metricVolumeReadIOPs

      @Stability(Stable) @NotNull public Metric metricVolumeReadIOPs()
      The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.

      Average over 5 minutes

      Specified by:
      metricVolumeReadIOPs in interface IDatabaseCluster
    • metricVolumeWriteIOPs

      @Stability(Stable) @NotNull public 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

      Specified by:
      metricVolumeWriteIOPs in interface IDatabaseCluster
      Parameters:
      props -
    • metricVolumeWriteIOPs

      @Stability(Stable) @NotNull public Metric metricVolumeWriteIOPs()
      The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals.

      Average over 5 minutes

      Specified by:
      metricVolumeWriteIOPs in interface IDatabaseCluster
    • getClusterArn

      @Stability(Stable) @NotNull public String getClusterArn()
      The ARN of the cluster.
      Specified by:
      getClusterArn in interface IDatabaseCluster
    • getClusterEndpoint

      @Stability(Stable) @NotNull public abstract Endpoint getClusterEndpoint()
      The endpoint to use for read/write operations.
      Specified by:
      getClusterEndpoint in interface IDatabaseCluster
    • getClusterIdentifier

      @Stability(Stable) @NotNull public abstract String getClusterIdentifier()
      Identifier of the cluster.
      Specified by:
      getClusterIdentifier in interface IDatabaseCluster
    • getClusterReadEndpoint

      @Stability(Stable) @NotNull public abstract Endpoint getClusterReadEndpoint()
      Endpoint to use for load-balanced read-only operations.
      Specified by:
      getClusterReadEndpoint in interface IDatabaseCluster
    • getClusterResourceIdentifier

      @Stability(Stable) @NotNull public abstract 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.

      Specified by:
      getClusterResourceIdentifier in interface IDatabaseCluster
    • getConnections

      @Stability(Stable) @NotNull public abstract Connections getConnections()
      Access to the network connections.
      Specified by:
      getConnections in interface IConnectable
    • getInstanceEndpoints

      @Stability(Stable) @NotNull public abstract List<Endpoint> getInstanceEndpoints()
      Endpoints which address each individual replica.
      Specified by:
      getInstanceEndpoints in interface IDatabaseCluster
    • getInstanceIdentifiers

      @Stability(Stable) @NotNull public abstract List<String> getInstanceIdentifiers()
      Identifiers of the replicas.
      Specified by:
      getInstanceIdentifiers in interface IDatabaseCluster
    • getEngine

      @Stability(Stable) @Nullable public abstract IClusterEngine getEngine()
      The engine of this Cluster.

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

      Specified by:
      getEngine in interface IDatabaseCluster
    • getSecret

      @Stability(Stable) @Nullable public abstract ISecret getSecret()
      The secret attached to this cluster.
    • getEnableDataApi

      @Stability(Stable) @Nullable protected abstract Boolean getEnableDataApi()
    • setEnableDataApi

      @Stability(Stable) protected abstract void setEnableDataApi(@Nullable Boolean value)