AWS::IoTSiteWise::AssetModel
Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models 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::AssetModel", "Properties" : { "AssetModelCompositeModels" :
[ AssetModelCompositeModel, ... ]
, "AssetModelDescription" :String
, "AssetModelHierarchies" :[ AssetModelHierarchy, ... ]
, "AssetModelName" :String
, "AssetModelProperties" :[ AssetModelProperty, ... ]
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::IoTSiteWise::AssetModel Properties: AssetModelCompositeModels:
- AssetModelCompositeModel
AssetModelDescription:String
AssetModelHierarchies:- AssetModelHierarchy
AssetModelName:String
AssetModelProperties:- AssetModelProperty
Tags:- Tag
Properties
AssetModelCompositeModels
-
The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. You can use composite asset models to define alarms on this asset model.
Required: No
Type: List of AssetModelCompositeModel
Update requires: No interruption
AssetModelDescription
-
A description for the asset model.
Required: No
Type: String
Update requires: No interruption
AssetModelHierarchies
-
The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Defining relationships between assets in the AWS IoT SiteWiseUser Guide.
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
Required: No
Type: List of AssetModelHierarchy
Update requires: No interruption
AssetModelName
-
A unique, friendly name for the asset model.
The maximum length is 256 characters with the pattern
[^\u0000-\u001F\u007F]+
.Required: Yes
Type: String
Update requires: No interruption
AssetModelProperties
-
The property definitions of the asset model. For more information, see Defining data properties in the AWS IoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
Required: No
Type: List of AssetModelProperty
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 the AssetModelId
.
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.
AssetModelId
-
The ID of the asset model.
For more information about using the
Ref
function, see Ref.