Package software.amazon.awscdk.cfnpropertymixins.services.iot

Interface CfnTopicRulePropsMixin.CloudwatchMetricActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRulePropsMixin.CloudwatchMetricActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRulePropsMixin

@Stability(Stable)
public static interface CfnTopicRulePropsMixin.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.cfnpropertymixins.services.iot.*;
 CloudwatchMetricActionProperty cloudwatchMetricActionProperty = CloudwatchMetricActionProperty.builder()
         .metricName("metricName")
         .metricNamespace("metricNamespace")
         .metricTimestamp("metricTimestamp")
         .metricUnit("metricUnit")
         .metricValue("metricValue")
         .roleArn("roleArn")
         .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	CfnTopicRulePropsMixin.CloudwatchMetricActionProperty.Builder	A builder for CfnTopicRulePropsMixin.CloudwatchMetricActionProperty
static final class	CfnTopicRulePropsMixin.CloudwatchMetricActionProperty.Jsii$Proxy	An implementation for CfnTopicRulePropsMixin.CloudwatchMetricActionProperty

Method Summary

Modifier and Type	Method	Description
static CfnTopicRulePropsMixin.CloudwatchMetricActionProperty.Builder	builder()
default String	getMetricName()	The CloudWatch metric name.
default String	getMetricNamespace()	The CloudWatch metric namespace name.
default String	getMetricTimestamp()	An optional Unix timestamp .
default String	getMetricUnit()	The metric unit supported by CloudWatch.
default String	getMetricValue()	The CloudWatch metric value.
default 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)
@Nullable
default 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)
@Nullable
default 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

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

getMetricUnit

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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

builder

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

Returns:

a CfnTopicRulePropsMixin.CloudwatchMetricActionProperty.Builder of CfnTopicRulePropsMixin.CloudwatchMetricActionProperty