software.amazon.awscdk.services.iot.actions.alpha

Interface CloudWatchPutMetricActionProps

All Superinterfaces:

CommonActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CloudWatchPutMetricActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.78.1 (build 878761e)",
           date="2023-04-17T22:38:13.256Z")
 @Stability(value=Experimental)
public interface CloudWatchPutMetricActionProps
extends software.amazon.jsii.JsiiSerializable, CommonActionProps

(experimental) Configuration properties of an action for CloudWatch metric.

Example:

 TopicRule topicRule = TopicRule.Builder.create(this, "TopicRule")
         .sql(IotSql.fromStringAsVer20160323("SELECT topic(2) as device_id, namespace, unit, value, timestamp FROM 'device/+/data'"))
         .actions(List.of(
             CloudWatchPutMetricAction.Builder.create()
                     .metricName("${topic(2)}")
                     .metricNamespace("${namespace}")
                     .metricUnit("${unit}")
                     .metricValue("${value}")
                     .metricTimestamp("${timestamp}")
                     .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CloudWatchPutMetricActionProps.Builder	builder()
String	getMetricName() (experimental) The CloudWatch metric name.
String	getMetricNamespace() (experimental) The CloudWatch metric namespace name.
default String	getMetricTimestamp() (experimental) A string that contains the timestamp, expressed in seconds in Unix epoch time.
String	getMetricUnit() (experimental) The metric unit supported by CloudWatch.
String	getMetricValue() (experimental) A string that contains the CloudWatch metric value.

Methods inherited from interface software.amazon.awscdk.services.iot.actions.alpha.CommonActionProps

getRole

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMetricName

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

(experimental) The CloudWatch metric name.

Supports substitution templates.

See Also:

https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html

getMetricNamespace

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

(experimental) The CloudWatch metric namespace name.

Supports substitution templates.

See Also:

https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html

getMetricUnit

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

(experimental) The metric unit supported by CloudWatch.

Supports substitution templates.

See Also:

https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html

getMetricValue

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

(experimental) A string that contains the CloudWatch metric value.

Supports substitution templates.

See Also:

https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html

getMetricTimestamp

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

(experimental) A string that contains the timestamp, expressed in seconds in Unix epoch time.

Supports substitution templates.

Default: - none -- Defaults to the current Unix epoch time.

See Also:

https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html

builder

@Stability(value=Experimental)
static CloudWatchPutMetricActionProps.Builder builder()

Specified by:

builder in interface CommonActionProps

Returns:

a CloudWatchPutMetricActionProps.Builder of CloudWatchPutMetricActionProps