Class 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 .

Inheritance

System.Object

CfnAlarmModel.IotSiteWiseProperty

Implements

CfnAlarmModel.IIotSiteWiseProperty

Namespace: Amazon.CDK.AWS.IoTEvents

Assembly: Amazon.CDK.AWS.IoTEvents.dll

Syntax (csharp)

public class IotSiteWiseProperty : Object, CfnAlarmModel.IIotSiteWiseProperty

Syntax (vb)

Public Class IotSiteWiseProperty
    Inherits Object
    Implements CfnAlarmModel.IIotSiteWiseProperty

Remarks

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' .

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTEvents;

var iotSiteWiseProperty = new IotSiteWiseProperty {
    AssetId = "assetId",
    EntryId = "entryId",
    PropertyAlias = "propertyAlias",
    PropertyId = "propertyId",
    PropertyValue = new AssetPropertyValueProperty {
        Value = new AssetPropertyVariantProperty {
            BooleanValue = "booleanValue",
            DoubleValue = "doubleValue",
            IntegerValue = "integerValue",
            StringValue = "stringValue"
        },

        // the properties below are optional
        Quality = "quality",
        Timestamp = new AssetPropertyTimestampProperty {
            TimeInSeconds = "timeInSeconds",

            // the properties below are optional
            OffsetInNanos = "offsetInNanos"
        }
    }
};

Synopsis

Constructors

IotSiteWiseProperty()

Properties

AssetId	The ID of the asset that has the specified property.
EntryId	A unique identifier for this entry.
PropertyAlias	The alias of the asset property.
PropertyId	The ID of the asset property.
PropertyValue	The value to send to the asset property.

Constructors

IotSiteWiseProperty()

public IotSiteWiseProperty()

Properties

AssetId

The ID of the asset that has the specified property.

public string AssetId { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-assetid

EntryId

A unique identifier for this entry.

public string EntryId { get; set; }

Property Value

System.String

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-entryid

PropertyAlias

The alias of the asset property.

public string PropertyAlias { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-propertyalias

PropertyId

The ID of the asset property.

public string PropertyId { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-propertyid

PropertyValue

The value to send to the asset property.

public object PropertyValue { get; set; }

Property Value

System.Object

Remarks

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-propertyvalue

Implements

CfnAlarmModel.IIotSiteWiseProperty