Package software.amazon.awscdk.services.iotfleetwise

Interface CfnSignalCatalog.SensorProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnSignalCatalog.SensorProperty.Jsii$Proxy
Enclosing class:
CfnSignalCatalog
@Stability(Stable) public static interface CfnSignalCatalog.SensorProperty extends software.amazon.jsii.JsiiSerializable
An input component that reports the environmental condition of a vehicle.

You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.

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

  • Method Details

    • getDataType

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

    • getFullyQualifiedName

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

      For example, the fully qualified name of a sensor might be Vehicle.Body.Engine.Battery .

    • getAllowedValues

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

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      (Optional) A brief description of a sensor.

    • getMax

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

    • getMin

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

    • getUnit

      @Stability(Stable) @Nullable default String getUnit()
      (Optional) The scientific unit of measurement for data collected by the sensor.

    • builder

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