1.204.0

interface AssetPropertyVariantProperty

LanguageType name
.NETAmazon.CDK.AWS.IoTEvents.CfnAlarmModel.AssetPropertyVariantProperty
Javasoftware.amazon.awscdk.services.iotevents.CfnAlarmModel.AssetPropertyVariantProperty
Pythonaws_cdk.aws_iotevents.CfnAlarmModel.AssetPropertyVariantProperty
TypeScript @aws-cdk/aws-iotevents » CfnAlarmModel » AssetPropertyVariantProperty

A structure that contains an asset property value.

For more information, see Variant in the AWS IoT SiteWise API Reference .

You must use expressions for all parameters in AssetPropertyVariant . 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 integerValue parameter can be '100' .

  • For references, you must specify either variables or parameters. For example, the value for the booleanValue parameter can be $variable.offline .
  • 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 doubleValue parameter uses a substitution template.

'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'

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

You must specify one of the following value types, depending on the dataType of the specified asset property. For more information, see AssetProperty in the AWS IoT SiteWise API Reference .

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 assetPropertyVariantProperty: iotevents.CfnAlarmModel.AssetPropertyVariantProperty = {
  booleanValue: 'booleanValue',
  doubleValue: 'doubleValue',
  integerValue: 'integerValue',
  stringValue: 'stringValue',
};

Properties

NameTypeDescription
booleanValue?stringThe asset property value is a Boolean value that must be 'TRUE' or 'FALSE' .
doubleValue?stringThe asset property value is a double.
integerValue?stringThe asset property value is an integer.
stringValue?stringThe asset property value is a string.

booleanValue?

Type: string (optional)

The asset property value is a Boolean value that must be 'TRUE' or 'FALSE' .

You must use an expression, and the evaluated result should be a Boolean value.

doubleValue?

Type: string (optional)

The asset property value is a double.

You must use an expression, and the evaluated result should be a double.

integerValue?

Type: string (optional)

The asset property value is an integer.

You must use an expression, and the evaluated result should be an integer.

stringValue?

Type: string (optional)

The asset property value is a string.

You must use an expression, and the evaluated result should be a string.

← PreviousNext →