Module classic/rds

APIs

metrics

APIs

namespace metrics

function activeTransactions

activeTransactions(change?: RdsMetricChange): Metric

The average number of current transactions executing on an Aurora database instance per second. By default, Aurora doesn’t enable this metric. To begin measuring this value, set innodb_monitor_enable=‘all’ in the DB parameter group for a specific DB instance.

Applies to: Aurora MySQL

function auroraBinlogReplicaLag

auroraBinlogReplicaLag(change?: RdsMetricChange): Metric

The amount of time a replica DB cluster running on Aurora with MySQL compatibility lags behind the source DB cluster. This metric reports the value of the Seconds_Behind_Master field of the MySQL SHOW SLAVE STATUS command. This metric is useful for monitoring replica lag between Aurora DB clusters that are replicating across different AWS Regions. For more information, see Aurora MySQL Replication.

Applies to: Aurora MySQL

function auroraGlobalDBDataTransferBytes

auroraGlobalDBDataTransferBytes(change?: RdsMetricChange): Metric

Units: Bytes

Applies to: Aurora MySQL

function auroraGlobalDBReplicatedWriteIO

auroraGlobalDBReplicatedWriteIO(change?: RdsMetricChange): Metric

Units: Bytes

Applies to: Aurora MySQL

function auroraGlobalDBReplicationLag

auroraGlobalDBReplicationLag(change?: RdsMetricChange): Metric

Units: Milliseconds

Applies to: Aurora MySQL

function auroraReplicaLag

auroraReplicaLag(change?: RdsMetricChange): Metric

For an Aurora Replica, the amount of lag when replicating updates from the primary instance, in milliseconds.

Applies to: Aurora MySQL and Aurora PostgreSQL

function auroraReplicaLagMaximum

auroraReplicaLagMaximum(change?: RdsMetricChange): Metric

The maximum amount of lag between the primary instance and each Aurora DB instance in the DB cluster, in milliseconds.

Applies to: Aurora MySQL and Aurora PostgreSQL

function auroraReplicaLagMinimum

auroraReplicaLagMinimum(change?: RdsMetricChange): Metric

The minimum amount of lag between the primary instance and each Aurora DB instance in the DB cluster, in milliseconds.

Applies to: Aurora MySQL and Aurora PostgreSQL

function backtrackChangeRecordsCreationRate

backtrackChangeRecordsCreationRate(change?: RdsMetricChange): Metric

The number of backtrack change records created over five minutes for your DB cluster.

Applies to: Aurora MySQL

function backtrackChangeRecordsStored

backtrackChangeRecordsStored(change?: RdsMetricChange): Metric

The actual number of backtrack change records used by your DB cluster.

Applies to: Aurora MySQL

function backtrackWindowActual

backtrackWindowActual(change?: RdsMetricChange): Metric

The difference between the target backtrack window and the actual backtrack window.

Applies to: Aurora MySQL

function backtrackWindowAlert

backtrackWindowAlert(change?: RdsMetricChange): Metric

The number of times that the actual backtrack window is smaller than the target backtrack window for a given period of time.

Applies to: Aurora MySQL

function backupRetentionPeriodStorageUsed

backupRetentionPeriodStorageUsed(change?: RdsMetricChange): Metric

The total amount of backup storage in GiB used to support the point-in-time restore feature within the Aurora DB cluster’s backup retention window. Included in the total reported by the TotalBackupStorageBilled metric. Computed separately for each Aurora cluster. For instructions, see Understanding Aurora Backup Storage Usage. Units: Gibibytes (GiB)

Applies to: Aurora MySQL and Aurora PostgreSQL

function binLogDiskUsage

binLogDiskUsage(change?: RdsMetricChange): Metric

The amount of disk space occupied by binary logs on the master. Applies to MySQL read replicas.

Units: Bytes

function blockedTransactions

blockedTransactions(change?: RdsMetricChange): Metric

The average number of transactions in the database that are blocked per second.

Applies to: Aurora MySQL

function bufferCacheHitRatio

bufferCacheHitRatio(change?: RdsMetricChange): Metric

The percentage of requests that are served by the buffer cache.

Applies to: Aurora MySQL and Aurora PostgreSQL

function burstBalance

burstBalance(change?: RdsMetricChange): Metric

The percent of General Purpose SSD (gp2) burst-bucket I/O credits available.

Units: Percent

function commitLatency

commitLatency(change?: RdsMetricChange): Metric

The amount of latency for commit operations, in milliseconds.

Applies to: Aurora MySQL and Aurora PostgreSQL

function commitThroughput

commitThroughput(change?: RdsMetricChange): Metric

The average number of commit operations per second.

Applies to: Aurora MySQL and Aurora PostgreSQL

function cpuCreditBalance

cpuCreditBalance(change?: RdsMetricChange): Metric

[T2 instances] The number of earned CPU credits that an instance has accrued since it was launched or started. For T2 Standard, the CPUCreditBalance also includes the number of launch credits that have been accrued.

Credits are accrued in the credit balance after they are earned, and removed from the credit balance when they are spent. The credit balance has a maximum limit, determined by the instance size. Once the limit is reached, any new credits that are earned are discarded. For T2 Standard, launch credits do not count towards the limit.

The credits in the CPUCreditBalance are available for the instance to spend to burst beyond its baseline CPU utilization.

When an instance is running, credits in the CPUCreditBalance do not expire. When the instance stops, the CPUCreditBalance does not persist, and all accrued credits are lost.

CPU credit metrics are available at a five-minute frequency only.

function cpuCreditUsage

cpuCreditUsage(change?: RdsMetricChange): Metric

[T2 instances] The number of CPU credits spent by the instance for CPU utilization. One CPU credit equals one vCPU running at 100% utilization for one minute or an equivalent combination of vCPUs, utilization, and time (for example, one vCPU running at 50% utilization for two minutes or two vCPUs running at 25% utilization for two minutes).

CPU credit metrics are available at a five-minute frequency only. If you specify a period greater than five minutes, use the Sum statistic instead of the Average statistic.

function cpuUtilization

cpuUtilization(change?: RdsMetricChange): Metric

The percentage of CPU utilization.

Units: Percent

function databaseConnections

databaseConnections(change?: RdsMetricChange): Metric

The number of database connections in use.

Units: Count

function ddlLatency

ddlLatency(change?: RdsMetricChange): Metric

The amount of latency for data definition language (DDL) requests, in milliseconds—for example, create, alter, and drop requests.

Applies to: Aurora MySQL

function ddlThroughput

ddlThroughput(change?: RdsMetricChange): Metric

The average number of DDL requests per second.

Applies to: Aurora MySQL

function deadlocks

deadlocks(change?: RdsMetricChange): Metric

The average number of deadlocks in the database per second.

Applies to: Aurora MySQL and Aurora PostgreSQL

function deleteLatency

deleteLatency(change?: RdsMetricChange): Metric

The amount of latency for delete queries, in milliseconds.

Applies to: Aurora MySQL

function deleteThroughput

deleteThroughput(change?: RdsMetricChange): Metric

The average number of delete queries per second.

Applies to: Aurora MySQL

function diskQueueDepth

diskQueueDepth(change?: RdsMetricChange): Metric

The number of outstanding IOs (read/write requests) waiting to access the disk.

Units: Count

function dmlLatency

dmlLatency(change?: RdsMetricChange): Metric

The amount of latency for inserts, updates, and deletes, in milliseconds.

Applies to: Aurora MySQL

function dmlThroughput

dmlThroughput(change?: RdsMetricChange): Metric

The average number of inserts, updates, and deletes per second.

Applies to: Aurora MySQL

function engineUptime

engineUptime(change?: RdsMetricChange): Metric

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

Applies to: Aurora MySQL and Aurora PostgreSQL

function failedSQLServerAgentJobsCount

failedSQLServerAgentJobsCount(change?: RdsMetricChange): Metric

The number of failed SQL Server Agent jobs during the last minute.

Unit: Count/Minute

function freeableMemory

freeableMemory(change?: RdsMetricChange): Metric

The amount of available random access memory.

Units: Bytes

function freeLocalStorage

freeLocalStorage(change?: RdsMetricChange): Metric

The amount of storage available for temporary tables and logs, in bytes. Unlike for other DB engines, for Aurora DB instances this metric reports the amount of storage available to each DB instance for temporary tables and logs. This value depends on the DB instance class (for pricing information, see the Amazon RDS product page). You can increase the amount of free storage space for an instance by choosing a larger DB instance class for your instance.

Applies to: Aurora MySQL and Aurora PostgreSQL

function freeStorageSpace

freeStorageSpace(change?: RdsMetricChange): Metric

The amount of available storage space.

Units: Bytes

function insertLatency

insertLatency(change?: RdsMetricChange): Metric

The amount of latency for insert queries, in milliseconds.

Applies to: Aurora MySQL

function insertThroughput

insertThroughput(change?: RdsMetricChange): Metric

The average number of insert queries per second.

Applies to: Aurora MySQL

function loginFailures

loginFailures(change?: RdsMetricChange): Metric

The average number of failed login attempts per second.

Applies to: Aurora MySQL

function maximumUsedTransactionIDs

maximumUsedTransactionIDs(change?: RdsMetricChange): Metric

The maximum transaction ID that has been used. Applies to PostgreSQL.

Units: Count

function metric

metric(metricName: RdsMetricName, change: RdsMetricChange): Metric

Creates an AWS/RDS metric with the requested [metricName]. See https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MonitoringOverview.html#monitoring-cloudwatch for list of all metric-names.

Note, individual metrics can easily be obtained without supplying the name using the other [metricXXX] functions.

You can monitor DB instances using Amazon CloudWatch, which collects and processes raw data from Amazon RDS into readable, near real-time metrics. These statistics are recorded for a period of two weeks, so that you can access historical information and gain a better perspective on how your web application or service is performing. By default, Amazon RDS metric data is automatically sent to CloudWatch in 1-minute periods.

Amazon RDS metrics data can be filtered by using any of the following dimensions:

“DBInstanceIdentifier”: This dimension filters the data you request for a specific database instance.
“DBClusterIdentifier”: This dimension filters the data you request for a specific Amazon Aurora DB cluster.
“DBClusterIdentifier, Role”: This dimension filters the data you request for a specific Aurora DB cluster, aggregating the metric by instance role (WRITER/READER). For example, you can aggregate metrics for all READER instances that belong to a cluster.
“DatabaseClass”: This dimension filters the data you request for all instances in a database class. For example, you can aggregate metrics for all instances that belong to the database class db.m1.small
“EngineName”: This dimension filters the data you request for the identified engine name only. For example, you can aggregate metrics for all instances that have the engine name mysql.
“SourceRegion”: This dimension filters the data you request for the specified region only. For example, you can aggregate metrics for all instances in the region us-east-1.

function networkReceiveThroughput

networkReceiveThroughput(change?: RdsMetricChange): Metric

The incoming (Receive) network traffic on the DB instance, including both customer database traffic and Amazon RDS traffic used for monitoring and replication.

Units: Bytes/Second

function networkThroughput

networkThroughput(change?: RdsMetricChange): Metric

The amount of network throughput both received from and transmitted to clients by each instance in the Aurora MySQL DB cluster, in bytes per second. This throughput doesn’t include network traffic between instances in the DB cluster and the cluster volume.

Applies to: Aurora MySQL and Aurora PostgreSQL

function networkTransmitThroughput

networkTransmitThroughput(change?: RdsMetricChange): Metric

The outgoing (Transmit) network traffic on the DB instance, including both customer database traffic and Amazon RDS traffic used for monitoring and replication.

Units: Bytes/Second

function oldestReplicationSlotLag

oldestReplicationSlotLag(change?: RdsMetricChange): Metric

The lagging size of the replica lagging the most in terms of WAL data received. Applies to PostgreSQL.

Units: Megabytes

function queries

queries(change?: RdsMetricChange): Metric

The average number of queries executed per second.

Applies to: Aurora MySQL

interface RdsMetricChange

interface RdsMetricChange extends MetricChange

property cluster

cluster?: aws.rds.Cluster;

Optional [Cluster] to filter down events to.

property color

color?: pulumi.Input<string>;

The six-digit HTML hex color code to be used for this metric.

Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].

property databaseClass

databaseClass?: undefined | string;

This dimension filters the data you request for all instances in a database class. For example, you can aggregate metrics for all instances that belong to the database class [db.m1.small].

property dimensions

dimensions?: pulumi.Input<Record<string, pulumi.Input<string>>>;

The new dimension for this metric. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be cleared.

property engineName

engineName?: undefined | string;

This dimension filters the data you request for the identified engine name only. For example, you can aggregate metrics for all instances that have the engine name [mysql].

property extendedStatistic

extendedStatistic?: pulumi.Input<number>;

The new percentile statistic for the metric associated with the alarm. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default.

property instance

instance?: aws.rds.Instance;

Optional [Instance] to filter down events to.

property label

label?: pulumi.Input<string>;

The label to display for this metric in the graph legend. If this is not specified, the metric is given an autogenerated label that distinguishes it from the other metrics in the widget.

Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].

property period

period?: pulumi.Input<number>;

The new period in seconds over which the specified stat is applied. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default (300s).

property role

role?: "WRITER" | "READER";

This dimension filters the data you request for a specific Aurora DB cluster, aggregating the metric by instance role (WRITER/READER). For example, you can aggregate metrics for all READER instances that belong to a cluster.

If this is provided then [cluster] must be provided as well.

property sourceRegion

sourceRegion?: aws.Region;

This dimension filters the data you request for the specified region only. For example, you can aggregate metrics for all instances in the region [us-east-1].

property statistic

statistic?: pulumi.Input<MetricStatistic>;

The new statistic to apply to the alarm’s associated metric. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default.

property unit

unit?: pulumi.Input<MetricUnit>;

The new unit for this metric. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default.

property visible

visible?: pulumi.Input<boolean>;

Set this to true to have the metric appear in the graph, or false to have it be hidden. The default is true.

Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].

property yAxis

yAxis?: pulumi.Input<"left" | "right">;

Where on the graph to display the y-axis for this metric. The default is left.

Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].

type RdsMetricName

type RdsMetricName = "BinLogDiskUsage" | "BurstBalance" | "CPUUtilization" | "CPUCreditUsage" | "CPUCreditBalance" | "DatabaseConnections" | "DiskQueueDepth" | "FailedSQLServerAgentJobsCount" | "FreeableMemory" | "FreeStorageSpace" | "MaximumUsedTransactionIDs" | "NetworkReceiveThroughput" | "NetworkTransmitThroughput" | "OldestReplicationSlotLag" | "ReadIOPS" | "ReadLatency" | "ReadThroughput" | "ReplicaLag" | "ReplicationSlotDiskUsage" | "SwapUsage" | "TransactionLogsDiskUsage" | "TransactionLogsGeneration" | "WriteIOPS" | "WriteLatency" | "WriteThroughput" | "ActiveTransactions" | "AuroraBinlogReplicaLag" | "AuroraGlobalDBReplicatedWriteIO" | "AuroraGlobalDBDataTransferBytes" | "AuroraGlobalDBReplicationLag" | "AuroraReplicaLag" | "AuroraReplicaLagMaximum" | "AuroraReplicaLagMinimum" | "BacktrackChangeRecordsCreationRate" | "BacktrackChangeRecordsStored" | "BacktrackWindowActual" | "BacktrackWindowAlert" | "BackupRetentionPeriodStorageUsed" | "BinLogDiskUsage" | "BlockedTransactions" | "BufferCacheHitRatio" | "CommitLatency" | "CommitThroughput" | "CPUCreditBalance" | "CPUCreditUsage" | "CPUUtilization" | "DatabaseConnections" | "DDLLatency" | "DDLThroughput" | "Deadlocks" | "DeleteLatency" | "DeleteThroughput" | "DiskQueueDepth" | "DMLLatency" | "DMLThroughput" | "EngineUptime" | "FreeableMemory" | "FreeLocalStorage" | "InsertLatency" | "InsertThroughput" | "LoginFailures" | "MaximumUsedTransactionIDs" | "NetworkReceiveThroughput" | "NetworkThroughput" | "NetworkTransmitThroughput" | "Queries" | "RDSToAuroraPostgreSQLReplicaLag" | "ReadIOPS" | "ReadLatency" | "ReadThroughput" | "ResultSetCacheHitRatio" | "SelectLatency" | "SelectThroughput" | "SnapshotStorageUsed" | "SwapUsage" | "TotalBackupStorageBilled" | "TransactionLogsDiskUsage" | "UpdateLatency" | "UpdateThroughput" | "VolumeBytesUsed" | "VolumeReadIOPs" | "VolumeWriteIOPs" | "WriteIOPS" | "WriteLatency" | "WriteThroughput";

function rdsToAuroraPostgreSQLReplicaLag

rdsToAuroraPostgreSQLReplicaLag(change?: RdsMetricChange): Metric

The amount of lag in seconds when replicating updates from the primary RDS PostgreSQL instance to other nodes in the cluster.

Applies to: Aurora PostgreSQL

function readIOPS

readIOPS(change?: RdsMetricChange): Metric

The average number of disk read I/O operations per second.

Units: Count/Second

function readLatency

readLatency(change?: RdsMetricChange): Metric

The average amount of time taken per disk I/O operation.

Units: Seconds

function readThroughput

readThroughput(change?: RdsMetricChange): Metric

The average number of bytes read from disk per second.

Units: Bytes/Second

function replicaLag

replicaLag(change?: RdsMetricChange): Metric

The amount of time a Read Replica DB instance lags behind the source DB instance. Applies to MySQL, MariaDB, and PostgreSQL Read Replicas.

Units: Seconds

function replicationSlotDiskUsage

replicationSlotDiskUsage(change?: RdsMetricChange): Metric

The disk space used by replication slot files. Applies to PostgreSQL.

Units: Megabytes

function resultSetCacheHitRatio

resultSetCacheHitRatio(change?: RdsMetricChange): Metric

The percentage of requests that are served by the Resultset cache.

Applies to: Aurora MySQL

function selectLatency

selectLatency(change?: RdsMetricChange): Metric

The amount of latency for select queries, in milliseconds.

Applies to: Aurora MySQL

function selectThroughput

selectThroughput(change?: RdsMetricChange): Metric

The average number of select queries per second.

Applies to: Aurora MySQL

function snapshotStorageUsed

snapshotStorageUsed(change?: RdsMetricChange): Metric

The total amount of backup storage in GiB consumed by all Aurora snapshots for an Aurora DB cluster outside its backup retention window. Included in the total reported by the TotalBackupStorageBilled metric. Computed separately for each Aurora cluster. For instructions, see Understanding Aurora Backup Storage Usage. Units: Gibibytes (GiB)

Applies to: Aurora MySQL and Aurora PostgreSQL

function swapUsage

swapUsage(change?: RdsMetricChange): Metric

The amount of swap space used on the DB instance. This metric is not available for SQL Server.

Units: Bytes

function totalBackupStorageBilled

totalBackupStorageBilled(change?: RdsMetricChange): Metric

The total amount of backup storage in GiB for which you are billed for a given Aurora DB cluster. Includes the backup storage measured by the BackupRetentionPeriodStorageUsed and SnapshotStorageUsed metrics. Computed separately for each Aurora cluster. For instructions, see Understanding Aurora Backup Storage Usage. Units: Gibibytes (GiB)

Applies to: Aurora MySQL and Aurora PostgreSQL

function transactionLogsDiskUsage

transactionLogsDiskUsage(change?: RdsMetricChange): Metric

The disk space used by transaction logs. Applies to PostgreSQL.

Units: Megabytes

function transactionLogsGeneration

transactionLogsGeneration(change?: RdsMetricChange): Metric

The size of transaction logs generated per second. Applies to PostgreSQL.

Units: Megabytes/Second

function updateLatency

updateLatency(change?: RdsMetricChange): Metric

The amount of latency for update queries, in milliseconds.

Applies to: Aurora MySQL

function updateThroughput

updateThroughput(change?: RdsMetricChange): Metric

The average number of update queries per second.

Applies to: Aurora MySQL

function volumeBytesUsed

volumeBytesUsed(change?: RdsMetricChange): Metric

The amount of storage used by your Aurora DB instance, in bytes. This value affects the cost of the Aurora DB cluster (for pricing information, see the Amazon RDS product page).

Applies to: Aurora MySQL and Aurora PostgreSQL

function volumeReadIOPs

volumeReadIOPs(change?: RdsMetricChange): Metric

The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals. Billed read operations are calculated at the cluster volume level, aggregated from all instances in the Aurora DB cluster, and then reported at 5-minute intervals. The value is calculated by taking the value of the Read operations metric over a 5-minute period. You can determine the amount of billed read operations per second by taking the value of the Billed read operations metric and dividing by 300 seconds. For example, if the Billed read operations returns 13,686, then the billed read operations per second is 45 (13,686 / 300 = 45.62). You accrue billed read operations for queries that request database pages that aren’t in the buffer cache and therefore must be loaded from storage. You might see spikes in billed read operations as query results are read from storage and then loaded into the buffer cache.

Applies to: Aurora MySQL and Aurora PostgreSQL

function volumeWriteIOPs

volumeWriteIOPs(change?: RdsMetricChange): Metric

The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals. See the description of VolumeReadIOPS above for a detailed description of how billed write operations are calculated.

Applies to: Aurora MySQL and Aurora PostgreSQL

function writeIOPS

writeIOPS(change?: RdsMetricChange): Metric

The average number of disk write I/O operations per second.

Units: Count/Second

function writeLatency

writeLatency(change?: RdsMetricChange): Metric

The average amount of time taken per disk I/O operation.

Units: Seconds

function writeThroughput

writeThroughput(change?: RdsMetricChange): Metric

The average number of bytes written to disk per second.

Units: Bytes/Second