interface AssetModelCompositeModelProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.IoTSiteWise.CfnAssetModel.AssetModelCompositeModelProperty |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsiotsitewise#CfnAssetModel_AssetModelCompositeModelProperty |
Java | software.amazon.awscdk.services.iotsitewise.CfnAssetModel.AssetModelCompositeModelProperty |
Python | aws_cdk.aws_iotsitewise.CfnAssetModel.AssetModelCompositeModelProperty |
TypeScript | aws-cdk-lib » aws_iotsitewise » CfnAssetModel » 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.
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 assetModelCompositeModelProperty: iotsitewise.CfnAssetModel.AssetModelCompositeModelProperty = {
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'],
};
Properties
Name | Type | Description |
---|---|---|
name | string | The name of the composite model. |
type | string | The type of the composite model. |
composed | string | The component model ID for which the composite model is composed of. |
composite | IResolvable | IResolvable | Asset [] | The asset property definitions for this composite model. |
description? | string | The description of the composite model. |
external | string | The External ID of the composite model. |
id? | string | The Actual ID of the composite model. |
parent | string | The parent composite model External ID. |
path? | string[] | The path of the composite model. |
name
Type:
string
The name of the composite model.
type
Type:
string
The type of the composite model.
For alarm composite models, this type is AWS/ALARM
.
composedAssetModelId?
Type:
string
(optional)
The component model ID for which the composite model is composed of.
compositeModelProperties?
Type:
IResolvable
|
IResolvable
|
Asset
[]
(optional)
The asset property definitions for this composite model.
description?
Type:
string
(optional)
The description of the composite model.
externalId?
Type:
string
(optional)
The External ID of the composite model.
id?
Type:
string
(optional)
The Actual ID of the composite model.
parentAssetModelCompositeModelExternalId?
Type:
string
(optional)
The parent composite model External ID.
path?
Type:
string[]
(optional)
The path of the composite model.
This is only for derived composite models