AWS::IoTSiteWise::AssetModel AssetModelHierarchy - AWS CloudFormation
SyntaxProperties

AWS::IoTSiteWise::AssetModel AssetModelHierarchy

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "ChildAssetModelId" : String,
  "ExternalId" : String,
  "Id" : String,
  "LogicalId" : String,
  "Name" : String
}

YAML

  ChildAssetModelId: String
  ExternalId: String
  Id: String
  LogicalId: String
  Name: String

Properties

ChildAssetModelId

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.

Required: Yes

Type: String

Update requires: No interruption

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.

Note

One of ExternalId or LogicalId must be specified.

Required: No

Type: String

Pattern: [a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+

Minimum: 2

Maximum: 128

Update requires: No interruption

Id

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

Note

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.

Required: No

Type: String

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Minimum: 36

Maximum: 36

Update requires: No interruption

LogicalId

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

Note

One of ExternalId or LogicalId must be specified.

Required: No

Type: String

Pattern: [^\u0000-\u001F\u007F]+

Minimum: 1

Maximum: 256

Update requires: No interruption

Name

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

Required: Yes

Type: String

Update requires: No interruption