AWS::IoTSiteWise::Asset - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::IoTSiteWise::Asset

Creates an asset from an existing asset model. For more information, see Creating assets in the Amazon IoT SiteWise User Guide.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IoTSiteWise::Asset",
  "Properties" : {
      "AssetDescription" : String,
      "AssetExternalId" : String,
      "AssetHierarchies" : [ AssetHierarchy, ... ],
      "AssetModelId" : String,
      "AssetName" : String,
      "AssetProperties" : [ AssetProperty, ... ],
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::IoTSiteWise::Asset
Properties:
  AssetDescription: String
  AssetExternalId: String
  AssetHierarchies: 
    - AssetHierarchy
  AssetModelId: String
  AssetName: String
  AssetProperties: 
    - AssetProperty
  Tags: 
    - Tag

Properties

AssetDescription

The ID of the asset, in UUID format.

Required: No

Type: String

Update requires: No interruption

AssetExternalId

The external ID of the asset model composite model. For more information, see Using external IDs in the Amazon IoT SiteWise User Guide.

Required: No

Type: String

Pattern: [a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+

Minimum: 2

Maximum: 128

Update requires: No interruption

AssetHierarchies

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

Required: No

Type: Array of AssetHierarchy

Update requires: No interruption

AssetModelId

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 Amazon IoT SiteWise User Guide.

Required: Yes

Type: String

Update requires: No interruption

AssetName

A friendly name for the asset.

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: Array 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 Amazon IoT SiteWise resources in the Amazon IoT SiteWise User Guide.

Required: No

Type: Array 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.

AssetArn

The ARN of the asset.

For more information about using the Ref function, see Ref.

AssetId

The ID of the asset.

For more information about using the Ref function, see Ref.