Class CfnAssetModel.MetricProperty

Contains an asset metric property.

Inheritance

System.Object

CfnAssetModel.MetricProperty

Implements

CfnAssetModel.IMetricProperty

Namespace: Amazon.CDK.AWS.IoTSiteWise

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class MetricProperty : Object, CfnAssetModel.IMetricProperty

Syntax (vb)

Public Class MetricProperty
    Inherits Object
    Implements 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

Constructors

MetricProperty()

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.

Constructors

MetricProperty()

public MetricProperty()

Properties

Expression

The mathematical expression that defines the metric aggregation function.

public string Expression { get; set; }

Property Value

System.String

Remarks

You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metric.html#cfn-iotsitewise-assetmodel-metric-expression

Variables

The list of variables used in the expression.

public object Variables { get; set; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metric.html#cfn-iotsitewise-assetmodel-metric-variables

Window

The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression.

public object Window { get; set; }

Property Value

System.Object

Remarks

AWS IoT SiteWise computes one data point per window .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metric.html#cfn-iotsitewise-assetmodel-metric-window

Implements

CfnAssetModel.IMetricProperty