Interface CfnAssetProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAssetProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:18.273Z")
@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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnAssetProps
static final class
An implementation forCfnAssetProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnAssetProps.Builder
builder()
default String
The ID of the asset, in UUID format.default String
The external ID of the asset model composite model.default Object
A list of asset hierarchies that each contain ahierarchyId
.The ID of the asset model from which to create the asset.A friendly name for the asset.default Object
The list of asset properties for the asset.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
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:
-
getAssetName
A friendly name for the asset.- See Also:
-
getAssetDescription
The ID of the asset, in UUID format.- See Also:
-
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:
-
getAssetHierarchies
A list of asset hierarchies that each contain ahierarchyId
.A hierarchy specifies allowed parent/child asset relationships.
- See Also:
-
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:
-
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:
-
builder
- Returns:
- a
CfnAssetProps.Builder
ofCfnAssetProps
-