Package software.amazon.awscdk.services.iotevents

Interface CfnAlarmModel.AssetPropertyValueProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAlarmModel.AssetPropertyValueProperty.Jsii$Proxy

Enclosing class:

CfnAlarmModel

@Stability(Stable)
public static interface CfnAlarmModel.AssetPropertyValueProperty
extends software.amazon.jsii.JsiiSerializable

A structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference .

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

Examples - For literal values, the expressions must contain single quotes. For example, the value for the quality parameter can be 'GOOD' .

• For references, you must specify either variables or input values. For example, the value for the quality parameter can be $input.TemperatureInput.sensorData.quality .

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.*;
 AssetPropertyValueProperty assetPropertyValueProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAlarmModel.AssetPropertyValueProperty.Builder	builder()
default String	getQuality()	The quality of the asset property value.
default Object	getTimestamp()	The timestamp associated with the asset property value.
Object	getValue()	The value to send to an asset property.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getValue

@Stability(Stable)
@NotNull
Object getValue()

The value to send to an asset property.

Returns union: either IResolvable or CfnAlarmModel.AssetPropertyVariantProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html#cfn-iotevents-alarmmodel-assetpropertyvalue-value

getQuality

@Stability(Stable)
@Nullable
default String getQuality()

The quality of the asset property value.

The value must be 'GOOD' , 'BAD' , or 'UNCERTAIN' .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html#cfn-iotevents-alarmmodel-assetpropertyvalue-quality

getTimestamp

@Stability(Stable)
@Nullable
default Object getTimestamp()

The timestamp associated with the asset property value.

The default is the current event time.

Returns union: either IResolvable or CfnAlarmModel.AssetPropertyTimestampProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html#cfn-iotevents-alarmmodel-assetpropertyvalue-timestamp

builder

@Stability(Stable)
static CfnAlarmModel.AssetPropertyValueProperty.Builder builder()

Returns:

a CfnAlarmModel.AssetPropertyValueProperty.Builder of CfnAlarmModel.AssetPropertyValueProperty