Interface ICfnCustomMetricProps
Properties for defining a CfnCustomMetric
.
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.AWS.IoT.dll
Syntax (csharp)
public interface ICfnCustomMetricProps
Syntax (vb)
Public Interface ICfnCustomMetricProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-custommetric.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoT;
var cfnCustomMetricProps = new CfnCustomMetricProps {
MetricType = "metricType",
// the properties below are optional
DisplayName = "displayName",
MetricName = "metricName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Properties
DisplayName | The friendly name in the console for the custom metric. |
MetricName | The name of the custom metric. |
MetricType | The type of the custom metric. Types include |
Tags | Metadata that can be used to manage the custom metric. |
Properties
DisplayName
The friendly name in the console for the custom metric.
virtual string DisplayName { get; }
Property Value
System.String
Remarks
This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.
MetricName
The name of the custom metric.
virtual string MetricName { get; }
Property Value
System.String
Remarks
This will be used in the metric report submitted from the device/thing. The name can't begin with aws:
. You can’t change the name after you define it.
MetricType
The type of the custom metric. Types include string-list
, ip-address-list
, number-list
, and number
.
string MetricType { get; }
Property Value
System.String
Remarks
The type number
only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.
Tags
Metadata that can be used to manage the custom metric.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]