@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-14T16:25:37.039Z") public abstract class DatabaseClusterBase extends Resource implements IDatabaseCluster
IDatabaseCluster.Jsii$Default
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) |
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.
|
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
applyRemovalPolicy, getEnv, getStack
getNode
protected DatabaseClusterBase(software.amazon.jsii.JsiiObjectRef objRef)
protected DatabaseClusterBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected DatabaseClusterBase(software.constructs.Construct scope, java.lang.String id, ResourceProps props)
scope
- This parameter is required.id
- This parameter is required.props
- protected DatabaseClusterBase(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.public DatabaseProxy addProxy(java.lang.String id, DatabaseProxyOptions options)
addProxy
in interface IDatabaseCluster
id
- This parameter is required.options
- This parameter is required.public SecretAttachmentTargetProps asSecretAttachmentTarget()
asSecretAttachmentTarget
in interface ISecretAttachmentTarget
public Metric metric(java.lang.String metricName, MetricOptions props)
metric
in interface IDatabaseCluster
metricName
- This parameter is required.props
- public Metric metric(java.lang.String metricName)
metric
in interface IDatabaseCluster
metricName
- This parameter is required.public Metric metricCPUUtilization(MetricOptions props)
Average over 5 minutes
metricCPUUtilization
in interface IDatabaseCluster
props
- public Metric metricCPUUtilization()
Average over 5 minutes
metricCPUUtilization
in interface IDatabaseCluster
public Metric metricDatabaseConnections(MetricOptions props)
Average over 5 minutes
metricDatabaseConnections
in interface IDatabaseCluster
props
- public Metric metricDatabaseConnections()
Average over 5 minutes
metricDatabaseConnections
in interface IDatabaseCluster
public Metric metricDeadlocks(MetricOptions props)
Average over 5 minutes
metricDeadlocks
in interface IDatabaseCluster
props
- public Metric metricDeadlocks()
Average over 5 minutes
metricDeadlocks
in interface IDatabaseCluster
public Metric metricEngineUptime(MetricOptions props)
Average over 5 minutes
metricEngineUptime
in interface IDatabaseCluster
props
- public Metric metricEngineUptime()
Average over 5 minutes
metricEngineUptime
in interface IDatabaseCluster
public Metric metricFreeableMemory(MetricOptions props)
Average over 5 minutes
metricFreeableMemory
in interface IDatabaseCluster
props
- public Metric metricFreeableMemory()
Average over 5 minutes
metricFreeableMemory
in interface IDatabaseCluster
public Metric metricFreeLocalStorage(MetricOptions props)
Average over 5 minutes
metricFreeLocalStorage
in interface IDatabaseCluster
props
- public Metric metricFreeLocalStorage()
Average over 5 minutes
metricFreeLocalStorage
in interface IDatabaseCluster
public Metric metricNetworkReceiveThroughput(MetricOptions props)
Average over 5 minutes
metricNetworkReceiveThroughput
in interface IDatabaseCluster
props
- public Metric metricNetworkReceiveThroughput()
Average over 5 minutes
metricNetworkReceiveThroughput
in interface IDatabaseCluster
public Metric metricNetworkThroughput(MetricOptions props)
Average over 5 minutes
metricNetworkThroughput
in interface IDatabaseCluster
props
- public Metric metricNetworkThroughput()
Average over 5 minutes
metricNetworkThroughput
in interface IDatabaseCluster
public Metric metricNetworkTransmitThroughput(MetricOptions props)
Average over 5 minutes
metricNetworkTransmitThroughput
in interface IDatabaseCluster
props
- public Metric metricNetworkTransmitThroughput()
Average over 5 minutes
metricNetworkTransmitThroughput
in interface IDatabaseCluster
public Metric metricSnapshotStorageUsed(MetricOptions props)
Average over 5 minutes
metricSnapshotStorageUsed
in interface IDatabaseCluster
props
- public Metric metricSnapshotStorageUsed()
Average over 5 minutes
metricSnapshotStorageUsed
in interface IDatabaseCluster
public Metric metricTotalBackupStorageBilled(MetricOptions props)
Average over 5 minutes
metricTotalBackupStorageBilled
in interface IDatabaseCluster
props
- public Metric metricTotalBackupStorageBilled()
Average over 5 minutes
metricTotalBackupStorageBilled
in interface IDatabaseCluster
public Metric metricVolumeBytesUsed(MetricOptions props)
Average over 5 minutes
metricVolumeBytesUsed
in interface IDatabaseCluster
props
- public Metric metricVolumeBytesUsed()
Average over 5 minutes
metricVolumeBytesUsed
in interface IDatabaseCluster
public Metric metricVolumeReadIOPs(MetricOptions props)
Average over 5 minutes
metricVolumeReadIOPs
in interface IDatabaseCluster
props
- public Metric metricVolumeReadIOPs()
Average over 5 minutes
metricVolumeReadIOPs
in interface IDatabaseCluster
public Metric metricVolumeWriteIOPs(MetricOptions props)
Average over 5 minutes
metricVolumeWriteIOPs
in interface IDatabaseCluster
props
- public Metric metricVolumeWriteIOPs()
Average over 5 minutes
metricVolumeWriteIOPs
in interface IDatabaseCluster
public abstract Endpoint getClusterEndpoint()
getClusterEndpoint
in interface IDatabaseCluster
public abstract java.lang.String getClusterIdentifier()
getClusterIdentifier
in interface IDatabaseCluster
public abstract Endpoint getClusterReadEndpoint()
getClusterReadEndpoint
in interface IDatabaseCluster
public abstract Connections getConnections()
getConnections
in interface IConnectable
public abstract java.util.List<Endpoint> getInstanceEndpoints()
getInstanceEndpoints
in interface IDatabaseCluster
public abstract java.util.List<java.lang.String> getInstanceIdentifiers()
getInstanceIdentifiers
in interface IDatabaseCluster
public abstract IClusterEngine getEngine()
May be not known for imported Clusters if it wasn't provided explicitly.
getEngine
in interface IDatabaseCluster