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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.031Z")
 @Stability(value=Stable)
public class CfnAsset
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTSiteWise::Asset`.

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")
         .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")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnAsset.AssetHierarchyProperty Describes an asset hierarchy that contains a `childAssetId` and `hierarchyLogicalId` .
static interface	CfnAsset.AssetPropertyProperty Contains asset property information.
static 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.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getAssetDescription() `AWS::IoTSiteWise::Asset.AssetDescription`.
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.
Object	getAssetProperties() The list of asset properties for the asset.
String	getAttrAssetArn() The ARN of the asset.
String	getAttrAssetId() The ID of the asset.
protected Map<String,Object>	getCfnProperties()
TagManager	getTags() A list of key-value pairs that contain metadata for the asset.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAssetDescription(String value) `AWS::IoTSiteWise::Asset.AssetDescription`.
void	setAssetHierarchies(IResolvable value) A list of asset hierarchies that each contain a `hierarchyLogicalId` .
void	setAssetHierarchies(List<Object> value) A list of asset hierarchies that each contain a `hierarchyLogicalId` .
void	setAssetModelId(String value) The ID of the asset model from which to create the asset.
void	setAssetName(String value) A unique, friendly name for the asset.
void	setAssetProperties(IResolvable value) The list of asset properties for the asset.
void	setAssetProperties(List<Object> value) The list of asset properties for the asset.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAsset

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

CfnAsset

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

CfnAsset

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAssetArn

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

The ARN of the asset.

getAttrAssetId

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

The ID of the asset.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager 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 .

getAssetModelId

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

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

setAssetModelId

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

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

getAssetName

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

A unique, friendly name for the asset.

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

setAssetName

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

A unique, friendly name for the asset.

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

getAssetDescription

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

`AWS::IoTSiteWise::Asset.AssetDescription`.

setAssetDescription

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

`AWS::IoTSiteWise::Asset.AssetDescription`.

getAssetHierarchies

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

A list of asset hierarchies that each contain a `hierarchyLogicalId` .

A hierarchy specifies allowed parent/child asset relationships.

setAssetHierarchies

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

A list of asset hierarchies that each contain a `hierarchyLogicalId` .

A hierarchy specifies allowed parent/child asset relationships.

setAssetHierarchies

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

A list of asset hierarchies that each contain a `hierarchyLogicalId` .

A hierarchy specifies allowed parent/child asset relationships.

getAssetProperties

@Stability(value=Stable)
 @Nullable
public 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.

setAssetProperties

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

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.

setAssetProperties

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

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.