Interface ICloudWatchPutMetricActionProps

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

Inherited Members

Namespace: Amazon.CDK.AWS.IoT.Actions

Assembly: Amazon.CDK.AWS.IoT.Actions.dll

Syntax (csharp)

public interface ICloudWatchPutMetricActionProps : ICommonActionProps

Syntax (vb)

Public Interface ICloudWatchPutMetricActionProps
    Inherits ICommonActionProps

Remarks

Stability: Experimental

ExampleMetadata: infused

Examples

var topicRule = new TopicRule(this, "TopicRule", new TopicRuleProps {
    Sql = IotSql.FromStringAsVer20160323("SELECT topic(2) as device_id, namespace, unit, value, timestamp FROM 'device/+/data'"),
    Actions = new [] {
        new CloudWatchPutMetricAction(new CloudWatchPutMetricActionProps {
            MetricName = "${topic(2)}",
            MetricNamespace = "${namespace}",
            MetricUnit = "${unit}",
            MetricValue = "${value}",
            MetricTimestamp = "${timestamp}"
        }) }
});

Synopsis

Properties

MetricName	(experimental) The CloudWatch metric name.
MetricNamespace	(experimental) The CloudWatch metric namespace name.
MetricTimestamp	(experimental) A string that contains the timestamp, expressed in seconds in Unix epoch time.
MetricUnit	(experimental) The metric unit supported by CloudWatch.
MetricValue	(experimental) A string that contains the CloudWatch metric value.

Properties

MetricName

(experimental) The CloudWatch metric name.

string MetricName { get; }

Property Value

System.String

Remarks

Supports substitution templates.

Stability: Experimental

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

MetricNamespace

(experimental) The CloudWatch metric namespace name.

string MetricNamespace { get; }

Property Value

System.String

Remarks

Supports substitution templates.

Stability: Experimental

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

MetricTimestamp

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

virtual string MetricTimestamp { get; }

Property Value

System.String

Remarks

Supports substitution templates.

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

Stability: Experimental

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

MetricUnit

(experimental) The metric unit supported by CloudWatch.

string MetricUnit { get; }

Property Value

System.String

Remarks

Supports substitution templates.

Stability: Experimental

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

MetricValue

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

string MetricValue { get; }

Property Value

System.String

Remarks

Supports substitution templates.

Stability: Experimental

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