Package software.amazon.awscdk.services.iotsitewise

Interface CfnAssetModel.VariableValueProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAssetModel.VariableValueProperty.Jsii$Proxy

Enclosing class:

CfnAssetModel

@Stability(Stable)
public static interface CfnAssetModel.VariableValueProperty
extends software.amazon.jsii.JsiiSerializable

Identifies a property value used in an expression.

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAssetModel.VariableValueProperty.Builder	A builder for CfnAssetModel.VariableValueProperty
static final class	CfnAssetModel.VariableValueProperty.Jsii$Proxy	An implementation for CfnAssetModel.VariableValueProperty

Method Summary

Modifier and Type	Method	Description
static CfnAssetModel.VariableValueProperty.Builder	builder()
default String	getHierarchyExternalId()	The external ID of the hierarchy being referenced.
default String	getHierarchyId()	The ID of the hierarchy to query for the property ID.
default String	getHierarchyLogicalId()	The LogicalID of the hierarchy to query for the PropertyLogicalID .
default String	getPropertyExternalId()	The external ID of the property being referenced.
default String	getPropertyId()	The ID of the property to use as the variable.
default String	getPropertyLogicalId()	The LogicalID of the property that is being referenced.
default Object	getPropertyPath()	The path of the property.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHierarchyExternalId

@Stability(Stable)
@Nullable
default String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-hierarchyexternalid

getHierarchyId

@Stability(Stable)
@Nullable
default String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-hierarchyid

getHierarchyLogicalId

@Stability(Stable)
@Nullable
default String getHierarchyLogicalId()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-hierarchylogicalid

getPropertyExternalId

@Stability(Stable)
@Nullable
default String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertyexternalid

getPropertyId

@Stability(Stable)
@Nullable
default String 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 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertyid

getPropertyLogicalId

@Stability(Stable)
@Nullable
default String getPropertyLogicalId()

The LogicalID of the property that is being referenced.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertylogicalid

getPropertyPath

@Stability(Stable)
@Nullable
default Object 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertypath

builder

@Stability(Stable)
static CfnAssetModel.VariableValueProperty.Builder builder()

Returns:

a CfnAssetModel.VariableValueProperty.Builder of CfnAssetModel.VariableValueProperty