Class CfnAssetModelPropsMixin.VariableValueProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.iotsitewise.CfnAssetModelPropsMixin.VariableValueProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAssetModelPropsMixin.VariableValueProperty>
- Enclosing interface:
CfnAssetModelPropsMixin.VariableValueProperty
@Stability(Stable)
public static final class CfnAssetModelPropsMixin.VariableValueProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAssetModelPropsMixin.VariableValueProperty>
A builder for
CfnAssetModelPropsMixin.VariableValueProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.hierarchyExternalId(String hierarchyExternalId) Sets the value ofCfnAssetModelPropsMixin.VariableValueProperty.getHierarchyExternalId()hierarchyId(String hierarchyId) Sets the value ofCfnAssetModelPropsMixin.VariableValueProperty.getHierarchyId()hierarchyLogicalId(String hierarchyLogicalId) Sets the value ofCfnAssetModelPropsMixin.VariableValueProperty.getHierarchyLogicalId()propertyExternalId(String propertyExternalId) Sets the value ofCfnAssetModelPropsMixin.VariableValueProperty.getPropertyExternalId()propertyId(String propertyId) Sets the value ofCfnAssetModelPropsMixin.VariableValueProperty.getPropertyId()propertyLogicalId(String propertyLogicalId) Sets the value ofCfnAssetModelPropsMixin.VariableValueProperty.getPropertyLogicalId()propertyPath(List<? extends Object> propertyPath) Sets the value ofCfnAssetModelPropsMixin.VariableValueProperty.getPropertyPath()propertyPath(IResolvable propertyPath) Sets the value ofCfnAssetModelPropsMixin.VariableValueProperty.getPropertyPath()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
hierarchyExternalId
@Stability(Stable) public CfnAssetModelPropsMixin.VariableValueProperty.Builder hierarchyExternalId(String hierarchyExternalId) Sets the value ofCfnAssetModelPropsMixin.VariableValueProperty.getHierarchyExternalId()- Parameters:
hierarchyExternalId- The external ID of the hierarchy being referenced. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .- Returns:
this
-
hierarchyId
@Stability(Stable) public CfnAssetModelPropsMixin.VariableValueProperty.Builder hierarchyId(String hierarchyId) Sets the value ofCfnAssetModelPropsMixin.VariableValueProperty.getHierarchyId()- Parameters:
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 specifyexternalId: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 .- Returns:
this
-
hierarchyLogicalId
@Stability(Stable) public CfnAssetModelPropsMixin.VariableValueProperty.Builder hierarchyLogicalId(String hierarchyLogicalId) Sets the value ofCfnAssetModelPropsMixin.VariableValueProperty.getHierarchyLogicalId()- Parameters:
hierarchyLogicalId- TheLogicalIDof the hierarchy to query for thePropertyLogicalID. You use ahierarchyLogicalIDinstead 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 .- Returns:
this
-
propertyExternalId
@Stability(Stable) public CfnAssetModelPropsMixin.VariableValueProperty.Builder propertyExternalId(String propertyExternalId) Sets the value ofCfnAssetModelPropsMixin.VariableValueProperty.getPropertyExternalId()- Parameters:
propertyExternalId- The external ID of the property being referenced. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .- Returns:
this
-
propertyId
@Stability(Stable) public CfnAssetModelPropsMixin.VariableValueProperty.Builder propertyId(String propertyId) Sets the value ofCfnAssetModelPropsMixin.VariableValueProperty.getPropertyId()- Parameters:
propertyId- The ID of the property to use as the variable. You can use the propertynameif 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.
- Returns:
this
-
propertyLogicalId
@Stability(Stable) public CfnAssetModelPropsMixin.VariableValueProperty.Builder propertyLogicalId(String propertyLogicalId) Sets the value ofCfnAssetModelPropsMixin.VariableValueProperty.getPropertyLogicalId()- Parameters:
propertyLogicalId- TheLogicalIDof the property that is being referenced.- Returns:
this
-
propertyPath
@Stability(Stable) public CfnAssetModelPropsMixin.VariableValueProperty.Builder propertyPath(IResolvable propertyPath) Sets the value ofCfnAssetModelPropsMixin.VariableValueProperty.getPropertyPath()- Parameters:
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- Returns:
this
-
propertyPath
@Stability(Stable) public CfnAssetModelPropsMixin.VariableValueProperty.Builder propertyPath(List<? extends Object> propertyPath) Sets the value ofCfnAssetModelPropsMixin.VariableValueProperty.getPropertyPath()- Parameters:
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- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnAssetModelPropsMixin.VariableValueProperty>- Returns:
- a new instance of
CfnAssetModelPropsMixin.VariableValueProperty - Throws:
NullPointerException- if any required attribute was not provided
-