Package software.amazon.awscdk.services.iotsitewise

Class CfnAssetModel.Builder

java.lang.Object

software.amazon.awscdk.services.iotsitewise.CfnAssetModel.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAssetModel>

Enclosing class:

CfnAssetModel

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

A fluent builder for CfnAssetModel.

Method Summary

Modifier and Type	Method	Description
CfnAssetModel.Builder	assetModelCompositeModels(List<? extends Object> assetModelCompositeModels)	The composite models that are part of this asset model.
CfnAssetModel.Builder	assetModelCompositeModels(IResolvable assetModelCompositeModels)	The composite models that are part of this asset model.
CfnAssetModel.Builder	assetModelDescription(String assetModelDescription)	A description for the asset model.
CfnAssetModel.Builder	assetModelExternalId(String assetModelExternalId)	The external ID of the asset model.
CfnAssetModel.Builder	assetModelHierarchies(List<? extends Object> assetModelHierarchies)	The hierarchy definitions of the asset model.
CfnAssetModel.Builder	assetModelHierarchies(IResolvable assetModelHierarchies)	The hierarchy definitions of the asset model.
CfnAssetModel.Builder	assetModelName(String assetModelName)	A unique name for the asset model.
CfnAssetModel.Builder	assetModelProperties(List<? extends Object> assetModelProperties)	The property definitions of the asset model.
CfnAssetModel.Builder	assetModelProperties(IResolvable assetModelProperties)	The property definitions of the asset model.
CfnAssetModel.Builder	assetModelType(String assetModelType)	The type of asset model.
CfnAssetModel	build()
static CfnAssetModel.Builder	create(software.constructs.Construct scope, String id)
CfnAssetModel.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs that contain metadata for the asset.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnAssetModel.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnAssetModel.Builder.

assetModelName

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

A unique name for the asset model.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelname

assetModelCompositeModels

@Stability(Stable)
public CfnAssetModel.Builder assetModelCompositeModels(IResolvable 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 .

Parameters:

assetModelCompositeModels - The composite models that are part of this asset model. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodels

assetModelCompositeModels

@Stability(Stable)
public CfnAssetModel.Builder assetModelCompositeModels(List<? extends Object> 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 .

Parameters:

assetModelCompositeModels - The composite models that are part of this asset model. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodels

assetModelDescription

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

A description for the asset model.

Parameters:

assetModelDescription - A description for the asset model. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodeldescription

assetModelExternalId

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

The external ID of the asset model.

For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

Parameters:

assetModelExternalId - The external ID of the asset model. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelexternalid

assetModelHierarchies

@Stability(Stable)
public CfnAssetModel.Builder assetModelHierarchies(IResolvable 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 .

Parameters:

assetModelHierarchies - The hierarchy definitions of the asset model. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelhierarchies

assetModelHierarchies

@Stability(Stable)
public CfnAssetModel.Builder assetModelHierarchies(List<? extends Object> 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 .

Parameters:

assetModelHierarchies - The hierarchy definitions of the asset model. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelhierarchies

assetModelProperties

@Stability(Stable)
public CfnAssetModel.Builder assetModelProperties(IResolvable 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 .

Parameters:

assetModelProperties - The property definitions of the asset model. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelproperties

assetModelProperties

@Stability(Stable)
public CfnAssetModel.Builder assetModelProperties(List<? extends Object> 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 .

Parameters:

assetModelProperties - The property definitions of the asset model. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelproperties

assetModelType

@Stability(Stable)
public CfnAssetModel.Builder assetModelType(String 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.

Parameters:

assetModelType - The type of asset model. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodeltype

tags

@Stability(Stable)
public CfnAssetModel.Builder tags(List<? extends CfnTag> 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 .

Parameters:

tags - A list of key-value pairs that contain metadata for the asset. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-tags

build

@Stability(Stable)
public CfnAssetModel build()

Specified by:

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

Returns:

a newly built instance of CfnAssetModel.