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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSignalCatalog.SensorProperty.Builder	A builder for CfnSignalCatalog.SensorProperty
static final class	CfnSignalCatalog.SensorProperty.Jsii$Proxy	An implementation for CfnSignalCatalog.SensorProperty

Method Summary

Modifier and Type	Method	Description
static CfnSignalCatalog.SensorProperty.Builder	builder()
default List<String>	getAllowedValues()	(Optional) A list of possible values a sensor can take.
String	getDataType()	The specified data type of the sensor.
default String	getDescription()	(Optional) A brief description of a sensor.
String	getFullyQualifiedName()	The fully qualified name of the sensor.
default Number	getMax()	(Optional) The specified possible maximum value of the sensor.
default Number	getMin()	(Optional) The specified possible minimum value of the sensor.
default String	getUnit()	(Optional) The scientific unit of measurement for data collected by the sensor.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataType

@Stability(Stable)
@NotNull
String getDataType()

The specified data type of the sensor.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-datatype

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-fullyqualifiedname

getAllowedValues

@Stability(Stable)
@Nullable
default List<String> getAllowedValues()

(Optional) A list of possible values a sensor can take.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-allowedvalues

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

(Optional) A brief description of a sensor.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-description

getMax

@Stability(Stable)
@Nullable
default Number getMax()

(Optional) The specified possible maximum value of the sensor.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-max

getMin

@Stability(Stable)
@Nullable
default Number getMin()

(Optional) The specified possible minimum value of the sensor.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-min

getUnit

@Stability(Stable)
@Nullable
default String getUnit()

(Optional) The scientific unit of measurement for data collected by the sensor.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-unit

builder

@Stability(Stable)
static CfnSignalCatalog.SensorProperty.Builder builder()

Returns:

a CfnSignalCatalog.SensorProperty.Builder of CfnSignalCatalog.SensorProperty