Class: AWSCDK::Greengrass::CfnDeviceDefinitionVersion::DeviceProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
greengrass/cfn_device_definition_version.rb

Overview

A device is an AWS IoT device (thing) that's added to a Greengrass group.

Greengrass devices can communicate with the Greengrass core in the same group. For more information, see What Is AWS IoT Greengrass ? in the Developer Guide .

In an CloudFormation template, the Devices property of the AWS::Greengrass::DeviceDefinitionVersion resource contains a list of Device property types.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(certificate_arn:, id:, thing_arn:, sync_shadow: nil) ⇒ DeviceProperty

Returns a new instance of DeviceProperty.

Parameters:

  • certificate_arn (String) —

    The ARN of the device certificate for the device.

  • id (String) —

    A descriptive or arbitrary ID for the device.

  • thing_arn (String) —

    The Amazon Resource Name (ARN) of the device, which is an AWS IoT device (thing).

  • sync_shadow (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Indicates whether the device's local shadow is synced with the cloud automatically.



524
525
526
527
528
529
530
531
532
533
 
# File 'greengrass/cfn_device_definition_version.rb', line 524

def initialize(certificate_arn:, id:, thing_arn:, sync_shadow: nil)
  @certificate_arn = certificate_arn
  Jsii::Type.check_type(@certificate_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificateArn")
  @id = id
  Jsii::Type.check_type(@id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  @thing_arn = thing_arn
  Jsii::Type.check_type(@thing_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "thingArn")
  @sync_shadow = sync_shadow
  Jsii::Type.check_type(@sync_shadow, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "syncShadow") unless @sync_shadow.nil?
end

Instance Attribute Details

#certificate_arn ⇒ String (readonly)

The ARN of the device certificate for the device.

This X.509 certificate is used to authenticate the device with AWS IoT and AWS IoT Greengrass services.

Returns:

  • (String)

See Also:



541
542
543
 
# File 'greengrass/cfn_device_definition_version.rb', line 541

def certificate_arn
  @certificate_arn
end

#id ⇒ String (readonly)

A descriptive or arbitrary ID for the device.

This value must be unique within the device definition version. Maximum length is 128 characters with pattern [a-zA-Z0-9:_-]+ .

Returns:

  • (String)

See Also:



548
549
550
 
# File 'greengrass/cfn_device_definition_version.rb', line 548

def id
  @id
end

#sync_shadow ⇒ Boolean, ... (readonly)

Indicates whether the device's local shadow is synced with the cloud automatically.

Returns:

See Also:



558
559
560
 
# File 'greengrass/cfn_device_definition_version.rb', line 558

def sync_shadow
  @sync_shadow
end

#thing_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the device, which is an AWS IoT device (thing).

Returns:

  • (String)

See Also:



553
554
555
 
# File 'greengrass/cfn_device_definition_version.rb', line 553

def thing_arn
  @thing_arn
end

Class Method Details

.jsii_properties ⇒ Object 



560
561
562
563
564
565
566
567
 
# File 'greengrass/cfn_device_definition_version.rb', line 560

def self.jsii_properties
  {
    :certificate_arn => "certificateArn",
    :id => "id",
    :thing_arn => "thingArn",
    :sync_shadow => "syncShadow",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



569
570
571
572
573
574
575
576
577
578
 
# File 'greengrass/cfn_device_definition_version.rb', line 569

def to_jsii
  result = {}
  result.merge!({
    "certificateArn" => @certificate_arn,
    "id" => @id,
    "thingArn" => @thing_arn,
    "syncShadow" => @sync_shadow,
  })
  result.compact
end