AWS::IoTFleetWise::SignalCatalog Actuator

A signal that represents a vehicle device such as the engine, heater, and door locks. Data from an actuator reports the state of a certain vehicle device.

Note

Updating actuator data can change the state of a device. For example, you can turn on or off the heater by updating its actuator data.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "AllowedValues" : [ String, ... ], "AssignedValue" : String, "DataType" : String, "Description" : String, "FullyQualifiedName" : String, "Max" : Double, "Min" : Double, "Unit" : String }

YAML

AllowedValues: - String AssignedValue: String DataType: String Description: String FullyQualifiedName: String Max: Double Min: Double Unit: String

Properties

AllowedValues

A list of possible values an actuator can take.

Required: No

Type: List of String

Update requires: No interruption

AssignedValue

A specified value for the actuator.

Required: No

Type: String

Update requires: No interruption

DataType

The specified data type of the actuator.

Required: Yes

Type: String

Allowed values: BOOLEAN | BOOLEAN_ARRAY | DOUBLE | DOUBLE_ARRAY | FLOAT | FLOAT_ARRAY | INT16 | INT16_ARRAY | INT32 | INT32_ARRAY | INT64 | INT64_ARRAY | INT8 | INT8_ARRAY | STRING | STRING_ARRAY | UINT16 | UINT16_ARRAY | UINT32 | UINT32_ARRAY | UINT64 | UINT64_ARRAY | UINT8 | UINT8_ARRAY | UNIX_TIMESTAMP | UNIX_TIMESTAMP_ARRAY | UNKNOWN

Update requires: No interruption

Description

A brief description of the actuator.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Pattern: [^\u0000-\u001F\u007F]+

Update requires: No interruption

FullyQualifiedName

The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.

Required: Yes

Type: String

Update requires: No interruption

Max

The specified possible maximum value of an actuator.

Required: No

Type: Double

Update requires: No interruption

Min

The specified possible minimum value of an actuator.

Required: No

Type: Double

Update requires: No interruption

Unit

The scientific unit for the actuator.

Required: No

Type: String

Update requires: No interruption