Package software.amazon.awscdk.services.rds

Class IDatabaseCluster.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.rds.IDatabaseCluster.Jsii$Proxy

All Implemented Interfaces:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IConnectable, IConnectable.Jsii$Default, IDatabaseCluster, IDatabaseCluster.Jsii$Default, ISecretAttachmentTarget, ISecretAttachmentTarget.Jsii$Default, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default

Enclosing interface:

IDatabaseCluster

@Internal
public static final class IDatabaseCluster.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IDatabaseCluster.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

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.ec2.IConnectable

IConnectable.Jsii$Default, IConnectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

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

IDatabaseCluster.Jsii$Default, IDatabaseCluster.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IDependable

IDependable.Jsii$Default, IDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.secretsmanager.ISecretAttachmentTarget

ISecretAttachmentTarget.Jsii$Default, ISecretAttachmentTarget.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Details

getNode

@Stability(Stable)
@NotNull
public final ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IDatabaseCluster.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
public final ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IDatabaseCluster.Jsii$Default

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(Stable)
@NotNull
public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IDatabaseCluster.Jsii$Default

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getConnections

@Stability(Stable)
@NotNull
public final Connections getConnections()

The network connections associated with this resource.

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in interface IConnectable.Jsii$Default

Specified by:

getConnections in interface IDatabaseCluster.Jsii$Default

getClusterEndpoint

@Stability(Stable)
@NotNull
public final Endpoint getClusterEndpoint()

The endpoint to use for read/write operations.

Specified by:

getClusterEndpoint in interface IDatabaseCluster

Specified by:

getClusterEndpoint in interface IDatabaseCluster.Jsii$Default

getClusterIdentifier

@Stability(Stable)
@NotNull
public final String getClusterIdentifier()

Identifier of the cluster.

Specified by:

getClusterIdentifier in interface IDatabaseCluster

Specified by:

getClusterIdentifier in interface IDatabaseCluster.Jsii$Default

getClusterReadEndpoint

@Stability(Stable)
@NotNull
public final Endpoint getClusterReadEndpoint()

Endpoint to use for load-balanced read-only operations.

Specified by:

getClusterReadEndpoint in interface IDatabaseCluster

Specified by:

getClusterReadEndpoint in interface IDatabaseCluster.Jsii$Default

getInstanceEndpoints

@Stability(Stable)
@NotNull
public final List<Endpoint> getInstanceEndpoints()

Endpoints which address each individual replica.

Specified by:

getInstanceEndpoints in interface IDatabaseCluster

Specified by:

getInstanceEndpoints in interface IDatabaseCluster.Jsii$Default

getInstanceIdentifiers

@Stability(Stable)
@NotNull
public final List<String> getInstanceIdentifiers()

Identifiers of the replicas.

Specified by:

getInstanceIdentifiers in interface IDatabaseCluster

Specified by:

getInstanceIdentifiers in interface IDatabaseCluster.Jsii$Default

getEngine

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

Specified by:

getEngine in interface IDatabaseCluster.Jsii$Default

applyRemovalPolicy

@Stability(Stable)
public final void applyRemovalPolicy(@NotNull
 RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IDatabaseCluster.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

asSecretAttachmentTarget

@Stability(Stable)
@NotNull
public final SecretAttachmentTargetProps asSecretAttachmentTarget()

Renders the target specifications.

Specified by:

asSecretAttachmentTarget in interface IDatabaseCluster.Jsii$Default

Specified by:

asSecretAttachmentTarget in interface ISecretAttachmentTarget

Specified by:

asSecretAttachmentTarget in interface ISecretAttachmentTarget.Jsii$Default

addProxy

@Stability(Stable)
@NotNull
public final DatabaseProxy addProxy(@NotNull
 String id,
 @NotNull
 DatabaseProxyOptions options)

Add a new db proxy to this cluster.

Specified by:

addProxy in interface IDatabaseCluster

Specified by:

addProxy in interface IDatabaseCluster.Jsii$Default

Parameters:

id - This parameter is required.

options - This parameter is required.

metric

@Stability(Stable)
@NotNull
public final Metric metric(@NotNull
 String metricName,
 @Nullable
 MetricOptions props)

Return the given named metric for this DBCluster.

Specified by:

metric in interface IDatabaseCluster

Specified by:

metric in interface IDatabaseCluster.Jsii$Default

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(Stable)
@NotNull
public final 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 final Metric metricCPUUtilization(@Nullable
 MetricOptions props)

The percentage of CPU utilization.

Average over 5 minutes

Specified by:

metricCPUUtilization in interface IDatabaseCluster

Specified by:

metricCPUUtilization in interface IDatabaseCluster.Jsii$Default

Parameters:

props -

metricCPUUtilization

@Stability(Stable)
@NotNull
public final Metric metricCPUUtilization()

The percentage of CPU utilization.

Average over 5 minutes

Specified by:

metricCPUUtilization in interface IDatabaseCluster

metricDatabaseConnections

@Stability(Stable)
@NotNull
public final Metric metricDatabaseConnections(@Nullable
 MetricOptions props)

The number of database connections in use.

Average over 5 minutes

Specified by:

metricDatabaseConnections in interface IDatabaseCluster

Specified by:

metricDatabaseConnections in interface IDatabaseCluster.Jsii$Default

Parameters:

props -

metricDatabaseConnections

@Stability(Stable)
@NotNull
public final Metric metricDatabaseConnections()

The number of database connections in use.

Average over 5 minutes

Specified by:

metricDatabaseConnections in interface IDatabaseCluster

metricDeadlocks

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

Specified by:

metricDeadlocks in interface IDatabaseCluster.Jsii$Default

Parameters:

props -

metricDeadlocks

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

Specified by:

metricEngineUptime in interface IDatabaseCluster.Jsii$Default

Parameters:

props -

metricEngineUptime

@Stability(Stable)
@NotNull
public final 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 final Metric metricFreeableMemory(@Nullable
 MetricOptions props)

The amount of available random access memory, in bytes.

Average over 5 minutes

Specified by:

metricFreeableMemory in interface IDatabaseCluster

Specified by:

metricFreeableMemory in interface IDatabaseCluster.Jsii$Default

Parameters:

props -

metricFreeableMemory

@Stability(Stable)
@NotNull
public final 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 final Metric metricFreeLocalStorage(@Nullable
 MetricOptions props)

The amount of local storage available, in bytes.

Average over 5 minutes

Specified by:

metricFreeLocalStorage in interface IDatabaseCluster

Specified by:

metricFreeLocalStorage in interface IDatabaseCluster.Jsii$Default

Parameters:

props -

metricFreeLocalStorage

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

Specified by:

metricNetworkReceiveThroughput in interface IDatabaseCluster.Jsii$Default

Parameters:

props -

metricNetworkReceiveThroughput

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

Specified by:

metricNetworkThroughput in interface IDatabaseCluster.Jsii$Default

Parameters:

props -

metricNetworkThroughput

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

Specified by:

metricNetworkTransmitThroughput in interface IDatabaseCluster.Jsii$Default

Parameters:

props -

metricNetworkTransmitThroughput

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

Specified by:

metricSnapshotStorageUsed in interface IDatabaseCluster.Jsii$Default

Parameters:

props -

metricSnapshotStorageUsed

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

Specified by:

metricTotalBackupStorageBilled in interface IDatabaseCluster.Jsii$Default

Parameters:

props -

metricTotalBackupStorageBilled

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

Specified by:

metricVolumeBytesUsed in interface IDatabaseCluster.Jsii$Default

Parameters:

props -

metricVolumeBytesUsed

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

Specified by:

metricVolumeReadIOPs in interface IDatabaseCluster.Jsii$Default

Parameters:

props -

metricVolumeReadIOPs

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

Specified by:

metricVolumeWriteIOPs in interface IDatabaseCluster.Jsii$Default

Parameters:

props -

metricVolumeWriteIOPs

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