DatabaseClusterBase

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.Resource
    - - software.amazon.awscdk.services.rds.DatabaseClusterBase

All Implemented Interfaces:

IConstruct, IDependable, IResource, IConnectable, IDatabaseCluster, ISecretAttachmentTarget

Direct Known Subclasses:

DatabaseCluster, DatabaseClusterFromSnapshot
```
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:37.039Z")
public abstract class DatabaseClusterBase
extends Resource
implements IDatabaseCluster
```
A new or imported clustered database.

Nested Class Summary
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.IDatabaseCluster
  IDatabaseCluster.Jsii$Default

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DatabaseClusterBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`DatabaseClusterBase(software.amazon.jsii.JsiiObjectRef objRef)`
`protected`	`DatabaseClusterBase(software.constructs.Construct scope, java.lang.String id)`
`protected`	`DatabaseClusterBase(software.constructs.Construct scope, java.lang.String id, ResourceProps props)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`DatabaseProxy`	`addProxy(java.lang.String id, DatabaseProxyOptions options)` Add a new db proxy to this cluster.
`SecretAttachmentTargetProps`	`asSecretAttachmentTarget()` Renders the secret attachment target specifications.
`abstract Endpoint`	`getClusterEndpoint()` The endpoint to use for read/write operations.
`abstract java.lang.String`	`getClusterIdentifier()` Identifier of the cluster.
`abstract Endpoint`	`getClusterReadEndpoint()` Endpoint to use for load-balanced read-only operations.
`abstract Connections`	`getConnections()` Access to the network connections.
`abstract IClusterEngine`	`getEngine()` The engine of this Cluster.
`abstract java.util.List<Endpoint>`	`getInstanceEndpoints()` Endpoints which address each individual replica.
`abstract java.util.List<java.lang.String>`	`getInstanceIdentifiers()` Identifiers of the replicas.
`Metric`	`metric(java.lang.String metricName)` Return the given named metric for this DBCluster.
`Metric`	`metric(java.lang.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 class software.amazon.awscdk.core.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource
applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct
getNode

- Constructor Detail
  - DatabaseClusterBase
```
protected DatabaseClusterBase(software.amazon.jsii.JsiiObjectRef objRef)
```
  - DatabaseClusterBase
```
protected DatabaseClusterBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - DatabaseClusterBase
```
protected DatabaseClusterBase(software.constructs.Construct scope,
                              java.lang.String id,
                              ResourceProps props)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    props -
  - DatabaseClusterBase
```
protected DatabaseClusterBase(software.constructs.Construct scope,
                              java.lang.String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
- Method Detail
  - addProxy
```
public DatabaseProxy addProxy(java.lang.String id,
                              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
```
public SecretAttachmentTargetProps asSecretAttachmentTarget()
```
    Renders the secret attachment target specifications.
    
    Specified by:
    
    asSecretAttachmentTarget in interface ISecretAttachmentTarget
  - metric
```
public Metric metric(java.lang.String metricName,
                     MetricOptions props)
```
    Return the given named metric for this DBCluster.
    
    Specified by:
    
    metric in interface IDatabaseCluster
    
    Parameters:
    
    metricName - This parameter is required.
    
    props -
  - metric
```
public Metric metric(java.lang.String metricName)
```
    Return the given named metric for this DBCluster.
    
    Specified by:
    
    metric in interface IDatabaseCluster
    
    Parameters:
    
    metricName - This parameter is required.
  - metricCPUUtilization
```
public Metric metricCPUUtilization(MetricOptions props)
```
    The percentage of CPU utilization.
    Average over 5 minutes
    
    Specified by:
    
    metricCPUUtilization in interface IDatabaseCluster
    
    Parameters:
    
    props -
  - metricCPUUtilization
```
public Metric metricCPUUtilization()
```
    The percentage of CPU utilization.
    Average over 5 minutes
    
    Specified by:
    
    metricCPUUtilization in interface IDatabaseCluster
  - metricDatabaseConnections
```
public Metric metricDatabaseConnections(MetricOptions props)
```
    The number of database connections in use.
    Average over 5 minutes
    
    Specified by:
    
    metricDatabaseConnections in interface IDatabaseCluster
    
    Parameters:
    
    props -
  - metricDatabaseConnections
```
public Metric metricDatabaseConnections()
```
    The number of database connections in use.
    Average over 5 minutes
    
    Specified by:
    
    metricDatabaseConnections in interface IDatabaseCluster
  - metricDeadlocks
```
public Metric metricDeadlocks(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
```
public Metric metricDeadlocks()
```
    The average number of deadlocks in the database per second.
    Average over 5 minutes
    
    Specified by:
    
    metricDeadlocks in interface IDatabaseCluster
  - metricEngineUptime
```
public Metric metricEngineUptime(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
```
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
```
public Metric metricFreeableMemory(MetricOptions props)
```
    The amount of available random access memory, in bytes.
    Average over 5 minutes
    
    Specified by:
    
    metricFreeableMemory in interface IDatabaseCluster
    
    Parameters:
    
    props -
  - metricFreeableMemory
```
public Metric metricFreeableMemory()
```
    The amount of available random access memory, in bytes.
    Average over 5 minutes
    
    Specified by:
    
    metricFreeableMemory in interface IDatabaseCluster
  - metricFreeLocalStorage
```
public Metric metricFreeLocalStorage(MetricOptions props)
```
    The amount of local storage available, in bytes.
    Average over 5 minutes
    
    Specified by:
    
    metricFreeLocalStorage in interface IDatabaseCluster
    
    Parameters:
    
    props -
  - metricFreeLocalStorage
```
public Metric metricFreeLocalStorage()
```
    The amount of local storage available, in bytes.
    Average over 5 minutes
    
    Specified by:
    
    metricFreeLocalStorage in interface IDatabaseCluster
  - metricNetworkReceiveThroughput
```
public Metric metricNetworkReceiveThroughput(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
```
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
```
public Metric metricNetworkThroughput(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
```
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
```
public Metric metricNetworkTransmitThroughput(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
```
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
```
public Metric metricSnapshotStorageUsed(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
```
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
```
public Metric metricTotalBackupStorageBilled(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
```
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
```
public Metric metricVolumeBytesUsed(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
```
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
```
public Metric metricVolumeReadIOPs(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
```
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
```
public Metric metricVolumeWriteIOPs(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
```
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
  - getClusterEndpoint
```
public abstract Endpoint getClusterEndpoint()
```
    The endpoint to use for read/write operations.
    
    Specified by:
    
    getClusterEndpoint in interface IDatabaseCluster
  - getClusterIdentifier
```
public abstract java.lang.String getClusterIdentifier()
```
    Identifier of the cluster.
    
    Specified by:
    
    getClusterIdentifier in interface IDatabaseCluster
  - getClusterReadEndpoint
```
public abstract Endpoint getClusterReadEndpoint()
```
    Endpoint to use for load-balanced read-only operations.
    
    Specified by:
    
    getClusterReadEndpoint in interface IDatabaseCluster
  - getConnections
```
public abstract Connections getConnections()
```
    Access to the network connections.
    
    Specified by:
    
    getConnections in interface IConnectable
  - getInstanceEndpoints
```
public abstract java.util.List<Endpoint> getInstanceEndpoints()
```
    Endpoints which address each individual replica.
    
    Specified by:
    
    getInstanceEndpoints in interface IDatabaseCluster
  - getInstanceIdentifiers
```
public abstract java.util.List<java.lang.String> getInstanceIdentifiers()
```
    Identifiers of the replicas.
    
    Specified by:
    
    getInstanceIdentifiers in interface IDatabaseCluster
  - getEngine
```
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

Class DatabaseClusterBase

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.IDatabaseCluster

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.Resource

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awscdk.core.IResource

Methods inherited from interface software.amazon.awscdk.core.IConstruct

Constructor Detail

DatabaseClusterBase

DatabaseClusterBase

DatabaseClusterBase

DatabaseClusterBase

Method Detail

addProxy

asSecretAttachmentTarget

metric

metric

metricCPUUtilization

metricCPUUtilization

metricDatabaseConnections

metricDatabaseConnections

metricDeadlocks

metricDeadlocks

metricEngineUptime

metricEngineUptime

metricFreeableMemory

metricFreeableMemory

metricFreeLocalStorage

metricFreeLocalStorage

metricNetworkReceiveThroughput

metricNetworkReceiveThroughput

metricNetworkThroughput

metricNetworkThroughput

metricNetworkTransmitThroughput

metricNetworkTransmitThroughput

metricSnapshotStorageUsed

metricSnapshotStorageUsed

metricTotalBackupStorageBilled

metricTotalBackupStorageBilled

metricVolumeBytesUsed

metricVolumeBytesUsed

metricVolumeReadIOPs

metricVolumeReadIOPs

metricVolumeWriteIOPs

metricVolumeWriteIOPs

getClusterEndpoint

getClusterIdentifier

getClusterReadEndpoint

getConnections

getInstanceEndpoints

getInstanceIdentifiers

getEngine