Package software.amazon.awscdk.services.iotsitewise

Class CfnAsset.Builder

java.lang.Object

software.amazon.awscdk.services.iotsitewise.CfnAsset.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAsset>

Enclosing class:

CfnAsset

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

A fluent builder for CfnAsset.

Method Summary

Modifier and Type	Method	Description
CfnAsset.Builder	assetDescription(String assetDescription)	The ID of the asset, in UUID format.
CfnAsset.Builder	assetExternalId(String assetExternalId)	The external ID of the asset model composite model.
CfnAsset.Builder	assetHierarchies(List<? extends Object> assetHierarchies)	A list of asset hierarchies that each contain a hierarchyId .
CfnAsset.Builder	assetHierarchies(IResolvable assetHierarchies)	A list of asset hierarchies that each contain a hierarchyId .
CfnAsset.Builder	assetModelId(String assetModelId)	The ID of the asset model from which to create the asset.
CfnAsset.Builder	assetModelId(IAssetModelRef assetModelId)	The ID of the asset model from which to create the asset.
CfnAsset.Builder	assetName(String assetName)	A friendly name for the asset.
CfnAsset.Builder	assetProperties(List<? extends Object> assetProperties)	The list of asset properties for the asset.
CfnAsset.Builder	assetProperties(IResolvable assetProperties)	The list of asset properties for the asset.
CfnAsset	build()
static CfnAsset.Builder	create(software.constructs.Construct scope, String id)
CfnAsset.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 CfnAsset.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 CfnAsset.Builder.

assetModelId

@Stability(Stable)
public CfnAsset.Builder assetModelId(String assetModelId)

The ID of the asset model from which to create the asset.

This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the AWS IoT SiteWise User Guide .

Parameters:

assetModelId - The ID of the asset model from which to create the asset. This parameter is required.

Returns:

this

See Also:

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

assetModelId

@Stability(Stable)
public CfnAsset.Builder assetModelId(IAssetModelRef assetModelId)

The ID of the asset model from which to create the asset.

This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the AWS IoT SiteWise User Guide .

Parameters:

assetModelId - The ID of the asset model from which to create the asset. This parameter is required.

Returns:

this

See Also:

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

assetName

@Stability(Stable)
public CfnAsset.Builder assetName(String assetName)

A friendly name for the asset.

Parameters:

assetName - A friendly name for the asset. This parameter is required.

Returns:

this

See Also:

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

assetDescription

@Stability(Stable)
public CfnAsset.Builder assetDescription(String assetDescription)

The ID of the asset, in UUID format.

Parameters:

assetDescription - The ID of the asset, in UUID format. This parameter is required.

Returns:

this

See Also:

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

assetExternalId

@Stability(Stable)
public CfnAsset.Builder assetExternalId(String assetExternalId)

The external ID of the asset model composite model.

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

Parameters:

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

Returns:

this

See Also:

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

assetHierarchies

@Stability(Stable)
public CfnAsset.Builder assetHierarchies(IResolvable assetHierarchies)

A list of asset hierarchies that each contain a hierarchyId .

A hierarchy specifies allowed parent/child asset relationships.

Parameters:

assetHierarchies - A list of asset hierarchies that each contain a hierarchyId . This parameter is required.

Returns:

this

See Also:

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

assetHierarchies

@Stability(Stable)
public CfnAsset.Builder assetHierarchies(List<? extends Object> assetHierarchies)

A list of asset hierarchies that each contain a hierarchyId .

A hierarchy specifies allowed parent/child asset relationships.

Parameters:

assetHierarchies - A list of asset hierarchies that each contain a hierarchyId . This parameter is required.

Returns:

this

See Also:

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

assetProperties

@Stability(Stable)
public CfnAsset.Builder assetProperties(IResolvable assetProperties)

The list of asset properties for the asset.

This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

Parameters:

assetProperties - The list of asset properties for the asset. This parameter is required.

Returns:

this

See Also:

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

assetProperties

@Stability(Stable)
public CfnAsset.Builder assetProperties(List<? extends Object> assetProperties)

The list of asset properties for the asset.

This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

Parameters:

assetProperties - The list of asset properties for the asset. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnAsset.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-asset.html#cfn-iotsitewise-asset-tags

build

@Stability(Stable)
public CfnAsset build()

Specified by:

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

Returns:

a newly built instance of CfnAsset.