software.amazon.awscdk.services.iot

Interface CfnTopicRule.CloudwatchMetricActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRule.CloudwatchMetricActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRule

@Stability(value=Stable)
public static interface CfnTopicRule.CloudwatchMetricActionProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.iot.*;
 CloudwatchMetricActionProperty cloudwatchMetricActionProperty = CloudwatchMetricActionProperty.builder()
         .metricName("metricName")
         .metricNamespace("metricNamespace")
         .metricUnit("metricUnit")
         .metricValue("metricValue")
         .roleArn("roleArn")
         // the properties below are optional
         .metricTimestamp("metricTimestamp")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnTopicRule.CloudwatchMetricActionProperty.Builder A builder for CfnTopicRule.CloudwatchMetricActionProperty
static class	CfnTopicRule.CloudwatchMetricActionProperty.Jsii$Proxy An implementation for CfnTopicRule.CloudwatchMetricActionProperty

Method Summary

Modifier and Type	Method and Description
static CfnTopicRule.CloudwatchMetricActionProperty.Builder	builder()
String	getMetricName() The CloudWatch metric name.
String	getMetricNamespace() The CloudWatch metric namespace name.
default String	getMetricTimestamp() An optional [Unix timestamp](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp) .
String	getMetricUnit() The [metric unit](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit) supported by CloudWatch.
String	getMetricValue() The CloudWatch metric value.
String	getRoleArn() The IAM role that allows access to the CloudWatch metric.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMetricName

@Stability(value=Stable)
 @NotNull
String getMetricName()

The CloudWatch metric name.

getMetricNamespace

@Stability(value=Stable)
 @NotNull
String getMetricNamespace()

The CloudWatch metric namespace name.

getMetricUnit

@Stability(value=Stable)
 @NotNull
String getMetricUnit()

The [metric unit](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit) supported by CloudWatch.

getMetricValue

@Stability(value=Stable)
 @NotNull
String getMetricValue()

The CloudWatch metric value.

getRoleArn

@Stability(value=Stable)
 @NotNull
String getRoleArn()

The IAM role that allows access to the CloudWatch metric.

getMetricTimestamp

@Stability(value=Stable)
 @Nullable
default String getMetricTimestamp()

An optional [Unix timestamp](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp) .

builder

@Stability(value=Stable)
static CfnTopicRule.CloudwatchMetricActionProperty.Builder builder()

Returns:

a CfnTopicRule.CloudwatchMetricActionProperty.Builder of CfnTopicRule.CloudwatchMetricActionProperty