Interface CfnAssetModel.IAssetModelHierarchyProperty
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.
Namespace: Amazon.CDK.AWS.IoTSiteWise
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IAssetModelHierarchyProperty
Syntax (vb)
Public Interface IAssetModelHierarchyProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTSiteWise;
var assetModelHierarchyProperty = new AssetModelHierarchyProperty {
ChildAssetModelId = "childAssetModelId",
Name = "name",
// the properties below are optional
ExternalId = "externalId",
Id = "id",
LogicalId = "logicalId"
};
Synopsis
Properties
ChildAssetModelId | The ID of the asset model, in UUID format. |
ExternalId | 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 | The ID of the asset model hierarchy. This ID is a |
LogicalId | The |
Name | The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation. |
Properties
ChildAssetModelId
The ID of the asset model, in UUID format.
string ChildAssetModelId { get; }
Property Value
System.String
Remarks
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 .
ExternalId
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 .
virtual string ExternalId { get; }
Property Value
System.String
Remarks
One of ExternalId
or LogicalId
must be specified.
Id
The ID of the asset model hierarchy. This ID is a hierarchyId
.
virtual string Id { get; }
Property Value
System.String
Remarks
This is a return value and can't be set.
LogicalId
The LogicalID
of the asset model hierarchy. This ID is a hierarchyLogicalId
.
virtual string LogicalId { get; }
Property Value
System.String
Remarks
One of ExternalId
or LogicalId
must be specified.
Name
The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
string Name { get; }
Property Value
System.String