Class: AWSCDK::IoTFleetWise::CfnSignalCatalog::AttributeProperty

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

Overview

A signal that represents static information about the vehicle, such as engine type or manufacturing date.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_type:, fully_qualified_name:, allowed_values: nil, assigned_value: nil, default_value: nil, description: nil, max: nil, min: nil, unit: nil) ⇒ AttributeProperty

Returns a new instance of AttributeProperty.

Parameters:

  • data_type (String)

    The specified data type of the attribute.

  • fully_qualified_name (String)

    The fully qualified name of the attribute.

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

    A list of possible values an attribute can be assigned.

  • assigned_value (String, nil) (defaults to: nil)

    A specified value for the attribute.

  • default_value (String, nil) (defaults to: nil)

    The default value of the attribute.

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

    A brief description of the attribute.

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

    The specified possible maximum value of the attribute.

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

    The specified possible minimum value of the attribute.

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

    The scientific unit for the attribute.



745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 745

def initialize(data_type:, fully_qualified_name:, allowed_values: nil, assigned_value: nil, default_value: 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?
  @assigned_value = assigned_value
  Jsii::Type.check_type(@assigned_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "assignedValue") unless @assigned_value.nil?
  @default_value = default_value
  Jsii::Type.check_type(@default_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultValue") unless @default_value.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_valuesArray<String>? (readonly)

A list of possible values an attribute can be assigned.



782
783
784
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 782

def allowed_values
  @allowed_values
end

#assigned_valueString? (readonly)

A specified value for the attribute.



787
788
789
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 787

def assigned_value
  @assigned_value
end

#data_typeString (readonly)

The specified data type of the attribute.



770
771
772
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 770

def data_type
  @data_type
end

#default_valueString? (readonly)

The default value of the attribute.



792
793
794
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 792

def default_value
  @default_value
end

#descriptionString? (readonly)

A brief description of the attribute.



797
798
799
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 797

def description
  @description
end

#fully_qualified_nameString (readonly)

The fully qualified name of the attribute.

For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type .



777
778
779
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 777

def fully_qualified_name
  @fully_qualified_name
end

#maxNumeric? (readonly)

The specified possible maximum value of the attribute.



802
803
804
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 802

def max
  @max
end

#minNumeric? (readonly)

The specified possible minimum value of the attribute.



807
808
809
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 807

def min
  @min
end

#unitString? (readonly)

The scientific unit for the attribute.



812
813
814
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 812

def unit
  @unit
end

Class Method Details

.jsii_propertiesObject



814
815
816
817
818
819
820
821
822
823
824
825
826
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 814

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

Instance Method Details

#to_jsiiObject



828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 828

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