interface AssetModelCompositeModelProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.IoTSiteWise.Mixins.CfnAssetModelPropsMixin.AssetModelCompositeModelProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiotsitewise/mixins#CfnAssetModelPropsMixin_AssetModelCompositeModelProperty
Java	software.amazon.awscdk.mixins.preview.services.iotsitewise.mixins.CfnAssetModelPropsMixin.AssetModelCompositeModelProperty
Python	aws_cdk.mixins_preview.aws_iotsitewise.mixins.CfnAssetModelPropsMixin.AssetModelCompositeModelProperty
TypeScript	@aws-cdk/mixins-preview » aws_iotsitewise » mixins » CfnAssetModelPropsMixin » AssetModelCompositeModelProperty

Contains information about a composite model in an asset model.

This object contains the asset property definitions that you define in the composite model.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.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 assetModelCompositeModelProperty: iotsitewise_mixins.CfnAssetModelPropsMixin.AssetModelCompositeModelProperty = {
  composedAssetModelId: 'composedAssetModelId',
  compositeModelProperties: [{
    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',
  }],
  description: 'description',
  externalId: 'externalId',
  id: 'id',
  name: 'name',
  parentAssetModelCompositeModelExternalId: 'parentAssetModelCompositeModelExternalId',
  path: ['path'],
  type: 'type',
};

Properties

Name	Type	Description
composedAssetModelId?	string	The ID of a component model which is reused to create this composite model.
compositeModelProperties?	IResolvable | (IResolvable | AssetModelPropertyProperty)[]	The asset property definitions for this composite model.
description?	string	The description of the composite model.
externalId?	string	The external ID of a composite model on this asset model.
id?	string	The ID of the asset model composite model.
name?	string	The name of the composite model.
parentAssetModelCompositeModelExternalId?	string	The external ID of the parent composite model.
path?	string[]	The structured path to the property from the root of the asset using property names.
type?	string	The type of the composite model.

---

composedAssetModelId?

Type: string (optional)

The ID of a component model which is reused to create this composite model.

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

---

compositeModelProperties?

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

The asset property definitions for this composite model.

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

---

description?

Type: string (optional)

The description of the composite model.

If the composite model is a component-model-based composite model, the description is inherited from the COMPONENT_MODEL asset model and cannot be changed.

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

---

externalId?

Type: string (optional)

The external ID of a composite model on this asset model.

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

One of ExternalId or Path must be specified.

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

---

id?

Type: string (optional)

The ID of the asset model composite model.

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

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

---

name?

Type: string (optional)

The name of the composite model.

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

---

parentAssetModelCompositeModelExternalId?

Type: string (optional)

The external ID of the parent composite model.

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

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

---

path?

Type: string[] (optional)

The structured path to the property from the root of the asset using property names.

Path is used as the ID if the asset model is a derived composite model.

One of ExternalId or Path must be specified.

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

---

type?

Type: string (optional)

The type of the composite model.

For alarm composite models, this type is AWS/ALARM .

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