Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS IoT TopicRule CloudwatchMetricAction

CloudwatchMetric is a property of the Actions property that describes an action that captures a CloudWatch metric.

Syntax

JSON

Copy
{ "MetricName": String, "MetricNamespace": String, "MetricTimestamp": String, "MetricUnit": String, "MetricValue": String, "RoleArn": String }

YAML

Copy
MetricName: String MetricNamespace: String MetricTimestamp: String MetricUnit: String MetricValue: String RoleArn: String

Properties

MetricName

The name of the CloudWatch metric.

Required: Yes

Type: String

MetricNamespace

The name of the CloudWatch metric namespace.

Required: Yes

Type: String

MetricTimestamp

An optional Unix timestamp.

Required: No

Type: String

MetricUnit

The metric unit supported by Amazon CloudWatch.

Required: Yes

Type: String

MetricValue

The value to publish to the metric. For example, if you count the occurrences of a particular term such as Error, the value will be 1 for each occurrence.

Required: Yes

Type: String

RoleArn

The ARN of the IAM role that grants access to the CloudWatch metric.

Required: Yes

Type: String

On this page: