software.amazon.awscdk.services.rds

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.29.0 (build 41df200)",
           date="2021-06-02T09:55:31.970Z")
 @Stability(value=Experimental)
public abstract class DatabaseClusterBase
extends Resource
implements IDatabaseCluster

(experimental) A new or imported clustered database.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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.constructs.Construct scope, String id)
protected	DatabaseClusterBase(software.constructs.Construct scope, String id, ResourceProps props)
protected	DatabaseClusterBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DatabaseClusterBase(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

DatabaseClusterBase

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

DatabaseClusterBase

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

DatabaseClusterBase

@Stability(value=Experimental)
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(value=Experimental)
protected DatabaseClusterBase(@NotNull
                                                             software.constructs.Construct scope,
                                                             @NotNull
                                                             String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

addProxy

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

(experimental) 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(value=Experimental)
 @NotNull
public SecretAttachmentTargetProps asSecretAttachmentTarget()

(experimental) Renders the secret attachment target specifications.

Specified by:

asSecretAttachmentTarget in interface ISecretAttachmentTarget

metric

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

(experimental) Return the given named metric for this DBCluster.

Specified by:

metric in interface IDatabaseCluster

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(value=Experimental)
 @NotNull
public Metric metric(@NotNull
                                                              String metricName)

(experimental) Return the given named metric for this DBCluster.

Specified by:

metric in interface IDatabaseCluster

Parameters:

metricName - This parameter is required.

metricCPUUtilization

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

(experimental) The percentage of CPU utilization.

Average over 5 minutes

Specified by:

metricCPUUtilization in interface IDatabaseCluster

Parameters:

props -

metricCPUUtilization

@Stability(value=Experimental)
 @NotNull
public Metric metricCPUUtilization()

(experimental) The percentage of CPU utilization.

Average over 5 minutes

Specified by:

metricCPUUtilization in interface IDatabaseCluster

metricDatabaseConnections

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

(experimental) The number of database connections in use.

Average over 5 minutes

Specified by:

metricDatabaseConnections in interface IDatabaseCluster

Parameters:

props -

metricDatabaseConnections

@Stability(value=Experimental)
 @NotNull
public Metric metricDatabaseConnections()

(experimental) The number of database connections in use.

Average over 5 minutes

Specified by:

metricDatabaseConnections in interface IDatabaseCluster

metricDeadlocks

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

(experimental) The average number of deadlocks in the database per second.

Average over 5 minutes

Specified by:

metricDeadlocks in interface IDatabaseCluster

Parameters:

props -

metricDeadlocks

@Stability(value=Experimental)
 @NotNull
public Metric metricDeadlocks()

(experimental) The average number of deadlocks in the database per second.

Average over 5 minutes

Specified by:

metricDeadlocks in interface IDatabaseCluster

metricEngineUptime

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

(experimental) 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(value=Experimental)
 @NotNull
public Metric metricEngineUptime()

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

Average over 5 minutes

Specified by:

metricEngineUptime in interface IDatabaseCluster

metricFreeableMemory

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

(experimental) The amount of available random access memory, in bytes.

Average over 5 minutes

Specified by:

metricFreeableMemory in interface IDatabaseCluster

Parameters:

props -

metricFreeableMemory

@Stability(value=Experimental)
 @NotNull
public Metric metricFreeableMemory()

(experimental) The amount of available random access memory, in bytes.

Average over 5 minutes

Specified by:

metricFreeableMemory in interface IDatabaseCluster

metricFreeLocalStorage

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

(experimental) The amount of local storage available, in bytes.

Average over 5 minutes

Specified by:

metricFreeLocalStorage in interface IDatabaseCluster

Parameters:

props -

metricFreeLocalStorage

@Stability(value=Experimental)
 @NotNull
public Metric metricFreeLocalStorage()

(experimental) The amount of local storage available, in bytes.

Average over 5 minutes

Specified by:

metricFreeLocalStorage in interface IDatabaseCluster

metricNetworkReceiveThroughput

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

(experimental) 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(value=Experimental)
 @NotNull
public Metric metricNetworkReceiveThroughput()

(experimental) 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(value=Experimental)
 @NotNull
public Metric metricNetworkThroughput(@Nullable
                                                                               MetricOptions props)

(experimental) 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(value=Experimental)
 @NotNull
public Metric metricNetworkThroughput()

(experimental) 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(value=Experimental)
 @NotNull
public Metric metricNetworkTransmitThroughput(@Nullable
                                                                                       MetricOptions props)

(experimental) 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(value=Experimental)
 @NotNull
public Metric metricNetworkTransmitThroughput()

(experimental) 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(value=Experimental)
 @NotNull
public Metric metricSnapshotStorageUsed(@Nullable
                                                                                 MetricOptions props)

(experimental) 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(value=Experimental)
 @NotNull
public Metric metricSnapshotStorageUsed()

(experimental) 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(value=Experimental)
 @NotNull
public Metric metricTotalBackupStorageBilled(@Nullable
                                                                                      MetricOptions props)

(experimental) 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(value=Experimental)
 @NotNull
public Metric metricTotalBackupStorageBilled()

(experimental) 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(value=Experimental)
 @NotNull
public Metric metricVolumeBytesUsed(@Nullable
                                                                             MetricOptions props)

(experimental) 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(value=Experimental)
 @NotNull
public Metric metricVolumeBytesUsed()

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

Average over 5 minutes

Specified by:

metricVolumeBytesUsed in interface IDatabaseCluster

metricVolumeReadIOPs

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

(experimental) 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(value=Experimental)
 @NotNull
public Metric metricVolumeReadIOPs()

(experimental) 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(value=Experimental)
 @NotNull
public Metric metricVolumeWriteIOPs(@Nullable
                                                                             MetricOptions props)

(experimental) 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(value=Experimental)
 @NotNull
public Metric metricVolumeWriteIOPs()

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public abstract Endpoint getClusterEndpoint()

(experimental) The endpoint to use for read/write operations.

Specified by:

getClusterEndpoint in interface IDatabaseCluster

getClusterIdentifier

@Stability(value=Experimental)
 @NotNull
public abstract String getClusterIdentifier()

(experimental) Identifier of the cluster.

Specified by:

getClusterIdentifier in interface IDatabaseCluster

getClusterReadEndpoint

@Stability(value=Experimental)
 @NotNull
public abstract Endpoint getClusterReadEndpoint()

(experimental) Endpoint to use for load-balanced read-only operations.

Specified by:

getClusterReadEndpoint in interface IDatabaseCluster

getConnections

@Stability(value=Experimental)
 @NotNull
public abstract Connections getConnections()

(experimental) Access to the network connections.

Specified by:

getConnections in interface IConnectable

getInstanceEndpoints

@Stability(value=Experimental)
 @NotNull
public abstract List<Endpoint> getInstanceEndpoints()

(experimental) Endpoints which address each individual replica.

Specified by:

getInstanceEndpoints in interface IDatabaseCluster

getInstanceIdentifiers

@Stability(value=Experimental)
 @NotNull
public abstract List<String> getInstanceIdentifiers()

(experimental) Identifiers of the replicas.

Specified by:

getInstanceIdentifiers in interface IDatabaseCluster

getEngine

@Stability(value=Experimental)
 @Nullable
public abstract IClusterEngine getEngine()

(experimental) The engine of this Cluster.

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

Specified by:

getEngine in interface IDatabaseCluster