AWS::IoTSiteWise::Asset AssetHierarchy - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::IoTSiteWise::Asset AssetHierarchy

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

Syntax

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

JSON

{
  "ChildAssetId" : String,
  "ExternalId" : String,
  "Id" : String,
  "LogicalId" : String
}

YAML

  ChildAssetId: String
  ExternalId: String
  Id: String
  LogicalId: String

Properties

ChildAssetId

The Id of the child asset.

Required: Yes

Type: String

Update requires: No interruption

ExternalId

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 Amazon IoT SiteWise User Guide.

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 hierarchy. This ID is a hierarchyId.

Note

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

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 ID of the hierarchy. This ID is a hierarchyId.

Required: No

Type: String

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

Minimum: 1

Maximum: 256

Update requires: No interruption