Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-iotsitewise-assetmodel.json
Parent schema serverless-framework-configuration
Type: object

Properties

AssetModelName string | Aws_CF_FunctionString required

A unique, friendly name for the asset model.

AssetModelDescription string | Aws_CF_FunctionString

A description for the asset model.

AssetModelProperties AssetModelProperty[]

The property definitions of the asset model. You can specify up to 200 properties per asset model.

AssetModelCompositeModels AssetModelCompositeModel[]

The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.

AssetModelHierarchies AssetModelHierarchy[]

The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. You can specify up to 10 hierarchies per asset model.

Tags Tag[]

A list of key-value pairs that contain metadata for the asset model.

Definitions

AssetModelCompositeModel object

Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.

Name string | Aws_CF_FunctionString required

A unique, friendly name for the asset composite model.

Type string | Aws_CF_FunctionString required

The type of the composite model. For alarm composite models, this type is AWS/ALARM

Description string | Aws_CF_FunctionString

A description for the asset composite model.

CompositeModelProperties AssetModelProperty[]

The property definitions of the asset model. You can specify up to 200 properties per asset model.

AssetModelProperty object

Contains information about an asset model property.

LogicalId string | Aws_CF_FunctionString required

Customer provided ID for property.

Name string | Aws_CF_FunctionString required

The name of the asset model property.

DataType string | Aws_CF_FunctionString required
Type object required

Contains a property type, which can be one of attribute, measurement, metric, or transform.

4 nested properties
TypeName string | Aws_CF_FunctionString required
Attribute object
1 nested properties
DefaultValue string | Aws_CF_FunctionString
Transform object
2 nested properties
Expression string | Aws_CF_FunctionString required

The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.

Variables ExpressionVariable[] required

The list of variables used in the expression.

Metric object
3 nested properties
Expression string | Aws_CF_FunctionString required

The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.

Variables ExpressionVariable[] required

The list of variables used in the expression.

Window object required

Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).

DataTypeSpec string | Aws_CF_FunctionString
Unit string | Aws_CF_FunctionString

The unit of the asset model property, such as Newtons or RPM.

DataType string | Aws_CF_FunctionString
DataTypeSpec string | Aws_CF_FunctionString
PropertyType object

Contains a property type, which can be one of attribute, measurement, metric, or transform.

TypeName string | Aws_CF_FunctionString required
Attribute object
1 nested properties
DefaultValue string | Aws_CF_FunctionString
Transform object
2 nested properties
Expression string | Aws_CF_FunctionString required

The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.

Variables ExpressionVariable[] required

The list of variables used in the expression.

Metric object
3 nested properties
Expression string | Aws_CF_FunctionString required

The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.

Variables ExpressionVariable[] required

The list of variables used in the expression.

Window object required

Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).

1 nested properties
Tumbling object

Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time interval. This window is used in metric and aggregation computations.

TypeName string | Aws_CF_FunctionString
Attribute object
DefaultValue string | Aws_CF_FunctionString
Transform object
Expression string | Aws_CF_FunctionString required

The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.

Variables ExpressionVariable[] required

The list of variables used in the expression.

Metric object
Expression string | Aws_CF_FunctionString required

The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.

Variables ExpressionVariable[] required

The list of variables used in the expression.

Window object required

Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).

1 nested properties
Tumbling object

Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time interval. This window is used in metric and aggregation computations.

2 nested properties
Interval string | Aws_CF_FunctionString required

The time interval for the tumbling window.

Offset string | Aws_CF_FunctionString

The shift or reference point on timeline for the contiguous time intervals.

MetricWindow object

Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).

Tumbling object

Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time interval. This window is used in metric and aggregation computations.

2 nested properties
Interval string | Aws_CF_FunctionString required

The time interval for the tumbling window.

Offset string | Aws_CF_FunctionString

The shift or reference point on timeline for the contiguous time intervals.

TumblingWindow object

Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time interval. This window is used in metric and aggregation computations.

Interval string | Aws_CF_FunctionString required

The time interval for the tumbling window.

Offset string | Aws_CF_FunctionString

The shift or reference point on timeline for the contiguous time intervals.

Interval string | Aws_CF_FunctionString

The time interval for the tumbling window.

Offset string | Aws_CF_FunctionString

The shift or reference point on timeline for the contiguous time intervals.

ExpressionVariable object
Name string | Aws_CF_FunctionString required

The friendly name of the variable to be used in the expression.

Value object required
2 nested properties
PropertyLogicalId string | Aws_CF_FunctionString required
HierarchyLogicalId string | Aws_CF_FunctionString
VariableValue object
PropertyLogicalId string | Aws_CF_FunctionString required
HierarchyLogicalId string | Aws_CF_FunctionString
AssetModelHierarchy object

Contains information about an asset model hierarchy.

LogicalId string | Aws_CF_FunctionString required

Customer provided ID for hierarchy.

Name string | Aws_CF_FunctionString required

The name of the asset model hierarchy.

ChildAssetModelId string | Aws_CF_FunctionString required

The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.

Tag object
Key string | Aws_CF_FunctionString required
Value string | Aws_CF_FunctionString required