software.amazon.awscdk.services.iotsitewise

Interface CfnAssetModel.AssetModelCompositeModelProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAssetModel.AssetModelCompositeModelProperty.Jsii$Proxy

Enclosing class:

CfnAssetModel

@Stability(value=Stable)
public static interface CfnAssetModel.AssetModelCompositeModelProperty
extends software.amazon.jsii.JsiiSerializable

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 AWS IoT Events .

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotsitewise.*;
 AssetModelCompositeModelProperty assetModelCompositeModelProperty = AssetModelCompositeModelProperty.builder()
         .name("name")
         .type("type")
         // the properties below are optional
         .compositeModelProperties(List.of(AssetModelPropertyProperty.builder()
                 .dataType("dataType")
                 .logicalId("logicalId")
                 .name("name")
                 .type(PropertyTypeProperty.builder()
                         .typeName("typeName")
                         // the properties below are optional
                         .attribute(AttributeProperty.builder()
                                 .defaultValue("defaultValue")
                                 .build())
                         .metric(MetricProperty.builder()
                                 .expression("expression")
                                 .variables(List.of(ExpressionVariableProperty.builder()
                                         .name("name")
                                         .value(VariableValueProperty.builder()
                                                 .propertyLogicalId("propertyLogicalId")
                                                 // the properties below are optional
                                                 .hierarchyLogicalId("hierarchyLogicalId")
                                                 .build())
                                         .build()))
                                 .window(MetricWindowProperty.builder()
                                         .tumbling(TumblingWindowProperty.builder()
                                                 .interval("interval")
                                                 // the properties below are optional
                                                 .offset("offset")
                                                 .build())
                                         .build())
                                 .build())
                         .transform(TransformProperty.builder()
                                 .expression("expression")
                                 .variables(List.of(ExpressionVariableProperty.builder()
                                         .name("name")
                                         .value(VariableValueProperty.builder()
                                                 .propertyLogicalId("propertyLogicalId")
                                                 // the properties below are optional
                                                 .hierarchyLogicalId("hierarchyLogicalId")
                                                 .build())
                                         .build()))
                                 .build())
                         .build())
                 // the properties below are optional
                 .dataTypeSpec("dataTypeSpec")
                 .unit("unit")
                 .build()))
         .description("description")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnAssetModel.AssetModelCompositeModelProperty.Builder A builder for CfnAssetModel.AssetModelCompositeModelProperty
static class	CfnAssetModel.AssetModelCompositeModelProperty.Jsii$Proxy An implementation for CfnAssetModel.AssetModelCompositeModelProperty

Method Summary

Modifier and Type	Method and Description
static CfnAssetModel.AssetModelCompositeModelProperty.Builder	builder()
default Object	getCompositeModelProperties() The asset property definitions for this composite model.
default String	getDescription() The description of the composite model.
String	getName() The name of the composite model.
String	getType() The type of the composite model.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name of the composite model.

getType

@Stability(value=Stable)
 @NotNull
String getType()

The type of the composite model.

For alarm composite models, this type is AWS/ALARM .

getCompositeModelProperties

@Stability(value=Stable)
 @Nullable
default Object getCompositeModelProperties()

The asset property definitions for this composite model.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

The description of the composite model.

builder

@Stability(value=Stable)
static CfnAssetModel.AssetModelCompositeModelProperty.Builder builder()

Returns:

a CfnAssetModel.AssetModelCompositeModelProperty.Builder of CfnAssetModel.AssetModelCompositeModelProperty