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

Enclosing interface:

IDatabaseCluster
```
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 interface software.amazon.awscdk.services.rds.IDatabaseCluster
  IDatabaseCluster.Jsii$Default, IDatabaseCluster.Jsii$Proxy

Constructor Summary

Constructors
Modifier Constructor and Description

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

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

Method Summary

All Methods Instance 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.
`void`	`applyRemovalPolicy(RemovalPolicy policy)` Apply the given removal policy to this resource.
`SecretAttachmentTargetProps`	`asSecretAttachmentTarget()` Renders the target specifications.
`Endpoint`	`getClusterEndpoint()` The endpoint to use for read/write operations.
`java.lang.String`	`getClusterIdentifier()` Identifier of the cluster.
`Endpoint`	`getClusterReadEndpoint()` Endpoint to use for load-balanced read-only operations.
`Connections`	`getConnections()` The network connections associated with this resource.
`IClusterEngine`	`getEngine()` The engine of this Cluster.
`ResourceEnvironment`	`getEnv()` The environment this resource belongs to.
`java.util.List<Endpoint>`	`getInstanceEndpoints()` Endpoints which address each individual replica.
`java.util.List<java.lang.String>`	`getInstanceIdentifiers()` Identifiers of the replicas.
`ConstructNode`	`getNode()` The construct tree node for this construct.
`Stack`	`getStack()` The stack in which this resource is defined.
`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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Jsii$Proxy
```
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
```
- Method Detail
  - getNode
```
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 IResource.Jsii$Default
    
    Specified by:
    
    getNode in interface IDatabaseCluster.Jsii$Default
  - getEnv
```
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 IResource
    
    Specified by:
    
    getEnv in interface IResource.Jsii$Default
    
    Specified by:
    
    getEnv in interface IDatabaseCluster.Jsii$Default
  - getStack
```
public final Stack getStack()
```
    The stack in which this resource is defined.
    
    Specified by:
    
    getStack in interface IResource
    
    Specified by:
    
    getStack in interface IResource.Jsii$Default
    
    Specified by:
    
    getStack in interface IDatabaseCluster.Jsii$Default
  - getConnections
```
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
```
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
```
public final java.lang.String getClusterIdentifier()
```
    Identifier of the cluster.
    
    Specified by:
    
    getClusterIdentifier in interface IDatabaseCluster
    
    Specified by:
    
    getClusterIdentifier in interface IDatabaseCluster.Jsii$Default
  - getClusterReadEndpoint
```
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
```
public final java.util.List<Endpoint> getInstanceEndpoints()
```
    Endpoints which address each individual replica.
    
    Specified by:
    
    getInstanceEndpoints in interface IDatabaseCluster
    
    Specified by:
    
    getInstanceEndpoints in interface IDatabaseCluster.Jsii$Default
  - getInstanceIdentifiers
```
public final java.util.List<java.lang.String> getInstanceIdentifiers()
```
    Identifiers of the replicas.
    
    Specified by:
    
    getInstanceIdentifiers in interface IDatabaseCluster
    
    Specified by:
    
    getInstanceIdentifiers in interface IDatabaseCluster.Jsii$Default
  - getEngine
```
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
```
public final void applyRemovalPolicy(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 IResource
    
    Specified by:
    
    applyRemovalPolicy in interface IResource.Jsii$Default
    
    Specified by:
    
    applyRemovalPolicy in interface IDatabaseCluster.Jsii$Default
    
    Parameters:
    
    policy - This parameter is required.
  - asSecretAttachmentTarget
```
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
```
public final DatabaseProxy addProxy(java.lang.String id,
                                    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
```
public final Metric metric(java.lang.String metricName,
                           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
```
public final 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 final Metric metricCPUUtilization(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
```
public final Metric metricCPUUtilization()
```
    The percentage of CPU utilization.
    Average over 5 minutes
    
    Specified by:
    
    metricCPUUtilization in interface IDatabaseCluster
  - metricDatabaseConnections
```
public final Metric metricDatabaseConnections(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
```
public final Metric metricDatabaseConnections()
```
    The number of database connections in use.
    Average over 5 minutes
    
    Specified by:
    
    metricDatabaseConnections in interface IDatabaseCluster
  - metricDeadlocks
```
public final Metric metricDeadlocks(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
```
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
```
public final 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
    
    Specified by:
    
    metricEngineUptime in interface IDatabaseCluster.Jsii$Default
    
    Parameters:
    
    props -
  - metricEngineUptime
```
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
```
public final Metric metricFreeableMemory(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
```
public final Metric metricFreeableMemory()
```
    The amount of available random access memory, in bytes.
    Average over 5 minutes
    
    Specified by:
    
    metricFreeableMemory in interface IDatabaseCluster
  - metricFreeLocalStorage
```
public final Metric metricFreeLocalStorage(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
```
public final Metric metricFreeLocalStorage()
```
    The amount of local storage available, in bytes.
    Average over 5 minutes
    
    Specified by:
    
    metricFreeLocalStorage in interface IDatabaseCluster
  - metricNetworkReceiveThroughput
```
public final 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
    
    Specified by:
    
    metricNetworkReceiveThroughput in interface IDatabaseCluster.Jsii$Default
    
    Parameters:
    
    props -
  - metricNetworkReceiveThroughput
```
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
```
public final 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
    
    Specified by:
    
    metricNetworkThroughput in interface IDatabaseCluster.Jsii$Default
    
    Parameters:
    
    props -
  - metricNetworkThroughput
```
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
```
public final 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
    
    Specified by:
    
    metricNetworkTransmitThroughput in interface IDatabaseCluster.Jsii$Default
    
    Parameters:
    
    props -
  - metricNetworkTransmitThroughput
```
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
```
public final 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
    
    Specified by:
    
    metricSnapshotStorageUsed in interface IDatabaseCluster.Jsii$Default
    
    Parameters:
    
    props -
  - metricSnapshotStorageUsed
```
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
```
public final 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
    
    Specified by:
    
    metricTotalBackupStorageBilled in interface IDatabaseCluster.Jsii$Default
    
    Parameters:
    
    props -
  - metricTotalBackupStorageBilled
```
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
```
public final 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
    
    Specified by:
    
    metricVolumeBytesUsed in interface IDatabaseCluster.Jsii$Default
    
    Parameters:
    
    props -
  - metricVolumeBytesUsed
```
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
```
public final 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
    
    Specified by:
    
    metricVolumeReadIOPs in interface IDatabaseCluster.Jsii$Default
    
    Parameters:
    
    props -
  - metricVolumeReadIOPs
```
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
```
public final 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
    
    Specified by:
    
    metricVolumeWriteIOPs in interface IDatabaseCluster.Jsii$Default
    
    Parameters:
    
    props -
  - metricVolumeWriteIOPs
```
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

Class IDatabaseCluster.Jsii$Proxy

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Jsii$Proxy

Method Detail

getNode

getEnv

getStack

getConnections

getClusterEndpoint

getClusterIdentifier

getClusterReadEndpoint

getInstanceEndpoints

getInstanceIdentifiers

getEngine

applyRemovalPolicy

asSecretAttachmentTarget

addProxy

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