Interface CfnAssetModel.VariableValueProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAssetModel.VariableValueProperty.Jsii$Proxy
- Enclosing class:
CfnAssetModel
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.iotsitewise.*; VariableValueProperty variableValueProperty = VariableValueProperty.builder() .hierarchyExternalId("hierarchyExternalId") .hierarchyId("hierarchyId") .hierarchyLogicalId("hierarchyLogicalId") .propertyExternalId("propertyExternalId") .propertyId("propertyId") .propertyLogicalId("propertyLogicalId") .propertyPath(List.of(PropertyPathDefinitionProperty.builder() .name("name") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnAssetModel.VariableValueProperty
static final class
An implementation forCfnAssetModel.VariableValueProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
The external ID of the hierarchy being referenced.default String
The ID of the hierarchy to query for the property ID.default String
TheLogicalID
of the hierarchy to query for thePropertyLogicalID
.default String
The external ID of the property being referenced.default String
The ID of the property to use as the variable.default String
TheLogicalID
of the property that is being referenced.default Object
The path of the property.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getHierarchyExternalId
The external ID of the hierarchy being referenced.For more information, see Using external IDs in the AWS IoT SiteWise User Guide .
- See Also:
-
getHierarchyId
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 .- See Also:
-
getHierarchyLogicalId
TheLogicalID
of the hierarchy to query for thePropertyLogicalID
.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 .- See Also:
-
getPropertyExternalId
The external ID of the property being referenced.For more information, see Using external IDs in the AWS IoT SiteWise User Guide .
- See Also:
-
getPropertyId
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 specifyexternalId:
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.
- See Also:
-
getPropertyLogicalId
TheLogicalID
of the property that is being referenced.- See Also:
-
getPropertyPath
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
- See Also:
-
builder
-