interface AssetModelPropertyProperty

Language	Type name
.NET	Amazon.CDK.AWS.IoTSiteWise.CfnAssetModel.AssetModelPropertyProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsiotsitewise#CfnAssetModel_AssetModelPropertyProperty
Java	software.amazon.awscdk.services.iotsitewise.CfnAssetModel.AssetModelPropertyProperty
Python	aws_cdk.aws_iotsitewise.CfnAssetModel.AssetModelPropertyProperty
TypeScript	aws-cdk-lib » aws_iotsitewise » CfnAssetModel » AssetModelPropertyProperty

Contains information about an asset model property.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html

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',
  name: 'name',
  type: {
    typeName: 'typeName',

    // the properties below are optional
    attribute: {
      defaultValue: 'defaultValue',
    },
    metric: {
      expression: 'expression',
      variables: [{
        name: 'name',
        value: {
          hierarchyExternalId: 'hierarchyExternalId',
          hierarchyId: 'hierarchyId',
          hierarchyLogicalId: 'hierarchyLogicalId',
          propertyExternalId: 'propertyExternalId',
          propertyId: 'propertyId',
          propertyLogicalId: 'propertyLogicalId',
          propertyPath: [{
            name: 'name',
          }],
        },
      }],
      window: {
        tumbling: {
          interval: 'interval',

          // the properties below are optional
          offset: 'offset',
        },
      },
    },
    transform: {
      expression: 'expression',
      variables: [{
        name: 'name',
        value: {
          hierarchyExternalId: 'hierarchyExternalId',
          hierarchyId: 'hierarchyId',
          hierarchyLogicalId: 'hierarchyLogicalId',
          propertyExternalId: 'propertyExternalId',
          propertyId: 'propertyId',
          propertyLogicalId: 'propertyLogicalId',
          propertyPath: [{
            name: 'name',
          }],
        },
      }],
    },
  },

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

Properties

Name	Type	Description
dataType	string	The data type of the asset model property.
name	string	The name of the asset model property.
type	IResolvable | PropertyTypeProperty	Contains a property type, which can be one of attribute , measurement , metric , or transform .
dataTypeSpec?	string	The data type of the structure for this property.
externalId?	string	The external ID of the asset property.
id?	string	The ID of the property.
logicalId?	string	The LogicalID of the asset model property.
unit?	string	The unit of the asset model property, such as Newtons or RPM .

---

dataType

Type: string

The data type of the asset model property.

If you specify STRUCT , you must also specify dataTypeSpec to identify the type of the structure for this property.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-datatype

---

name

Type: string

The name of the asset model property.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-name

---

type

Type: IResolvable | PropertyTypeProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-type

---

dataTypeSpec?

Type: string (optional)

The data type of the structure for this property.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-datatypespec

---

externalId?

Type: string (optional)

The external ID of the asset property.

For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

One of ExternalId or LogicalId must be specified.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-externalid

---

id?

Type: string (optional)

The ID of the property.

This is a return value and can't be set.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-id

---

logicalId?

Type: string (optional)

The LogicalID of the asset model property.

One of ExternalId or LogicalId must be specified.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-logicalid

---

unit?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-unit