Package software.amazon.awscdk.cfnpropertymixins.services.iotsitewise

Class CfnAssetPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.iotsitewise.CfnAssetPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAssetPropsMixin>

Enclosing class:

CfnAssetPropsMixin

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

A fluent builder for CfnAssetPropsMixin.

Method Summary

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

Parameters:

options - Mixin options.

Returns:

a new instance of CfnAssetPropsMixin.Builder.

create

@Stability(Stable)
public static CfnAssetPropsMixin.Builder create()

Returns:

a new instance of CfnAssetPropsMixin.Builder.

assetDescription

@Stability(Stable)
public CfnAssetPropsMixin.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 CfnAssetPropsMixin.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 CfnAssetPropsMixin.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 CfnAssetPropsMixin.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

assetModelId

@Stability(Stable)
public CfnAssetPropsMixin.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 CfnAssetPropsMixin.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 CfnAssetPropsMixin.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

assetProperties

@Stability(Stable)
public CfnAssetPropsMixin.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 CfnAssetPropsMixin.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 CfnAssetPropsMixin.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 CfnAssetPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnAssetPropsMixin.