interface AssetHierarchyProperty

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

Describes an asset hierarchy that contains a hierarchy's name and ID.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html

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 assetHierarchyProperty: iotsitewise.CfnAsset.AssetHierarchyProperty = {
  childAssetId: 'childAssetId',

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

Properties

Name	Type	Description
childAssetId	`string`	The Id of the child asset.
externalId?	`string`	The external ID of the hierarchy, if it has one.
id?	`string`	The ID of the hierarchy. This ID is a `hierarchyId` .
logicalId?	`string`	The ID of the hierarchy.

childAssetId

Type: string

The Id of the child asset.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-childassetid

externalId?

Type: string (optional)

The external ID of the hierarchy, if it has one.

When you update an asset hierarchy, you may assign an external ID if it doesn't already have one. You can't change the external ID of an asset hierarchy that already has one. 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-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-externalid

id?

Type: string (optional)

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

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

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

logicalId?

Type: string (optional)

The ID of the hierarchy.

This ID is a hierarchyId .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-logicalid