aws-cdk-lib.aws_iotsitewise.CfnAssetModel.AssetModelPropertyProperty

interface AssetModelPropertyProperty

LanguageType name
.NETAmazon.CDK.AWS.IoTSiteWise.CfnAssetModel.AssetModelPropertyProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiotsitewise#CfnAssetModel_AssetModelPropertyProperty
Javasoftware.amazon.awscdk.services.iotsitewise.CfnAssetModel.AssetModelPropertyProperty
Pythonaws_cdk.aws_iotsitewise.CfnAssetModel.AssetModelPropertyProperty
TypeScript aws-cdk-lib » aws_iotsitewise » CfnAssetModel » AssetModelPropertyProperty

Contains information about an asset model property.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotsitewise as iotsitewise } from 'aws-cdk-lib';
const assetModelPropertyProperty: iotsitewise.CfnAssetModel.AssetModelPropertyProperty = {
  dataType: 'dataType',
  logicalId: 'logicalId',
  name: 'name',
  type: {
    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',
        },
      }],
    },
  },

  // the properties below are optional
  dataTypeSpec: 'dataTypeSpec',
  unit: 'unit',
};

Properties

NameTypeDescription
dataTypestringThe data type of the asset model property.
logicalIdstringThe LogicalID of the asset model property.
namestringThe name of the asset model property.
typeIResolvable | PropertyTypePropertyContains a property type, which can be one of Attribute , Measurement , Metric , or Transform .
dataTypeSpec?stringThe data type of the structure for this property.
unit?stringThe unit of the asset model property, such as Newtons or RPM .

dataType

Type: string

The data type of the asset model property.

The value can be STRING , INTEGER , DOUBLE , BOOLEAN , or STRUCT .


logicalId

Type: string

The LogicalID of the asset model property.

The maximum length is 256 characters, with the pattern [^\\ u0000-\\ u001F\\ u007F]+ .


name

Type: string

The name of the asset model property.

The maximum length is 256 characters with the pattern [^\ u0000-\ u001F\ u007F]+ .


type

Type: IResolvable | PropertyTypeProperty

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


dataTypeSpec?

Type: string (optional)

The data type of the structure for this property.

This parameter exists on properties that have the STRUCT data type.


unit?

Type: string (optional)

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