Package software.amazon.awscdk.services.iotfleetwise

Interface CfnSignalCatalog.ActuatorProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnSignalCatalog.ActuatorProperty.Jsii$Proxy
Enclosing class:
CfnSignalCatalog
@Stability(Stable) public static interface CfnSignalCatalog.ActuatorProperty extends software.amazon.jsii.JsiiSerializable
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.

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.

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.iotfleetwise.*;
 ActuatorProperty actuatorProperty = ActuatorProperty.builder()
         .dataType("dataType")
         .fullyQualifiedName("fullyQualifiedName")
         // the properties below are optional
         .allowedValues(List.of("allowedValues"))
         .assignedValue("assignedValue")
         .description("description")
         .max(123)
         .min(123)
         .unit("unit")
         .build();

  • Method Details

    • getDataType

      @Stability(Stable) @NotNull String getDataType()
      The specified data type of the actuator.

    • getFullyQualifiedName

      @Stability(Stable) @NotNull String getFullyQualifiedName()
      The fully qualified name of the actuator.

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

    • getAllowedValues

      @Stability(Stable) @Nullable default List<String> getAllowedValues()
      (Optional) A list of possible values an actuator can take.

    • getAssignedValue

      @Stability(Stable) @Nullable default String getAssignedValue()
      (Optional) A specified value for the actuator.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      (Optional) A brief description of the actuator.

    • getMax

      @Stability(Stable) @Nullable default Number getMax()
      (Optional) The specified possible maximum value of an actuator.

    • getMin

      @Stability(Stable) @Nullable default Number getMin()
      (Optional) The specified possible minimum value of an actuator.

    • getUnit

      @Stability(Stable) @Nullable default String getUnit()
      (Optional) The scientific unit for the actuator.

    • builder

      @Stability(Stable) static CfnSignalCatalog.ActuatorProperty.Builder builder()
      Returns:
      a CfnSignalCatalog.ActuatorProperty.Builder of CfnSignalCatalog.ActuatorProperty