interface AssetModelPropertyProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.IoTSiteWise.Mixins.CfnAssetModelPropsMixin.AssetModelPropertyProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiotsitewise/mixins#CfnAssetModelPropsMixin_AssetModelPropertyProperty
Java	software.amazon.awscdk.mixins.preview.services.iotsitewise.mixins.CfnAssetModelPropsMixin.AssetModelPropertyProperty
Python	aws_cdk.mixins_preview.aws_iotsitewise.mixins.CfnAssetModelPropsMixin.AssetModelPropertyProperty
TypeScript	@aws-cdk/mixins-preview » aws_iotsitewise » mixins » CfnAssetModelPropsMixin » 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 { mixins as iotsitewise_mixins } from '@aws-cdk/mixins-preview/aws-iotsitewise';
const assetModelPropertyProperty: iotsitewise_mixins.CfnAssetModelPropsMixin.AssetModelPropertyProperty = {
  dataType: 'dataType',
  dataTypeSpec: 'dataTypeSpec',
  externalId: 'externalId',
  id: 'id',
  logicalId: 'logicalId',
  name: 'name',
  type: {
    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',
          offset: 'offset',
        },
      },
    },
    transform: {
      expression: 'expression',
      variables: [{
        name: 'name',
        value: {
          hierarchyExternalId: 'hierarchyExternalId',
          hierarchyId: 'hierarchyId',
          hierarchyLogicalId: 'hierarchyLogicalId',
          propertyExternalId: 'propertyExternalId',
          propertyId: 'propertyId',
          propertyLogicalId: 'propertyLogicalId',
          propertyPath: [{
            name: 'name',
          }],
        },
      }],
    },
    typeName: 'typeName',
  },
  unit: 'unit',
};

Properties

Name	Type	Description
dataType?	string	The data type of the asset model property.
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.
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 .
unit?	string	The unit of the asset model property, such as Newtons or RPM .

---

dataType?

Type: string (optional)

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

---

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

---

name?

Type: string (optional)

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 (optional)

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

---

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