Class: AWSCDK::IoTSiteWise::CfnGateway::GreengrassV2Property

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_site_wise/cfn_gateway.rb

Overview

Contains details for a gateway that runs on AWS IoT Greengrass V2 .

To create a gateway that runs on AWS IoT Greengrass V2 , you must deploy the IoT SiteWise Edge component to your gateway device. Your Greengrass device role must use the AWSIoTSiteWiseEdgeAccess policy. For more information, see Using AWS IoT SiteWise at the edge in the AWS IoT SiteWise User Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(core_device_thing_name:, core_device_operating_system: nil) ⇒ GreengrassV2Property

Returns a new instance of GreengrassV2Property.

Parameters:

  • core_device_thing_name (String) —

    The name of the AWS IoT thing for your AWS IoT Greengrass V2 core device.

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

    The operating system of the core device in AWS IoT Greengrass V2.



721
722
723
724
725
726
 
# File 'io_t_site_wise/cfn_gateway.rb', line 721

def initialize(core_device_thing_name:, core_device_operating_system: nil)
  @core_device_thing_name = core_device_thing_name
  Jsii::Type.check_type(@core_device_thing_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "coreDeviceThingName")
  @core_device_operating_system = core_device_operating_system
  Jsii::Type.check_type(@core_device_operating_system, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "coreDeviceOperatingSystem") unless @core_device_operating_system.nil?
end

Instance Attribute Details

#core_device_operating_system ⇒ String? (readonly)

The operating system of the core device in AWS IoT Greengrass V2.

Returns:

  • (String, nil)

See Also:



737
738
739
 
# File 'io_t_site_wise/cfn_gateway.rb', line 737

def core_device_operating_system
  @core_device_operating_system
end

#core_device_thing_name ⇒ String (readonly)

The name of the AWS IoT thing for your AWS IoT Greengrass V2 core device.

Returns:

  • (String)

See Also:



732
733
734
 
# File 'io_t_site_wise/cfn_gateway.rb', line 732

def core_device_thing_name
  @core_device_thing_name
end

Class Method Details

.jsii_properties ⇒ Object 



739
740
741
742
743
744
 
# File 'io_t_site_wise/cfn_gateway.rb', line 739

def self.jsii_properties
  {
    :core_device_thing_name => "coreDeviceThingName",
    :core_device_operating_system => "coreDeviceOperatingSystem",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



746
747
748
749
750
751
752
753
 
# File 'io_t_site_wise/cfn_gateway.rb', line 746

def to_jsii
  result = {}
  result.merge!({
    "coreDeviceThingName" => @core_device_thing_name,
    "coreDeviceOperatingSystem" => @core_device_operating_system,
  })
  result.compact
end