AWS::IoTSiteWise::Asset
Creates an asset from an existing asset model. For more information, see Creating assets in the AWS IoT SiteWise User Guide.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::IoTSiteWise::Asset", "Properties" : { "AssetDescription" :
String
, "AssetHierarchies" :[ AssetHierarchy, ... ]
, "AssetModelId" :String
, "AssetName" :String
, "AssetProperties" :[ AssetProperty, ... ]
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::IoTSiteWise::Asset Properties: AssetDescription:
String
AssetHierarchies:- AssetHierarchy
AssetModelId:String
AssetName:String
AssetProperties:- AssetProperty
Tags:- Tag
Properties
AssetDescription
-
A description for the asset.
Required: No
Type: String
Update requires: No interruption
AssetHierarchies
-
A list of asset hierarchies that each contain a
hierarchyLogicalId
. A hierarchy specifies allowed parent/child asset relationships.Required: No
Type: List of AssetHierarchy
Update requires: No interruption
AssetModelId
-
The ID of the asset model from which to create the asset.
Required: Yes
Type: String
Update requires: No interruption
AssetName
-
A unique, friendly name for the asset.
The maximum length is 256 characters with the pattern
[^\u0000-\u001F\u007F]+
.Required: Yes
Type: String
Update requires: No interruption
AssetProperties
-
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.Required: No
Type: List of AssetProperty
Update requires: No interruption
Tags
-
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.
Required: No
Type: List of Tag
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns AssetId
and AssetArn
.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt.