AWS::IoTSiteWise::AssetModel VariableValue

Identifies a property value used in an expression.

Syntax

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

JSON

{
  "HierarchyExternalId" : String,
  "HierarchyId" : String,
  "HierarchyLogicalId" : String,
  "PropertyExternalId" : String,
  "PropertyId" : String,
  "PropertyLogicalId" : String,
  "PropertyPath" : [ PropertyPathDefinition, ... ]
}

YAML

  HierarchyExternalId: String
  HierarchyId: String
  HierarchyLogicalId: String
  PropertyExternalId: String
  PropertyId: String
  PropertyLogicalId: String
  PropertyPath: 
    - PropertyPathDefinition

Properties

HierarchyExternalId

The external ID of the hierarchy being referenced. For more information, see Using external IDs in the AWS 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

HierarchyId

The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the AWS IoT SiteWise User Guide.

You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies 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

HierarchyLogicalId

The LogicalID of the hierarchy to query for the PropertyLogicalID.

You use a hierarchyLogicalID instead of a model ID because you can have several hierarchies using the same model and therefore the same property. For example, you might have separately grouped assets that come from the same asset model. For more information, see Defining relationships between asset models (hierarchies) in the AWS IoT SiteWise User Guide.

Required: No

Type: String

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

Minimum: 1

Maximum: 256

Update requires: No interruption

PropertyExternalId

The external ID of the property being referenced. For more information, see Using external IDs in the AWS 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

PropertyId

The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the AWS IoT SiteWise User Guide.

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

PropertyLogicalId

The LogicalID of the property that is being referenced.

Required: No

Type: String

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

Minimum: 1

Maximum: 256

Update requires: No interruption

PropertyPath

The path of the property. Each step of the path is the name of the step. See the following example:

PropertyPath:
  Name: AssetModelName
  Name: Composite1
  Name: NestedComposite

Required: No

Type: Array of PropertyPathDefinition

Update requires: No interruption