interface CfnAssetModelProps

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

Properties for defining a CfnAssetModel.

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 cfnAssetModelProps: iotsitewise.CfnAssetModelProps = {
  assetModelName: 'assetModelName',

  // the properties below are optional
  assetModelCompositeModels: [{
    name: 'name',
    type: 'type',

    // the properties below are optional
    composedAssetModelId: 'composedAssetModelId',
    compositeModelProperties: [{
      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',
    }],
    description: 'description',
    externalId: 'externalId',
    id: 'id',
    parentAssetModelCompositeModelExternalId: 'parentAssetModelCompositeModelExternalId',
    path: ['path'],
  }],
  assetModelDescription: 'assetModelDescription',
  assetModelExternalId: 'assetModelExternalId',
  assetModelHierarchies: [{
    childAssetModelId: 'childAssetModelId',
    name: 'name',

    // the properties below are optional
    externalId: 'externalId',
    id: 'id',
    logicalId: 'logicalId',
  }],
  assetModelProperties: [{
    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',
  }],
  assetModelType: 'assetModelType',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
assetModelName	`string`	A unique name for the asset model.
assetModelCompositeModels?	`IResolvable` `\|` `IResolvable` `\|` `AssetModelCompositeModelProperty[]`	The composite models that are part of this asset model.
assetModelDescription?	`string`	A description for the asset model.
assetModelExternalId?	`string`	The external ID of the asset model.
assetModelHierarchies?	`IResolvable` `\|` `IResolvable` `\|` `AssetModelHierarchyProperty[]`	The hierarchy definitions of the asset model.
assetModelProperties?	`IResolvable` `\|` `IResolvable` `\|` `AssetModelPropertyProperty[]`	The property definitions of the asset model.
assetModelType?	`string`	The type of asset model.
tags?	`CfnTag[]`	A list of key-value pairs that contain metadata for the asset.

assetModelName

Type: string

A unique name for the asset model.

assetModelCompositeModels?

Type: IResolvable | IResolvable | AssetModelCompositeModelProperty[] (optional)

The composite models that are part of this asset model.

It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

When creating custom composite models, you need to use CreateAssetModelCompositeModel . For more information, see Creating custom composite models (Components) in the AWS IoT SiteWise User Guide .

assetModelDescription?

Type: string (optional)

A description for the asset model.

assetModelExternalId?

Type: string (optional)

The external ID of the asset model.

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

assetModelHierarchies?

Type: IResolvable | IResolvable | AssetModelHierarchyProperty[] (optional)

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. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .

You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide .

assetModelProperties?

Type: IResolvable | IResolvable | AssetModelPropertyProperty[] (optional)

The property definitions of the asset model.

For more information, see Asset properties in the AWS IoT SiteWise User Guide .

You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide .

assetModelType?

Type: string (optional)

The type of asset model.

ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

tags?

Type: CfnTag[] (optional)

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

For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .