Module cloudwatch/events

@pulumi/awsx > cloudwatch > events

function deadLetterInvocations

deadLetterInvocations(change?: CloudWatchMetricChange): Metric

Measures the number of times a rule’s target is not invoked in response to an event. This includes invocations that would result in triggering the same rule again, causing an infinite loop.

Valid Dimensions: RuleName Units: Count

function failedInvocations

failedInvocations(change?: CloudWatchMetricChange): Metric

Measures the number of invocations that failed permanently. This does not include invocations that are retried, or that succeeded after a retry attempt. It also does not count failed invocations that are counted in DeadLetterInvocations.

Valid Dimensions: RuleName Units: Count

function invocations

invocations(change?: CloudWatchMetricChange): Metric

Measures the number of times a target is invoked for a rule in response to an event. This includes successful and failed invocations, but does not include throttled or retried attempts until they fail permanently. It does not include DeadLetterInvocations.

Note: CloudWatch Events only sends this metric to CloudWatch if it has a non-zero value.

Valid Dimensions: RuleName Units: Count

function matchedEvents

matchedEvents(change?: CloudWatchMetricChange): Metric

Measures the number of events that matched with any rule.

Valid Dimensions: None Units: Count

function metric

metric(metricName: CloudWatchEventMetricName, change: CloudWatchMetricChange): Metric

CloudWatch Events sends metrics to Amazon CloudWatch every minute.

Creates an AWS/Events metric with the requested [metricName]. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatch-Events-Monitoring-CloudWatch-Metrics.html for list of all metric-names.

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

All of these metrics use Count as the unit, so Sum and SampleCount are the most useful statistics.

CloudWatch Events metrics have one dimension:

  1. “RuleName”: Filters the available metrics by rule name.

function throttledRules

throttledRules(change?: CloudWatchMetricChange): Metric

Measures the number of triggered rules that are being throttled.

Valid Dimensions: RuleName Units: Count

function triggeredRules

triggeredRules(change?: CloudWatchMetricChange): Metric

Measures the number of triggered rules that matched with any event.

Valid Dimensions: RuleName Units: Count

interface CloudWatchMetricChange

extends MetricChange

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 dimensions

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

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 eventRule

eventRule?: aws.cloudwatch.EventRule;

Filters down events to those from the specified [EventRule].

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 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 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 CloudWatchEventMetricName

type CloudWatchEventMetricName = "DeadLetterInvocations" | "Invocations" | "FailedInvocations" | "TriggeredRules" | "MatchedEvents" | "ThrottledRules";