Interface CfnAssetModel.IVariableValueProperty
Identifies a property value used in an expression.
Namespace: Amazon.CDK.AWS.IoTSiteWise
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IVariableValueProperty
Syntax (vb)
Public Interface IVariableValueProperty
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 variableValueProperty = new VariableValueProperty {
HierarchyExternalId = "hierarchyExternalId",
HierarchyId = "hierarchyId",
HierarchyLogicalId = "hierarchyLogicalId",
PropertyExternalId = "propertyExternalId",
PropertyId = "propertyId",
PropertyLogicalId = "propertyLogicalId",
PropertyPath = new [] { new PropertyPathDefinitionProperty {
Name = "name"
} }
};
Synopsis
Properties
HierarchyExternalId | The external ID of the hierarchy being referenced. |
HierarchyId | The ID of the hierarchy to query for the property ID. |
HierarchyLogicalId | The |
PropertyExternalId | The external ID of the property being referenced. |
PropertyId | The ID of the property to use as the variable. |
PropertyLogicalId | The |
PropertyPath | The path of the property. |
Properties
HierarchyExternalId
The external ID of the hierarchy being referenced.
virtual string HierarchyExternalId { get; }
Property Value
System.String
Remarks
For more information, see Using external IDs in the AWS IoT SiteWise User Guide .
HierarchyId
The ID of the hierarchy to query for the property ID.
virtual string HierarchyId { get; }
Property Value
System.String
Remarks
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 .
HierarchyLogicalId
The LogicalID
of the hierarchy to query for the PropertyLogicalID
.
virtual string HierarchyLogicalId { get; }
Property Value
System.String
Remarks
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 .
PropertyExternalId
The external ID of the property being referenced.
virtual string PropertyExternalId { get; }
Property Value
System.String
Remarks
For more information, see Using external IDs in the AWS IoT SiteWise User Guide .
PropertyId
The ID of the property to use as the variable.
virtual string PropertyId { get; }
Property Value
System.String
Remarks
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 .
This is a return value and can't be set.
PropertyLogicalId
The LogicalID
of the property that is being referenced.
virtual string PropertyLogicalId { get; }
Property Value
System.String
Remarks
PropertyPath
The path of the property.
virtual object PropertyPath { get; }
Property Value
System.Object
Remarks
Each step of the path is the name of the step. See the following example:
PropertyPath: Name: AssetModelName Name: Composite1 Name: NestedComposite