Package software.amazon.awscdk.mixins.preview.services.iotsitewise.mixins

Interface CfnAssetModelPropsMixin.MetricProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAssetModelPropsMixin.MetricProperty.Jsii$Proxy

Enclosing class:

CfnAssetModelPropsMixin

@Stability(Stable)
public static interface CfnAssetModelPropsMixin.MetricProperty
extends software.amazon.jsii.JsiiSerializable

Contains an asset metric property.

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.mixins.preview.services.iotsitewise.mixins.*;
 MetricProperty metricProperty = MetricProperty.builder()
         .expression("expression")
         .variables(List.of(ExpressionVariableProperty.builder()
                 .name("name")
                 .value(VariableValueProperty.builder()
                         .hierarchyExternalId("hierarchyExternalId")
                         .hierarchyId("hierarchyId")
                         .hierarchyLogicalId("hierarchyLogicalId")
                         .propertyExternalId("propertyExternalId")
                         .propertyId("propertyId")
                         .propertyLogicalId("propertyLogicalId")
                         .propertyPath(List.of(PropertyPathDefinitionProperty.builder()
                                 .name("name")
                                 .build()))
                         .build())
                 .build()))
         .window(MetricWindowProperty.builder()
                 .tumbling(TumblingWindowProperty.builder()
                         .interval("interval")
                         .offset("offset")
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-metric.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAssetModelPropsMixin.MetricProperty.Builder	A builder for CfnAssetModelPropsMixin.MetricProperty
static final class	CfnAssetModelPropsMixin.MetricProperty.Jsii$Proxy	An implementation for CfnAssetModelPropsMixin.MetricProperty

Method Summary

Modifier and Type	Method	Description
static CfnAssetModelPropsMixin.MetricProperty.Builder	builder()
default String	getExpression()	The mathematical expression that defines the metric aggregation function.
default Object	getVariables()	The list of variables used in the expression.
default Object	getWindow()	The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExpression

@Stability(Stable)
@Nullable
default String getExpression()

The mathematical expression that defines the metric aggregation function.

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 Also:

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

getVariables

@Stability(Stable)
@Nullable
default Object getVariables()

The list of variables used in the expression.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAssetModelPropsMixin.ExpressionVariableProperty>

See Also:

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

getWindow

@Stability(Stable)
@Nullable
default Object getWindow()

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

AWS IoT SiteWise computes one data point per window .

Returns union: either IResolvable or CfnAssetModelPropsMixin.MetricWindowProperty

See Also:

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

builder

@Stability(Stable)
static CfnAssetModelPropsMixin.MetricProperty.Builder builder()

Returns:

a CfnAssetModelPropsMixin.MetricProperty.Builder of CfnAssetModelPropsMixin.MetricProperty