interface AssetModelHierarchyProperty

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

Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.

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 assetModelHierarchyProperty: iotsitewise.CfnAssetModel.AssetModelHierarchyProperty = {
  childAssetModelId: 'childAssetModelId',
  name: 'name',

  // the properties below are optional
  externalId: 'externalId',
  id: 'id',
  logicalId: 'logicalId',
};

Properties

Name	Type	Description
childAssetModelId	`string`	The ID of the asset model, in UUID format.
name	`string`	The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
externalId?	`string`	The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel . However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .
id?	`string`	The ID of the asset model hierarchy. This ID is a `hierarchyId` .
logicalId?	`string`	The `LogicalID` of the asset model hierarchy. This ID is a `hierarchyLogicalId` .

childAssetModelId

Type: string

The ID of the asset model, in UUID format.

All assets in this hierarchy must be instances of the childAssetModelId asset model. AWS IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to UpdateAssetModel , you may provide either the asset model ID or else externalId: followed by the asset model's external ID. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

name

Type: string

The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.

externalId?

Type: string (optional)

The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel . However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

One of ExternalId or LogicalId must be specified.

id?

Type: string (optional)

The ID of the asset model hierarchy. This ID is a hierarchyId .

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

If you are callling UpdateAssetModel to create a new hierarchy: You can specify its ID here, if desired. AWS IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
If you are calling UpdateAssetModel to modify an existing hierarchy: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the AWS IoT SiteWise User Guide .

logicalId?

Type: string (optional)

The LogicalID of the asset model hierarchy. This ID is a hierarchyLogicalId .

One of ExternalId or LogicalId must be specified.