Class: AWSCDK::IoTFleetWise::CfnSignalCatalog::SensorProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_fleet_wise/cfn_signal_catalog.rb

Overview

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.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_type:, fully_qualified_name:, allowed_values: nil, description: nil, max: nil, min: nil, unit: nil) ⇒ SensorProperty

Returns a new instance of SensorProperty.

Parameters:

  • data_type (String) —

    The specified data type of the sensor.

  • fully_qualified_name (String) —

    The fully qualified name of the sensor.

  • allowed_values (Array<String>, nil) (defaults to: nil) —

    A list of possible values a sensor can take.

  • description (String, nil) (defaults to: nil) —

    A brief description of a sensor.

  • max (Numeric, nil) (defaults to: nil) —

    The specified possible maximum value of the sensor.

  • min (Numeric, nil) (defaults to: nil) —

    The specified possible minimum value of the sensor.

  • unit (String, nil) (defaults to: nil) —

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



1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 1051

def initialize(data_type:, fully_qualified_name:, allowed_values: nil, description: nil, max: nil, min: nil, unit: nil)
  @data_type = data_type
  Jsii::Type.check_type(@data_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataType")
  @fully_qualified_name = fully_qualified_name
  Jsii::Type.check_type(@fully_qualified_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fullyQualifiedName")
  @allowed_values = allowed_values
  Jsii::Type.check_type(@allowed_values, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "allowedValues") unless @allowed_values.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @max = max
  Jsii::Type.check_type(@max, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "max") unless @max.nil?
  @min = min
  Jsii::Type.check_type(@min, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "min") unless @min.nil?
  @unit = unit
  Jsii::Type.check_type(@unit, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "unit") unless @unit.nil?
end

Instance Attribute Details

#allowed_values ⇒ Array<String>? (readonly)

A list of possible values a sensor can take.

Returns:

  • (Array<String>, nil)

See Also:



1084
1085
1086
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 1084

def allowed_values
  @allowed_values
end

#data_type ⇒ String (readonly)

The specified data type of the sensor.

Returns:

  • (String)

See Also:



1072
1073
1074
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 1072

def data_type
  @data_type
end

#description ⇒ String? (readonly)

A brief description of a sensor.

Returns:

  • (String, nil)

See Also:



1089
1090
1091
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 1089

def description
  @description
end

#fully_qualified_name ⇒ String (readonly)

The fully qualified name of the sensor.

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

Returns:

  • (String)

See Also:



1079
1080
1081
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 1079

def fully_qualified_name
  @fully_qualified_name
end

#max ⇒ Numeric? (readonly)

The specified possible maximum value of the sensor.

Returns:

  • (Numeric, nil)

See Also:



1094
1095
1096
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 1094

def max
  @max
end

#min ⇒ Numeric? (readonly)

The specified possible minimum value of the sensor.

Returns:

  • (Numeric, nil)

See Also:



1099
1100
1101
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 1099

def min
  @min
end

#unit ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1104
1105
1106
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 1104

def unit
  @unit
end

Class Method Details

.jsii_properties ⇒ Object 



1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 1106

def self.jsii_properties
  {
    :data_type => "dataType",
    :fully_qualified_name => "fullyQualifiedName",
    :allowed_values => "allowedValues",
    :description => "description",
    :max => "max",
    :min => "min",
    :unit => "unit",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
 
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 1118

def to_jsii
  result = {}
  result.merge!({
    "dataType" => @data_type,
    "fullyQualifiedName" => @fully_qualified_name,
    "allowedValues" => @allowed_values,
    "description" => @description,
    "max" => @max,
    "min" => @min,
    "unit" => @unit,
  })
  result.compact
end