1.204.0

interface IotSiteWiseProperty

This page is available in another version. Click here for the v2 documentation.

LanguageType name
.NETAmazon.CDK.AWS.IoTEvents.CfnAlarmModel.IotSiteWiseProperty
Javasoftware.amazon.awscdk.services.iotevents.CfnAlarmModel.IotSiteWiseProperty
Pythonaws_cdk.aws_iotevents.CfnAlarmModel.IotSiteWiseProperty
TypeScript @aws-cdk/aws-iotevents » 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 * as iotevents from '@aws-cdk/aws-iotevents';
const iotSiteWiseProperty: iotevents.CfnAlarmModel.IotSiteWiseProperty = {
  assetId: 'assetId',
  entryId: 'entryId',
  propertyAlias: 'propertyAlias',
  propertyId: 'propertyId',
  propertyValue: {
    value: {
      booleanValue: 'booleanValue',
      doubleValue: 'doubleValue',
      integerValue: 'integerValue',
      stringValue: 'stringValue',
    },

    // the properties below are optional
    quality: 'quality',
    timestamp: {
      timeInSeconds: 'timeInSeconds',

      // the properties below are optional
      offsetInNanos: 'offsetInNanos',
    },
  },
};

Properties

NameTypeDescription
assetId?stringThe ID of the asset that has the specified property.
entryId?stringA unique identifier for this entry.
propertyAlias?stringThe alias of the asset property.
propertyId?stringThe ID of the asset property.
propertyValue?IResolvable | AssetPropertyValuePropertyThe value to send to the asset property.

assetId?

Type: string (optional)

The ID of the asset that has the specified property.

entryId?

Type: string (optional)

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.

propertyAlias?

Type: string (optional)

The alias of the asset property.

propertyId?

Type: string (optional)

The ID of the asset property.

propertyValue?

Type: IResolvable | AssetPropertyValueProperty (optional)

The value to send to the asset property.

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

← PreviousNext →