software.amazon.awscdk.services.iotevents

Interface CfnAlarmModel.IotSiteWiseProperty

All Known Implementing Classes:

CfnAlarmModel.IotSiteWiseProperty.Jsii$Proxy

Enclosing class:

CfnAlarmModel

public static interface CfnAlarmModel.IotSiteWiseProperty

Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise .

You must use expressions for all parameters in IotSiteWiseAction . The expressions accept literals, operators, functions, references, and substitutions templates.

Examples - For literal values, the expressions must contain single quotes. For example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature' .

• For references, you must specify either variables or input values. For example, the value for the assetId parameter can be $input.TurbineInput.assetId1 .
• For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the propertyAlias parameter uses a substitution template.

'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'

You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise .

For more information, see Expressions in the AWS IoT Events Developer Guide .

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.iotevents.*;
 IotSiteWiseProperty iotSiteWiseProperty = IotSiteWiseProperty.builder()
         .assetId("assetId")
         .entryId("entryId")
         .propertyAlias("propertyAlias")
         .propertyId("propertyId")
         .propertyValue(AssetPropertyValueProperty.builder()
                 .value(AssetPropertyVariantProperty.builder()
                         .booleanValue("booleanValue")
                         .doubleValue("doubleValue")
                         .integerValue("integerValue")
                         .stringValue("stringValue")
                         .build())
                 // the properties below are optional
                 .quality("quality")
                 .timestamp(AssetPropertyTimestampProperty.builder()
                         .timeInSeconds("timeInSeconds")
                         // the properties below are optional
                         .offsetInNanos("offsetInNanos")
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnAlarmModel.IotSiteWiseProperty.Builder	builder()
default java.lang.String	getAssetId() The ID of the asset that has the specified property.
default java.lang.String	getEntryId() A unique identifier for this entry.
default java.lang.String	getPropertyAlias() The alias of the asset property.
default java.lang.String	getPropertyId() The ID of the asset property.
default java.lang.Object	getPropertyValue() The value to send to the asset property.

Method Detail

getAssetId

default java.lang.String getAssetId()

The ID of the asset that has the specified property.

getEntryId

default java.lang.String getEntryId()

A unique identifier for this entry.

You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.

getPropertyAlias

default java.lang.String getPropertyAlias()

The alias of the asset property.

getPropertyId

default java.lang.String getPropertyId()

The ID of the asset property.

getPropertyValue

default java.lang.Object getPropertyValue()

The value to send to the asset property.

This value contains timestamp, quality, and value (TQV) information.

builder

static CfnAlarmModel.IotSiteWiseProperty.Builder builder()

Returns:

a CfnAlarmModel.IotSiteWiseProperty.Builder of CfnAlarmModel.IotSiteWiseProperty