Class DatabaseClusterBase

A new or imported clustered database.

Inheritance
System.Object
Construct
Resource
DatabaseClusterBase
DatabaseCluster
DatabaseClusterFromSnapshot
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.AWS.RDS.dll
Syntax (csharp)
public abstract class DatabaseClusterBase : Resource, IDatabaseCluster, IResource, IConstruct, IDependable, IConnectable, ISecretAttachmentTarget
Syntax (vb)
Public MustInherit Class DatabaseClusterBase
    Inherits Resource
    Implements IDatabaseCluster, IResource, IConstruct, IDependable, IConnectable, ISecretAttachmentTarget

Synopsis

Constructors

DatabaseClusterBase(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
DatabaseClusterBase(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
DatabaseClusterBase(Construct, String, IResourceProps)

Properties

ClusterEndpoint

The endpoint to use for read/write operations.
ClusterIdentifier

Identifier of the cluster.
ClusterReadEndpoint

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

Access to the network connections.
Engine

The engine of this Cluster.
InstanceEndpoints

Endpoints which address each individual replica.
InstanceIdentifiers

Identifiers of the replicas.

Methods

AddProxy(String, IDatabaseProxyOptions)

Add a new db proxy to this cluster.
AsSecretAttachmentTarget()

Renders the secret attachment target specifications.
Metric(String, IMetricOptions)

Return the given named metric for this DBCluster.
MetricCPUUtilization(IMetricOptions)

The percentage of CPU utilization.
MetricDatabaseConnections(IMetricOptions)

The number of database connections in use.
MetricDeadlocks(IMetricOptions)

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

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

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

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

The amount of network throughput received from clients by each instance, in bytes per second.
MetricNetworkThroughput(IMetricOptions)

The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second.
MetricNetworkTransmitThroughput(IMetricOptions)

The amount of network throughput sent to clients by each instance, in bytes per second.
MetricSnapshotStorageUsed(IMetricOptions)

The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.
MetricTotalBackupStorageBilled(IMetricOptions)

The total amount of backup storage in bytes for which you are billed.
MetricVolumeBytesUsed(IMetricOptions)

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

The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.
MetricVolumeWriteIOPs(IMetricOptions)

The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals.

Constructors

DatabaseClusterBase(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected DatabaseClusterBase(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

DatabaseClusterBase(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected DatabaseClusterBase(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

DatabaseClusterBase(Construct, String, IResourceProps)

protected DatabaseClusterBase(Construct scope, string id, IResourceProps props = null)
Parameters
scope Constructs.Construct
id System.String
props IResourceProps

Properties

ClusterEndpoint

The endpoint to use for read/write operations.

public abstract Endpoint ClusterEndpoint { get; }
Property Value

Endpoint

ClusterIdentifier

Identifier of the cluster.

public abstract string ClusterIdentifier { get; }
Property Value

System.String

ClusterReadEndpoint

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

public abstract Endpoint ClusterReadEndpoint { get; }
Property Value

Endpoint

Connections

Access to the network connections.

public abstract Connections_ Connections { get; }
Property Value

Connections_

Engine

The engine of this Cluster.

public abstract IClusterEngine Engine { get; }
Property Value

IClusterEngine

Remarks

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

InstanceEndpoints

Endpoints which address each individual replica.

public abstract Endpoint[] InstanceEndpoints { get; }
Property Value

Endpoint[]

InstanceIdentifiers

Identifiers of the replicas.

public abstract string[] InstanceIdentifiers { get; }
Property Value

System.String[]

Methods

AddProxy(String, IDatabaseProxyOptions)

Add a new db proxy to this cluster.

public virtual DatabaseProxy AddProxy(string id, IDatabaseProxyOptions options)
Parameters
id System.String
options IDatabaseProxyOptions
Returns

DatabaseProxy

AsSecretAttachmentTarget()

Renders the secret attachment target specifications.

public virtual ISecretAttachmentTargetProps AsSecretAttachmentTarget()
Returns

ISecretAttachmentTargetProps

Metric(String, IMetricOptions)

Return the given named metric for this DBCluster.

public virtual Metric Metric(string metricName, IMetricOptions props = null)
Parameters
metricName System.String
props IMetricOptions
Returns

Metric

MetricCPUUtilization(IMetricOptions)

The percentage of CPU utilization.

public virtual Metric MetricCPUUtilization(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Average over 5 minutes

MetricDatabaseConnections(IMetricOptions)

The number of database connections in use.

public virtual Metric MetricDatabaseConnections(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Average over 5 minutes

MetricDeadlocks(IMetricOptions)

The average number of deadlocks in the database per second.

public virtual Metric MetricDeadlocks(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Average over 5 minutes

MetricEngineUptime(IMetricOptions)

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

public virtual Metric MetricEngineUptime(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Average over 5 minutes

MetricFreeableMemory(IMetricOptions)

The amount of available random access memory, in bytes.

public virtual Metric MetricFreeableMemory(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Average over 5 minutes

MetricFreeLocalStorage(IMetricOptions)

The amount of local storage available, in bytes.

public virtual Metric MetricFreeLocalStorage(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Average over 5 minutes

MetricNetworkReceiveThroughput(IMetricOptions)

The amount of network throughput received from clients by each instance, in bytes per second.

public virtual Metric MetricNetworkReceiveThroughput(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Average over 5 minutes

MetricNetworkThroughput(IMetricOptions)

The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second.

public virtual Metric MetricNetworkThroughput(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Average over 5 minutes

MetricNetworkTransmitThroughput(IMetricOptions)

The amount of network throughput sent to clients by each instance, in bytes per second.

public virtual Metric MetricNetworkTransmitThroughput(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Average over 5 minutes

MetricSnapshotStorageUsed(IMetricOptions)

The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.

public virtual Metric MetricSnapshotStorageUsed(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Average over 5 minutes

MetricTotalBackupStorageBilled(IMetricOptions)

The total amount of backup storage in bytes for which you are billed.

public virtual Metric MetricTotalBackupStorageBilled(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Average over 5 minutes

MetricVolumeBytesUsed(IMetricOptions)

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

public virtual Metric MetricVolumeBytesUsed(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Average over 5 minutes

MetricVolumeReadIOPs(IMetricOptions)

The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.

public virtual Metric MetricVolumeReadIOPs(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Average over 5 minutes

MetricVolumeWriteIOPs(IMetricOptions)

The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals.

public virtual Metric MetricVolumeWriteIOPs(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Average over 5 minutes

Implements

Constructs.IConstruct