AWS::IoT::TopicRule CloudwatchMetricAction

Describes an action that captures a CloudWatch metric.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

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

YAML

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

Properties

MetricName

The CloudWatch metric name.

Required: Yes

Type: String

Update requires: No interruption

MetricNamespace

The CloudWatch metric namespace name.

Required: Yes

Type: String

Update requires: No interruption

MetricTimestamp

An optional Unix timestamp.

Required: No

Type: String

Update requires: No interruption

MetricUnit

The metric unit supported by CloudWatch.

Required: Yes

Type: String

Update requires: No interruption

MetricValue

The CloudWatch metric value.

Required: Yes

Type: String

Update requires: No interruption

RoleArn

The IAM role that allows access to the CloudWatch metric.

Required: Yes

Type: String

Update requires: No interruption