Interface CfnAssetModel.IMetricProperty

Contains an asset metric property.

Namespace: Amazon.CDK.AWS.IoTSiteWise

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnAssetModel.IMetricProperty

Syntax (vb)

Public Interface CfnAssetModel.IMetricProperty

Remarks

With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum).

The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a root metric can have up to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE .

For more information, see Metrics in the AWS IoT SiteWise User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metric.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.IoTSiteWise;

             var metricProperty = new MetricProperty {
                 Expression = "expression",
                 Variables = new [] { new ExpressionVariableProperty {
                     Name = "name",
                     Value = new VariableValueProperty {
                         HierarchyExternalId = "hierarchyExternalId",
                         HierarchyId = "hierarchyId",
                         HierarchyLogicalId = "hierarchyLogicalId",
                         PropertyExternalId = "propertyExternalId",
                         PropertyId = "propertyId",
                         PropertyLogicalId = "propertyLogicalId",
                         PropertyPath = new [] { new PropertyPathDefinitionProperty {
                             Name = "name"
                         } }
                     }
                 } },
                 Window = new MetricWindowProperty {
                     Tumbling = new TumblingWindowProperty {
                         Interval = "interval",

                         // the properties below are optional
                         Offset = "offset"
                     }
                 }
             };

Synopsis

Properties

Expression	The mathematical expression that defines the metric aggregation function.
Variables	The list of variables used in the expression.
Window	The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression.