interface PropertyTypeProperty

Language	Type name
.NET	Amazon.CDK.AWS.IoTSiteWise.CfnAssetModel.PropertyTypeProperty
Java	software.amazon.awscdk.services.iotsitewise.CfnAssetModel.PropertyTypeProperty
Python	aws_cdk.aws_iotsitewise.CfnAssetModel.PropertyTypeProperty
TypeScript	@aws-cdk/aws-iotsitewise » CfnAssetModel » PropertyTypeProperty

Contains a property type, which can be one of Attribute , Measurement , Metric , or Transform .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as iotsitewise from '@aws-cdk/aws-iotsitewise';
const propertyTypeProperty: iotsitewise.CfnAssetModel.PropertyTypeProperty = {
  typeName: 'typeName',

  // the properties below are optional
  attribute: {
    defaultValue: 'defaultValue',
  },
  metric: {
    expression: 'expression',
    variables: [{
      name: 'name',
      value: {
        propertyLogicalId: 'propertyLogicalId',

        // the properties below are optional
        hierarchyLogicalId: 'hierarchyLogicalId',
      },
    }],
    window: {
      tumbling: {
        interval: 'interval',

        // the properties below are optional
        offset: 'offset',
      },
    },
  },
  transform: {
    expression: 'expression',
    variables: [{
      name: 'name',
      value: {
        propertyLogicalId: 'propertyLogicalId',

        // the properties below are optional
        hierarchyLogicalId: 'hierarchyLogicalId',
      },
    }],
  },
};

Properties

Name	Type	Description
typeName	string	The type of property type, which can be one of Attribute , Measurement , Metric , or Transform .
attribute?	IResolvable | AttributeProperty	Specifies an asset attribute property.
metric?	IResolvable | MetricProperty	Specifies an asset metric property.
transform?	IResolvable | TransformProperty	Specifies an asset transform property.

---

typeName

Type: string

The type of property type, which can be one of Attribute , Measurement , Metric , or Transform .

---

attribute?

Type: IResolvable | AttributeProperty (optional)

Specifies an asset attribute property.

An attribute generally contains static information, such as the serial number of an industrial IoT wind turbine.

This is required if the TypeName is Attribute and has a DefaultValue .

---

metric?

Type: IResolvable | MetricProperty (optional)

Specifies an asset metric property.

A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.

This is required if the TypeName is Metric .

---

transform?

Type: IResolvable | TransformProperty (optional)

Specifies an asset transform property.

A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

This is required if the TypeName is Transform .