Package software.amazon.awscdk.services.iotsitewise

Class CfnAsset

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iotsitewise.CfnAsset

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IAssetRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:38.460Z")
@Stability(Stable)
public class CfnAsset
extends CfnResource
implements IInspectable, IAssetRef, ITaggable

Creates an asset from an existing asset model.

For more information, see Creating assets in the AWS IoT SiteWise User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotsitewise.*;
 CfnAsset cfnAsset = CfnAsset.Builder.create(this, "MyCfnAsset")
         .assetModelId("assetModelId")
         .assetName("assetName")
         // the properties below are optional
         .assetDescription("assetDescription")
         .assetExternalId("assetExternalId")
         .assetHierarchies(List.of(AssetHierarchyProperty.builder()
                 .childAssetId("childAssetId")
                 // the properties below are optional
                 .externalId("externalId")
                 .id("id")
                 .logicalId("logicalId")
                 .build()))
         .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	Class	Description
static interface	CfnAsset.AssetHierarchyProperty	Describes an asset hierarchy that contains a hierarchy's name and ID.
static interface	CfnAsset.AssetPropertyProperty	Contains asset property information.
static final class	CfnAsset.Builder	A fluent builder for CfnAsset.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.iotsitewise.IAssetRef

IAssetRef.Jsii$Default, IAssetRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnAsset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAsset(software.amazon.jsii.JsiiObjectRef objRef)
	CfnAsset(software.constructs.Construct scope, String id, CfnAssetProps props)	Create a new AWS::IoTSiteWise::Asset.

Method Summary

Modifier and Type	Method	Description
static String	arnForAsset(IAssetRef resource)
static IAssetRef	fromAssetArn(software.constructs.Construct scope, String id, String arn)	Creates a new IAssetRef from an ARN.
static IAssetRef	fromAssetId(software.constructs.Construct scope, String id, String assetId)	Creates a new IAssetRef from a assetId.
String	getAssetDescription()	The ID of the asset, in UUID format.
String	getAssetExternalId()	The external ID of the asset model composite model.
Object	getAssetHierarchies()	A list of asset hierarchies that each contain a hierarchyId .
String	getAssetModelId()	The ID of the asset model from which to create the asset.
String	getAssetName()	A friendly name for the asset.
Object	getAssetProperties()	The list of asset properties for the asset.
AssetReference	getAssetRef()	A reference to a Asset resource.
String	getAttrAssetArn()	The ARN of the asset.
String	getAttrAssetId()	The ID of the asset.
protected Map<String,Object>	getCfnProperties()
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	A list of key-value pairs that contain metadata for the asset.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnAsset(Object x)	Checks whether the given object is a CfnAsset.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAssetDescription(String value)	The ID of the asset, in UUID format.
void	setAssetExternalId(String value)	The external ID of the asset model composite model.
void	setAssetHierarchies(List<Object> value)	A list of asset hierarchies that each contain a hierarchyId .
void	setAssetHierarchies(IResolvable value)	A list of asset hierarchies that each contain a hierarchyId .
void	setAssetModelId(String value)	The ID of the asset model from which to create the asset.
void	setAssetName(String value)	A friendly name for the asset.
void	setAssetProperties(List<Object> value)	The list of asset properties for the asset.
void	setAssetProperties(IResolvable value)	The list of asset properties for the asset.
void	setTagsRaw(List<CfnTag> value)	A list of key-value pairs that contain metadata for the asset.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnAsset

protected CfnAsset(software.amazon.jsii.JsiiObjectRef objRef)

CfnAsset

protected CfnAsset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAsset

@Stability(Stable)
public CfnAsset(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnAssetProps props)

Create a new AWS::IoTSiteWise::Asset.

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.

props - Resource properties. This parameter is required.

Method Details

arnForAsset

@Stability(Stable)
@NotNull
public static String arnForAsset(@NotNull
 IAssetRef resource)

Parameters:

resource - This parameter is required.

fromAssetArn

@Stability(Stable)
@NotNull
public static IAssetRef fromAssetArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String arn)

Creates a new IAssetRef from an ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

arn - This parameter is required.

fromAssetId

@Stability(Stable)
@NotNull
public static IAssetRef fromAssetId(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String assetId)

Creates a new IAssetRef from a assetId.

Parameters:

scope - This parameter is required.

id - This parameter is required.

assetId - This parameter is required.

isCfnAsset

@Stability(Stable)
@NotNull
public static Boolean isCfnAsset(@NotNull
 Object x)

Checks whether the given object is a CfnAsset.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAssetRef

@Stability(Stable)
@NotNull
public AssetReference getAssetRef()

A reference to a Asset resource.

Specified by:

getAssetRef in interface IAssetRef

getAttrAssetArn

@Stability(Stable)
@NotNull
public String getAttrAssetArn()

The ARN of the asset.

getAttrAssetId

@Stability(Stable)
@NotNull
public String getAttrAssetId()

The ID of the asset.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getAssetModelId

@Stability(Stable)
@NotNull
public String getAssetModelId()

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

setAssetModelId

@Stability(Stable)
public void setAssetModelId(@NotNull
 String value)

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

getAssetName

@Stability(Stable)
@NotNull
public String getAssetName()

A friendly name for the asset.

setAssetName

@Stability(Stable)
public void setAssetName(@NotNull
 String value)

A friendly name for the asset.

getAssetDescription

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

The ID of the asset, in UUID format.

setAssetDescription

@Stability(Stable)
public void setAssetDescription(@Nullable
 String value)

The ID of the asset, in UUID format.

getAssetExternalId

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

The external ID of the asset model composite model.

setAssetExternalId

@Stability(Stable)
public void setAssetExternalId(@Nullable
 String value)

The external ID of the asset model composite model.

getAssetHierarchies

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

A list of asset hierarchies that each contain a hierarchyId .

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

setAssetHierarchies

@Stability(Stable)
public void setAssetHierarchies(@Nullable
 IResolvable value)

A list of asset hierarchies that each contain a hierarchyId .

setAssetHierarchies

@Stability(Stable)
public void setAssetHierarchies(@Nullable
 List<Object> value)

A list of asset hierarchies that each contain a hierarchyId .

getAssetProperties

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

The list of asset properties for the asset.

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

setAssetProperties

@Stability(Stable)
public void setAssetProperties(@Nullable
 IResolvable value)

The list of asset properties for the asset.

setAssetProperties

@Stability(Stable)
public void setAssetProperties(@Nullable
 List<Object> value)

The list of asset properties for the asset.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

A list of key-value pairs that contain metadata for the asset.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

A list of key-value pairs that contain metadata for the asset.