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.104.0 (build e79254c)",
           date="2024-11-15T10:25:00.951Z")
@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")
         .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	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()	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 .
String	getAssetModelId()	The ID of the asset model from which to create the asset.
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

getAssetModelId

@Stability(Stable)
@NotNull
String 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 .

See Also:

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

getAssetName

@Stability(Stable)
@NotNull
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

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.

See Also:

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

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.

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 CfnAssetProps.Builder builder()

Returns:

a CfnAssetProps.Builder of CfnAssetProps