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

Interface CfnAssetMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAssetMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-19T12:55:21.523Z")
@Stability(Stable)
public interface CfnAssetMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnAssetPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.iotsitewise.*;
 CfnAssetMixinProps cfnAssetMixinProps = CfnAssetMixinProps.builder()
         .assetDescription("assetDescription")
         .assetExternalId("assetExternalId")
         .assetHierarchies(List.of(AssetHierarchyProperty.builder()
                 .childAssetId("childAssetId")
                 .externalId("externalId")
                 .id("id")
                 .logicalId("logicalId")
                 .build()))
         .assetModelId("assetModelId")
         .assetName("assetName")
         .assetProperties(List.of(AssetPropertyProperty.builder()
                 .alias("alias")
                 .externalId("externalId")
                 .id("id")
                 .logicalId("logicalId")
                 .notificationState("notificationState")
                 .unit("unit")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAssetMixinProps.Builder	A builder for CfnAssetMixinProps
static final class	CfnAssetMixinProps.Jsii$Proxy	An implementation for CfnAssetMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnAssetMixinProps.Builder	builder()
default String	getAssetDescription()	The ID of the asset, in UUID format.
default String	getAssetExternalId()	The external ID of the asset model composite model.
default Object	getAssetHierarchies()	A list of asset hierarchies that each contain a hierarchyId .
default Object	getAssetModelId()	The ID of the asset model from which to create the asset.
default String	getAssetName()	A friendly name for the asset.
default Object	getAssetProperties()	The list of asset properties for the asset.
default List<CfnTag>	getTags()	A list of key-value pairs that contain metadata for the asset.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAssetDescription

@Stability(Stable)
@Nullable
default String getAssetDescription()

The ID of the asset, in UUID format.

See Also:

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

getAssetExternalId

@Stability(Stable)
@Nullable
default String getAssetExternalId()

The external ID of the asset model composite model.

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

See Also:

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

getAssetHierarchies

@Stability(Stable)
@Nullable
default Object getAssetHierarchies()

A list of asset hierarchies that each contain a hierarchyId .

A hierarchy specifies allowed parent/child asset relationships.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAssetPropsMixin.AssetHierarchyProperty>

See Also:

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

getAssetModelId

@Stability(Stable)
@Nullable
default Object getAssetModelId()

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 .

Returns union: either String or IAssetModelRef

See Also:

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

getAssetName

@Stability(Stable)
@Nullable
default String getAssetName()

A friendly name for the asset.

See Also:

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

getAssetProperties

@Stability(Stable)
@Nullable
default Object getAssetProperties()

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAssetPropsMixin.AssetPropertyProperty>

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 .

See Also:

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

builder

@Stability(Stable)
static CfnAssetMixinProps.Builder builder()

Returns:

a CfnAssetMixinProps.Builder of CfnAssetMixinProps