aws-cdk-lib.aws_iotsitewise.CfnAssetModelProps

interface CfnAssetModelProps

LanguageType name
.NETAmazon.CDK.AWS.IoTSiteWise.CfnAssetModelProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiotsitewise#CfnAssetModelProps
Javasoftware.amazon.awscdk.services.iotsitewise.CfnAssetModelProps
Pythonaws_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
    compositeModelProperties: [{
      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',
    }],
    description: 'description',
  }],
  assetModelDescription: 'assetModelDescription',
  assetModelHierarchies: [{
    childAssetModelId: 'childAssetModelId',
    logicalId: 'logicalId',
    name: 'name',
  }],
  assetModelProperties: [{
    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',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
assetModelNamestringA unique, friendly name for the asset model.
assetModelCompositeModels?IResolvable | IResolvable | AssetModelCompositeModelProperty[]The composite asset models that are part of this asset model.
assetModelDescription?stringA description for 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.
tags?CfnTag[]A list of key-value pairs that contain metadata for the asset.

assetModelName

Type: string

A unique, friendly name for the asset model.

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


assetModelCompositeModels?

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

The composite asset models that are part of this asset model.

Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. You can use composite asset models to define alarms on this asset model.


assetModelDescription?

Type: string (optional)

A description for the asset model.


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 Defining relationships between assets 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 Defining data 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 .


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 .