Package software.amazon.awscdk.services.iotsitewise

Interface CfnAssetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAssetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:57.905Z")
@Stability(Stable)
public interface CfnAssetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAsset.

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.*;
 CfnAssetProps cfnAssetProps = CfnAssetProps.builder()
         .assetModelId("assetModelId")
         .assetName("assetName")
         // the properties below are optional
         .assetDescription("assetDescription")
         .assetHierarchies(List.of(AssetHierarchyProperty.builder()
                 .childAssetId("childAssetId")
                 .logicalId("logicalId")
                 .build()))
         .assetProperties(List.of(AssetPropertyProperty.builder()
                 .logicalId("logicalId")
                 // the properties below are optional
                 .alias("alias")
                 .notificationState("notificationState")
                 .unit("unit")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAssetProps.Builder	builder()
default String	getAssetDescription()	A description for the asset.
default Object	getAssetHierarchies()	A list of asset hierarchies that each contain a hierarchyLogicalId .
String	getAssetModelId()	The ID of the asset model from which to create the asset.
String	getAssetName()	A unique, 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

getAssetModelId

@Stability(Stable)
@NotNull
String getAssetModelId()

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

getAssetName

@Stability(Stable)
@NotNull
String getAssetName()

A unique, friendly name for the asset.

The maximum length is 256 characters with the pattern [^\ u0000-\ u001F\ u007F]+ .

getAssetDescription

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

A description for the asset.

getAssetHierarchies

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

A list of asset hierarchies that each contain a hierarchyLogicalId .

A hierarchy specifies allowed parent/child asset relationships.

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.

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 .

builder

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

Returns:

a CfnAssetProps.Builder of CfnAssetProps