Class: AWSCDK::IoT::CfnThingType::ThingTypePropertiesProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t/cfn_thing_type.rb

Overview

The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(mqtt5_configuration: nil, searchable_attributes: nil, thing_type_description: nil) ⇒ ThingTypePropertiesProperty

Returns a new instance of ThingTypePropertiesProperty.

Parameters:

  • mqtt5_configuration (AWSCDK::IResolvable, AWSCDK::IoT::CfnThingType::Mqtt5ConfigurationProperty, nil) (defaults to: nil)

    The configuration to add user-defined properties to enrich MQTT 5 messages.

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

    A list of searchable thing attribute names.

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

    The description of the thing type.



681
682
683
684
685
686
687
688
# File 'io_t/cfn_thing_type.rb', line 681

def initialize(mqtt5_configuration: nil, searchable_attributes: nil, thing_type_description: nil)
  @mqtt5_configuration = mqtt5_configuration.is_a?(Hash) ? ::AWSCDK::IoT::CfnThingType::Mqtt5ConfigurationProperty.new(**mqtt5_configuration.transform_keys(&:to_sym)) : mqtt5_configuration
  Jsii::Type.check_type(@mqtt5_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3QuQ2ZuVGhpbmdUeXBlLk1xdHQ1Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "mqtt5Configuration") unless @mqtt5_configuration.nil?
  @searchable_attributes = searchable_attributes
  Jsii::Type.check_type(@searchable_attributes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "searchableAttributes") unless @searchable_attributes.nil?
  @thing_type_description = thing_type_description
  Jsii::Type.check_type(@thing_type_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "thingTypeDescription") unless @thing_type_description.nil?
end

Instance Attribute Details

#mqtt5_configurationAWSCDK::IResolvable, ... (readonly)

The configuration to add user-defined properties to enrich MQTT 5 messages.



694
695
696
# File 'io_t/cfn_thing_type.rb', line 694

def mqtt5_configuration
  @mqtt5_configuration
end

#searchable_attributesArray<String>? (readonly)

A list of searchable thing attribute names.



699
700
701
# File 'io_t/cfn_thing_type.rb', line 699

def searchable_attributes
  @searchable_attributes
end

#thing_type_descriptionString? (readonly)

The description of the thing type.



704
705
706
# File 'io_t/cfn_thing_type.rb', line 704

def thing_type_description
  @thing_type_description
end

Class Method Details

.jsii_propertiesObject



706
707
708
709
710
711
712
# File 'io_t/cfn_thing_type.rb', line 706

def self.jsii_properties
  {
    :mqtt5_configuration => "mqtt5Configuration",
    :searchable_attributes => "searchableAttributes",
    :thing_type_description => "thingTypeDescription",
  }
end

Instance Method Details

#to_jsiiObject



714
715
716
717
718
719
720
721
722
# File 'io_t/cfn_thing_type.rb', line 714

def to_jsii
  result = {}
  result.merge!({
    "mqtt5Configuration" => @mqtt5_configuration,
    "searchableAttributes" => @searchable_attributes,
    "thingTypeDescription" => @thing_type_description,
  })
  result.compact
end