Interface IDatabaseCluster

Create a clustered database with a given number of instances.

Inherited Members

IResource.ApplyRemovalPolicy(RemovalPolicy)

IResource.Env

IResource.Stack

IConnectable.Connections

ISecretAttachmentTarget.AsSecretAttachmentTarget()

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IDatabaseCluster : IResource, IConstruct, IDependable, IConnectable, ISecretAttachmentTarget

Syntax (vb)

Public Interface IDatabaseCluster Inherits IResource, IConstruct, IDependable, IConnectable, ISecretAttachmentTarget

Synopsis

Properties

ClusterArn	The ARN of the database cluster.
ClusterEndpoint	The endpoint to use for read/write operations.
ClusterIdentifier	Identifier of the cluster.
ClusterReadEndpoint	Endpoint to use for load-balanced read-only operations.
ClusterResourceIdentifier	The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP.
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.
GrantConnect(IGrantable, string)	Grant the given identity connection access to the Cluster.
GrantDataApiAccess(IGrantable)	Grant the given identity to access to the Data API.
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.
MetricFreeLocalStorage(IMetricOptions?)	The amount of local storage available, in bytes.
MetricFreeableMemory(IMetricOptions?)	The amount of available random access memory, 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.

Properties

ClusterArn

The ARN of the database cluster.

string ClusterArn { get; }

Property Value

string

ClusterEndpoint

The endpoint to use for read/write operations.

Endpoint ClusterEndpoint { get; }

Property Value

Endpoint

Remarks

Attribute: EndpointAddress,EndpointPort

ClusterIdentifier

Identifier of the cluster.

string ClusterIdentifier { get; }

Property Value

string

ClusterReadEndpoint

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

Endpoint ClusterReadEndpoint { get; }

Property Value

Endpoint

Remarks

Attribute: ReadEndpointAddress

ClusterResourceIdentifier

The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP.

string ClusterResourceIdentifier { get; }

Property Value

string

Remarks

This AWS Region-unique identifier is used in things like IAM authentication policies.

Engine

The engine of this Cluster.

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.

Endpoint[] InstanceEndpoints { get; }

Property Value

Endpoint[]

InstanceIdentifiers

Identifiers of the replicas.

string[] InstanceIdentifiers { get; }

Property Value

string[]

Methods

AddProxy(string, IDatabaseProxyOptions)

Add a new db proxy to this cluster.

DatabaseProxy AddProxy(string id, IDatabaseProxyOptions options)

Parameters

id string
options IDatabaseProxyOptions

Returns

DatabaseProxy

GrantConnect(IGrantable, string)

Grant the given identity connection access to the Cluster.

Grant GrantConnect(IGrantable grantee, string dbUser)

Parameters

grantee IGrantable: the Principal to grant the permissions to.
dbUser string: the name of the database user to allow connecting.

Returns

Grant

GrantDataApiAccess(IGrantable)

Grant the given identity to access to the Data API.

Grant GrantDataApiAccess(IGrantable grantee)

Parameters

grantee IGrantable: The principal to grant access to.

Returns

Grant

Metric(string, IMetricOptions?)

Return the given named metric for this DBCluster.

Metric Metric(string metricName, IMetricOptions? props = null)

Parameters

metricName string
props IMetricOptions

Returns

Metric

MetricCPUUtilization(IMetricOptions?)

The percentage of CPU utilization.

Metric MetricCPUUtilization(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Average over 5 minutes

MetricDatabaseConnections(IMetricOptions?)

The number of database connections in use.

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.

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.

Metric MetricEngineUptime(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Average over 5 minutes

MetricFreeLocalStorage(IMetricOptions?)

The amount of local storage available, in bytes.

Metric MetricFreeLocalStorage(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Average over 5 minutes

MetricFreeableMemory(IMetricOptions?)

The amount of available random access memory, in bytes.

Metric MetricFreeableMemory(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.

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.

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.

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.

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.

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.

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.

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.

Metric MetricVolumeWriteIOPs(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Average over 5 minutes