Package 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(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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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 .
String	getMetricUnit()	The metric 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 Details

getMetricName

@Stability(Stable)
@NotNull
String getMetricName()

The CloudWatch metric name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricname

getMetricNamespace

@Stability(Stable)
@NotNull
String getMetricNamespace()

The CloudWatch metric namespace name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricnamespace

getMetricUnit

@Stability(Stable)
@NotNull
String getMetricUnit()

The metric unit supported by CloudWatch.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricunit

getMetricValue

@Stability(Stable)
@NotNull
String getMetricValue()

The CloudWatch metric value.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metricvalue

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The IAM role that allows access to the CloudWatch metric.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-rolearn

getMetricTimestamp

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

An optional Unix timestamp .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-cloudwatchmetricaction.html#cfn-iot-topicrule-cloudwatchmetricaction-metrictimestamp

builder

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

Returns:

a CfnTopicRule.CloudwatchMetricActionProperty.Builder of CfnTopicRule.CloudwatchMetricActionProperty