AWS::IoTFleetWise::SignalCatalog Actuator - AWS CloudFormation
SyntaxProperties

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" : Number,
  "Min" : Number,
  "Unit" : String
}

YAML

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

Properties

AllowedValues

A list of possible values an actuator can take.

Required: No

Type: Array of String

Minimum: 1

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: INT8 | UINT8 | INT16 | UINT16 | INT32 | UINT32 | INT64 | UINT64 | BOOLEAN | FLOAT | DOUBLE | STRING | UNIX_TIMESTAMP | INT8_ARRAY | UINT8_ARRAY | INT16_ARRAY | UINT16_ARRAY | INT32_ARRAY | UINT32_ARRAY | INT64_ARRAY | UINT64_ARRAY | BOOLEAN_ARRAY | FLOAT_ARRAY | DOUBLE_ARRAY | STRING_ARRAY | UNIX_TIMESTAMP_ARRAY | UNKNOWN

Update requires: No interruption

Description

A brief description of the actuator.

Required: No

Type: String

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

Minimum: 1

Maximum: 2048

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: Number

Update requires: No interruption

Min

The specified possible minimum value of an actuator.

Required: No

Type: Number

Update requires: No interruption

Unit

The scientific unit for the actuator.

Required: No

Type: String

Update requires: No interruption