Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-iotsitewise-asset.json
Parent schema serverless-framework-configuration
Type: object

Properties

AssetModelId string | Aws_CF_FunctionString required

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

AssetName string | Aws_CF_FunctionString required

A unique, friendly name for the asset.

AssetDescription string | Aws_CF_FunctionString

A description for the asset

AssetProperties AssetProperty[]
AssetHierarchies AssetHierarchy[]
Tags Tag[]

A list of key-value pairs that contain metadata for the asset.

Definitions

AssetProperty object

The asset property's definition, alias, unit, and notification state.

LogicalId string | Aws_CF_FunctionString required

Customer provided ID for property.

Alias string | Aws_CF_FunctionString

The property alias that identifies the property.

NotificationState string | Aws_CF_FunctionString

The MQTT notification state (ENABLED or DISABLED) for this asset property.

Unit string | Aws_CF_FunctionString

The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.

AssetHierarchy object

A hierarchy specifies allowed parent/child asset relationships.

LogicalId string | Aws_CF_FunctionString required

The LogicalID of a hierarchy in the parent asset's model.

ChildAssetId string | Aws_CF_FunctionString required

The ID of the child asset to be associated.

Tag object
Key string | Aws_CF_FunctionString required
Value string | Aws_CF_FunctionString required