aws-cdk-lib.aws_iot.CfnTopicRule.CloudwatchMetricActionProperty

interface CloudwatchMetricActionProperty

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnTopicRule.CloudwatchMetricActionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnTopicRule_CloudwatchMetricActionProperty
Javasoftware.amazon.awscdk.services.iot.CfnTopicRule.CloudwatchMetricActionProperty
Pythonaws_cdk.aws_iot.CfnTopicRule.CloudwatchMetricActionProperty
TypeScript aws-cdk-lib » aws_iot » CfnTopicRule » CloudwatchMetricActionProperty

Describes an action that captures a CloudWatch metric.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iot as iot } from 'aws-cdk-lib';
const cloudwatchMetricActionProperty: iot.CfnTopicRule.CloudwatchMetricActionProperty = {
  metricName: 'metricName',
  metricNamespace: 'metricNamespace',
  metricUnit: 'metricUnit',
  metricValue: 'metricValue',
  roleArn: 'roleArn',

  // the properties below are optional
  metricTimestamp: 'metricTimestamp',
};

Properties

NameTypeDescription
metricNamestringThe CloudWatch metric name.
metricNamespacestringThe CloudWatch metric namespace name.
metricUnitstringThe metric unit supported by CloudWatch.
metricValuestringThe CloudWatch metric value.
roleArnstringThe IAM role that allows access to the CloudWatch metric.
metricTimestamp?stringAn optional Unix timestamp .

metricName

Type: string

The CloudWatch metric name.


metricNamespace

Type: string

The CloudWatch metric namespace name.


metricUnit

Type: string

The metric unit supported by CloudWatch.


metricValue

Type: string

The CloudWatch metric value.


roleArn

Type: string

The IAM role that allows access to the CloudWatch metric.


metricTimestamp?

Type: string (optional)

An optional Unix timestamp .