Package software.amazon.awscdk.services.iotsitewise

Class CfnAssetModelProps.Builder

java.lang.Object

software.amazon.awscdk.services.iotsitewise.CfnAssetModelProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAssetModelProps>

Enclosing interface:

CfnAssetModelProps

@Stability(Stable)
public static final class CfnAssetModelProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAssetModelProps>

A builder for CfnAssetModelProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAssetModelProps.Builder	assetModelCompositeModels(List<? extends Object> assetModelCompositeModels)	Sets the value of CfnAssetModelProps.getAssetModelCompositeModels()
CfnAssetModelProps.Builder	assetModelCompositeModels(IResolvable assetModelCompositeModels)	Sets the value of CfnAssetModelProps.getAssetModelCompositeModels()
CfnAssetModelProps.Builder	assetModelDescription(String assetModelDescription)	Sets the value of CfnAssetModelProps.getAssetModelDescription()
CfnAssetModelProps.Builder	assetModelExternalId(String assetModelExternalId)	Sets the value of CfnAssetModelProps.getAssetModelExternalId()
CfnAssetModelProps.Builder	assetModelHierarchies(List<? extends Object> assetModelHierarchies)	Sets the value of CfnAssetModelProps.getAssetModelHierarchies()
CfnAssetModelProps.Builder	assetModelHierarchies(IResolvable assetModelHierarchies)	Sets the value of CfnAssetModelProps.getAssetModelHierarchies()
CfnAssetModelProps.Builder	assetModelName(String assetModelName)	Sets the value of CfnAssetModelProps.getAssetModelName()
CfnAssetModelProps.Builder	assetModelProperties(List<? extends Object> assetModelProperties)	Sets the value of CfnAssetModelProps.getAssetModelProperties()
CfnAssetModelProps.Builder	assetModelProperties(IResolvable assetModelProperties)	Sets the value of CfnAssetModelProps.getAssetModelProperties()
CfnAssetModelProps.Builder	assetModelType(String assetModelType)	Sets the value of CfnAssetModelProps.getAssetModelType()
CfnAssetModelProps	build()	Builds the configured instance.
CfnAssetModelProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnAssetModelProps.getTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

assetModelName

@Stability(Stable)
public CfnAssetModelProps.Builder assetModelName(String assetModelName)

Sets the value of CfnAssetModelProps.getAssetModelName()

Parameters:

assetModelName - A unique, friendly name for the asset model. This parameter is required.

Returns:

this

assetModelCompositeModels

@Stability(Stable)
public CfnAssetModelProps.Builder assetModelCompositeModels(IResolvable assetModelCompositeModels)

Sets the value of CfnAssetModelProps.getAssetModelCompositeModels()

Parameters:

assetModelCompositeModels - The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

When creating custom composite models, you need to use CreateAssetModelCompositeModel . For more information, see Creating custom composite models (Components) in the AWS IoT SiteWise User Guide .

Returns:

this

assetModelCompositeModels

@Stability(Stable)
public CfnAssetModelProps.Builder assetModelCompositeModels(List<? extends Object> assetModelCompositeModels)

Sets the value of CfnAssetModelProps.getAssetModelCompositeModels()

Parameters:

assetModelCompositeModels - The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

When creating custom composite models, you need to use CreateAssetModelCompositeModel . For more information, see Creating custom composite models (Components) in the AWS IoT SiteWise User Guide .

Returns:

this

assetModelDescription

@Stability(Stable)
public CfnAssetModelProps.Builder assetModelDescription(String assetModelDescription)

Sets the value of CfnAssetModelProps.getAssetModelDescription()

Parameters:

assetModelDescription - A description for the asset model.

Returns:

this

assetModelExternalId

@Stability(Stable)
public CfnAssetModelProps.Builder assetModelExternalId(String assetModelExternalId)

Sets the value of CfnAssetModelProps.getAssetModelExternalId()

Parameters:

assetModelExternalId - The external ID of the asset model. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

Returns:

this

assetModelHierarchies

@Stability(Stable)
public CfnAssetModelProps.Builder assetModelHierarchies(IResolvable assetModelHierarchies)

Sets the value of CfnAssetModelProps.getAssetModelHierarchies()

Parameters:

assetModelHierarchies - The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .

You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide .

Returns:

this

assetModelHierarchies

@Stability(Stable)
public CfnAssetModelProps.Builder assetModelHierarchies(List<? extends Object> assetModelHierarchies)

Sets the value of CfnAssetModelProps.getAssetModelHierarchies()

Parameters:

assetModelHierarchies - The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .

You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide .

Returns:

this

assetModelProperties

@Stability(Stable)
public CfnAssetModelProps.Builder assetModelProperties(IResolvable assetModelProperties)

Sets the value of CfnAssetModelProps.getAssetModelProperties()

Parameters:

assetModelProperties - The property definitions of the asset model. For more information, see Asset properties in the AWS IoT SiteWise User Guide .

You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide .

Returns:

this

assetModelProperties

@Stability(Stable)
public CfnAssetModelProps.Builder assetModelProperties(List<? extends Object> assetModelProperties)

Sets the value of CfnAssetModelProps.getAssetModelProperties()

Parameters:

assetModelProperties - The property definitions of the asset model. For more information, see Asset properties in the AWS IoT SiteWise User Guide .

You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide .

Returns:

this

assetModelType

@Stability(Stable)
public CfnAssetModelProps.Builder assetModelType(String assetModelType)

Sets the value of CfnAssetModelProps.getAssetModelType()

Parameters:

assetModelType - The type of asset model.

• ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
• COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

Returns:

this

tags

@Stability(Stable)
public CfnAssetModelProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnAssetModelProps.getTags()

Parameters:

tags - A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .

Returns:

this

build

@Stability(Stable)
public CfnAssetModelProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnAssetModelProps>

Returns:

a new instance of CfnAssetModelProps

Throws:

NullPointerException - if any required attribute was not provided