AWS::IoTSiteWise::AssetModel AssetModelCompositeModel - Amazon CloudFormation
SyntaxPropertiesExamples
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::AssetModel AssetModelCompositeModel

Contains information about a composite model in an asset model. This object contains the asset property definitions that you define in the composite model. You can use composite asset models to define alarms on this asset model.

If you use the AssetModelCompositeModel property to create an alarm, you must use the following information to define three asset model properties:

  • Use an asset model property to specify the alarm type.

    • The name must be AWS/ALARM_TYPE.

    • The data type must be STRING.

    • For the Type property, the type name must be Attribute and the default value must be IOT_EVENTS.

  • Use an asset model property to specify the alarm source.

    • The name must be AWS/ALARM_SOURCE.

    • The data type must be STRING.

    • For the Type property, the type name must be Attribute and the default value must be the ARN of the alarm model that you created in Amazon IoT Events.

      Note

      For the ARN of the alarm model, you can use the Fn::Sub intrinsic function to substitute the AWS::Partition, AWS::Region, and AWS::AccountId variables in an input string with values that you specify.

      For example, Fn::Sub: "arn:${AWS::Partition}:iotevents:${AWS::Region}:${AWS::AccountId}:alarmModel/TestAlarmModel".

      Replace TestAlarmModel with the name of your alarm model.

      For more information about using the Fn::Sub intrinsic function, see Fn::Sub.

  • Use an asset model property to specify the state of the alarm.

    • The name must be AWS/ALARM_STATE.

    • The data type must be STRUCT.

    • The DataTypeSpec value must be AWS/ALARM_STATE.

    • For the Type property, the type name must be Measurement.

At the bottom of this page, we provide a YAML example that you can modify to create an alarm.

Syntax

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

JSON

{
  "CompositeModelProperties" : [ AssetModelProperty, ... ],
  "Description" : String,
  "Name" : String,
  "Type" : String
}

Properties

CompositeModelProperties

The asset property definitions for this composite model.

Required: No

Type: List of AssetModelProperty

Update requires: No interruption

Description

The description of the composite model.

Required: No

Type: String

Update requires: No interruption

Name

The name of the composite model.

Required: Yes

Type: String

Update requires: No interruption

Type

The type of the composite model. For alarm composite models, this type is AWS/ALARM.

Required: Yes

Type: String

Update requires: No interruption

Examples

Create an alarm model

You can modify the following example to create an alarm model.

Note

Replace TestAlarmModel with the name of your alarm model.

YAML

Resources:
  AssetModelWithAlarmCompositeModel:
    Type: AWS::IoTSiteWise::AssetModel
    Properties:
      AssetModelName: AssetModelWithValidAlarmCompositeModel
      AssetModelDescription: AssetModelWithValidAlarmCompositeModel
      AssetModelCompositeModels:
        - Description: compositeModel created by cfn
          Name: TestAlarmCompositeModel
          Type: AWS/ALARM
          CompositeModelProperties:
            - LogicalId: MyLogicalId_for_ALARM_TYPE_1
              Name: AWS/ALARM_TYPE
              DataType: STRING
              Type:
                TypeName: Attribute
                Attribute:
                  DefaultValue: IOT_EVENTS
            - LogicalId: MyLogicalId_for_ALARM_SOURCE_1
              Name: AWS/ALARM_SOURCE
              DataType: STRING
              Type:
                TypeName: Attribute
                Attribute:
                DefaultValue:
                  Fn::Sub: "arn:${AWS::Partition}:iotevents:${AWS::Region}:${AWS::AccountId}:alarmModel/TestAlarmModel"
            - LogicalId: MyLogicalId_for_ALARM_STATE_1
              Name: AWS/ALARM_STATE
              DataType: STRUCT
              DataTypeSpec: AWS/ALARM_STATE
              Type:
                TypeName: Measurement