Class CfnAssetModel.AssetModelCompositeModelProperty.Builder
java.lang.Object
software.amazon.awscdk.services.iotsitewise.CfnAssetModel.AssetModelCompositeModelProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAssetModel.AssetModelCompositeModelProperty>
- Enclosing interface:
CfnAssetModel.AssetModelCompositeModelProperty
@Stability(Stable)
public static final class CfnAssetModel.AssetModelCompositeModelProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAssetModel.AssetModelCompositeModelProperty>
A builder for
CfnAssetModel.AssetModelCompositeModelProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.composedAssetModelId
(String composedAssetModelId) Sets the value ofCfnAssetModel.AssetModelCompositeModelProperty.getComposedAssetModelId()
compositeModelProperties
(List<? extends Object> compositeModelProperties) compositeModelProperties
(IResolvable compositeModelProperties) description
(String description) Sets the value ofCfnAssetModel.AssetModelCompositeModelProperty.getDescription()
externalId
(String externalId) Sets the value ofCfnAssetModel.AssetModelCompositeModelProperty.getExternalId()
Sets the value ofCfnAssetModel.AssetModelCompositeModelProperty.getId()
Sets the value ofCfnAssetModel.AssetModelCompositeModelProperty.getName()
parentAssetModelCompositeModelExternalId
(String parentAssetModelCompositeModelExternalId) Sets the value ofCfnAssetModel.AssetModelCompositeModelProperty.getPath()
Sets the value ofCfnAssetModel.AssetModelCompositeModelProperty.getType()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
name
Sets the value ofCfnAssetModel.AssetModelCompositeModelProperty.getName()
- Parameters:
name
- The name of the composite model. This parameter is required.- Returns:
this
-
type
Sets the value ofCfnAssetModel.AssetModelCompositeModelProperty.getType()
- Parameters:
type
- The type of the composite model. This parameter is required. For alarm composite models, this type isAWS/ALARM
.- Returns:
this
-
composedAssetModelId
@Stability(Stable) public CfnAssetModel.AssetModelCompositeModelProperty.Builder composedAssetModelId(String composedAssetModelId) Sets the value ofCfnAssetModel.AssetModelCompositeModelProperty.getComposedAssetModelId()
- Parameters:
composedAssetModelId
- The ID of a component model which is reused to create this composite model.- Returns:
this
-
compositeModelProperties
@Stability(Stable) public CfnAssetModel.AssetModelCompositeModelProperty.Builder compositeModelProperties(IResolvable compositeModelProperties) - Parameters:
compositeModelProperties
- The asset property definitions for this composite model.- Returns:
this
-
compositeModelProperties
@Stability(Stable) public CfnAssetModel.AssetModelCompositeModelProperty.Builder compositeModelProperties(List<? extends Object> compositeModelProperties) - Parameters:
compositeModelProperties
- The asset property definitions for this composite model.- Returns:
this
-
description
@Stability(Stable) public CfnAssetModel.AssetModelCompositeModelProperty.Builder description(String description) Sets the value ofCfnAssetModel.AssetModelCompositeModelProperty.getDescription()
- Parameters:
description
- The description of the composite model.If the composite model is a
component-model-based
composite model, the description is inherited from theCOMPONENT_MODEL
asset model and cannot be changed.- Returns:
this
-
externalId
@Stability(Stable) public CfnAssetModel.AssetModelCompositeModelProperty.Builder externalId(String externalId) Sets the value ofCfnAssetModel.AssetModelCompositeModelProperty.getExternalId()
- Parameters:
externalId
- The external ID of a composite model on this asset model. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .One of
ExternalId
orPath
must be specified.- Returns:
this
-
id
Sets the value ofCfnAssetModel.AssetModelCompositeModelProperty.getId()
- Parameters:
id
- The ID of the asset model composite model.This is a return value and can't be set.
- Returns:
this
-
parentAssetModelCompositeModelExternalId
@Stability(Stable) public CfnAssetModel.AssetModelCompositeModelProperty.Builder parentAssetModelCompositeModelExternalId(String parentAssetModelCompositeModelExternalId) Sets the value ofCfnAssetModel.AssetModelCompositeModelProperty.getParentAssetModelCompositeModelExternalId()
- Parameters:
parentAssetModelCompositeModelExternalId
- The external ID of the parent composite model. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .- Returns:
this
-
path
@Stability(Stable) public CfnAssetModel.AssetModelCompositeModelProperty.Builder path(List<String> path) Sets the value ofCfnAssetModel.AssetModelCompositeModelProperty.getPath()
- Parameters:
path
- The structured path to the property from the root of the asset using property names. Path is used as the ID if the asset model is a derived composite model.One of
ExternalId
orPath
must be specified.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnAssetModel.AssetModelCompositeModelProperty>
- Returns:
- a new instance of
CfnAssetModel.AssetModelCompositeModelProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-