public static final class IDatabaseCluster.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements IDatabaseCluster.Jsii$Default
IDatabaseCluster.Jsii$Default, IDatabaseCluster.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) |
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.
|
public final ConstructNode getNode()
getNode
in interface IConstruct
getNode
in interface IConstruct.Jsii$Default
getNode
in interface IResource.Jsii$Default
getNode
in interface IDatabaseCluster.Jsii$Default
public final ResourceEnvironment getEnv()
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.
getEnv
in interface IResource
getEnv
in interface IResource.Jsii$Default
getEnv
in interface IDatabaseCluster.Jsii$Default
public final Stack getStack()
getStack
in interface IResource
getStack
in interface IResource.Jsii$Default
getStack
in interface IDatabaseCluster.Jsii$Default
public final Connections getConnections()
getConnections
in interface IConnectable
getConnections
in interface IConnectable.Jsii$Default
getConnections
in interface IDatabaseCluster.Jsii$Default
public final Endpoint getClusterEndpoint()
getClusterEndpoint
in interface IDatabaseCluster
getClusterEndpoint
in interface IDatabaseCluster.Jsii$Default
public final java.lang.String getClusterIdentifier()
getClusterIdentifier
in interface IDatabaseCluster
getClusterIdentifier
in interface IDatabaseCluster.Jsii$Default
public final Endpoint getClusterReadEndpoint()
getClusterReadEndpoint
in interface IDatabaseCluster
getClusterReadEndpoint
in interface IDatabaseCluster.Jsii$Default
public final java.util.List<Endpoint> getInstanceEndpoints()
getInstanceEndpoints
in interface IDatabaseCluster
getInstanceEndpoints
in interface IDatabaseCluster.Jsii$Default
public final java.util.List<java.lang.String> getInstanceIdentifiers()
getInstanceIdentifiers
in interface IDatabaseCluster
getInstanceIdentifiers
in interface IDatabaseCluster.Jsii$Default
public final IClusterEngine getEngine()
May be not known for imported Clusters if it wasn't provided explicitly.
getEngine
in interface IDatabaseCluster
getEngine
in interface IDatabaseCluster.Jsii$Default
public final void applyRemovalPolicy(RemovalPolicy policy)
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
).
applyRemovalPolicy
in interface IResource
applyRemovalPolicy
in interface IResource.Jsii$Default
applyRemovalPolicy
in interface IDatabaseCluster.Jsii$Default
policy
- This parameter is required.public final SecretAttachmentTargetProps asSecretAttachmentTarget()
asSecretAttachmentTarget
in interface IDatabaseCluster.Jsii$Default
asSecretAttachmentTarget
in interface ISecretAttachmentTarget
asSecretAttachmentTarget
in interface ISecretAttachmentTarget.Jsii$Default
public final DatabaseProxy addProxy(java.lang.String id, DatabaseProxyOptions options)
addProxy
in interface IDatabaseCluster
addProxy
in interface IDatabaseCluster.Jsii$Default
id
- This parameter is required.options
- This parameter is required.public final Metric metric(java.lang.String metricName, MetricOptions props)
metric
in interface IDatabaseCluster
metric
in interface IDatabaseCluster.Jsii$Default
metricName
- This parameter is required.props
- public final Metric metric(java.lang.String metricName)
metric
in interface IDatabaseCluster
metricName
- This parameter is required.public final Metric metricCPUUtilization(MetricOptions props)
Average over 5 minutes
metricCPUUtilization
in interface IDatabaseCluster
metricCPUUtilization
in interface IDatabaseCluster.Jsii$Default
props
- public final Metric metricCPUUtilization()
Average over 5 minutes
metricCPUUtilization
in interface IDatabaseCluster
public final Metric metricDatabaseConnections(MetricOptions props)
Average over 5 minutes
metricDatabaseConnections
in interface IDatabaseCluster
metricDatabaseConnections
in interface IDatabaseCluster.Jsii$Default
props
- public final Metric metricDatabaseConnections()
Average over 5 minutes
metricDatabaseConnections
in interface IDatabaseCluster
public final Metric metricDeadlocks(MetricOptions props)
Average over 5 minutes
metricDeadlocks
in interface IDatabaseCluster
metricDeadlocks
in interface IDatabaseCluster.Jsii$Default
props
- public final Metric metricDeadlocks()
Average over 5 minutes
metricDeadlocks
in interface IDatabaseCluster
public final Metric metricEngineUptime(MetricOptions props)
Average over 5 minutes
metricEngineUptime
in interface IDatabaseCluster
metricEngineUptime
in interface IDatabaseCluster.Jsii$Default
props
- public final Metric metricEngineUptime()
Average over 5 minutes
metricEngineUptime
in interface IDatabaseCluster
public final Metric metricFreeableMemory(MetricOptions props)
Average over 5 minutes
metricFreeableMemory
in interface IDatabaseCluster
metricFreeableMemory
in interface IDatabaseCluster.Jsii$Default
props
- public final Metric metricFreeableMemory()
Average over 5 minutes
metricFreeableMemory
in interface IDatabaseCluster
public final Metric metricFreeLocalStorage(MetricOptions props)
Average over 5 minutes
metricFreeLocalStorage
in interface IDatabaseCluster
metricFreeLocalStorage
in interface IDatabaseCluster.Jsii$Default
props
- public final Metric metricFreeLocalStorage()
Average over 5 minutes
metricFreeLocalStorage
in interface IDatabaseCluster
public final Metric metricNetworkReceiveThroughput(MetricOptions props)
Average over 5 minutes
metricNetworkReceiveThroughput
in interface IDatabaseCluster
metricNetworkReceiveThroughput
in interface IDatabaseCluster.Jsii$Default
props
- public final Metric metricNetworkReceiveThroughput()
Average over 5 minutes
metricNetworkReceiveThroughput
in interface IDatabaseCluster
public final Metric metricNetworkThroughput(MetricOptions props)
Average over 5 minutes
metricNetworkThroughput
in interface IDatabaseCluster
metricNetworkThroughput
in interface IDatabaseCluster.Jsii$Default
props
- public final Metric metricNetworkThroughput()
Average over 5 minutes
metricNetworkThroughput
in interface IDatabaseCluster
public final Metric metricNetworkTransmitThroughput(MetricOptions props)
Average over 5 minutes
metricNetworkTransmitThroughput
in interface IDatabaseCluster
metricNetworkTransmitThroughput
in interface IDatabaseCluster.Jsii$Default
props
- public final Metric metricNetworkTransmitThroughput()
Average over 5 minutes
metricNetworkTransmitThroughput
in interface IDatabaseCluster
public final Metric metricSnapshotStorageUsed(MetricOptions props)
Average over 5 minutes
metricSnapshotStorageUsed
in interface IDatabaseCluster
metricSnapshotStorageUsed
in interface IDatabaseCluster.Jsii$Default
props
- public final Metric metricSnapshotStorageUsed()
Average over 5 minutes
metricSnapshotStorageUsed
in interface IDatabaseCluster
public final Metric metricTotalBackupStorageBilled(MetricOptions props)
Average over 5 minutes
metricTotalBackupStorageBilled
in interface IDatabaseCluster
metricTotalBackupStorageBilled
in interface IDatabaseCluster.Jsii$Default
props
- public final Metric metricTotalBackupStorageBilled()
Average over 5 minutes
metricTotalBackupStorageBilled
in interface IDatabaseCluster
public final Metric metricVolumeBytesUsed(MetricOptions props)
Average over 5 minutes
metricVolumeBytesUsed
in interface IDatabaseCluster
metricVolumeBytesUsed
in interface IDatabaseCluster.Jsii$Default
props
- public final Metric metricVolumeBytesUsed()
Average over 5 minutes
metricVolumeBytesUsed
in interface IDatabaseCluster
public final Metric metricVolumeReadIOPs(MetricOptions props)
Average over 5 minutes
metricVolumeReadIOPs
in interface IDatabaseCluster
metricVolumeReadIOPs
in interface IDatabaseCluster.Jsii$Default
props
- public final Metric metricVolumeReadIOPs()
Average over 5 minutes
metricVolumeReadIOPs
in interface IDatabaseCluster
public final Metric metricVolumeWriteIOPs(MetricOptions props)
Average over 5 minutes
metricVolumeWriteIOPs
in interface IDatabaseCluster
metricVolumeWriteIOPs
in interface IDatabaseCluster.Jsii$Default
props
- public final Metric metricVolumeWriteIOPs()
Average over 5 minutes
metricVolumeWriteIOPs
in interface IDatabaseCluster