Class: AWSCDK::IoTWireless::CfnFuotaTaskProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_wireless/cfn_fuota_task_props.rb

Overview

Properties for defining a CfnFuotaTask.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(firmware_update_image:, firmware_update_role:, lo_ra_wan:, associate_multicast_group: nil, associate_wireless_device: nil, description: nil, disassociate_multicast_group: nil, disassociate_wireless_device: nil, name: nil, tags: nil) ⇒ CfnFuotaTaskProps

Returns a new instance of CfnFuotaTaskProps.

Parameters:

  • firmware_update_image (String) —

    The S3 URI points to a firmware update image that is to be used with a FUOTA task.

  • firmware_update_role (String) —

    The firmware update role that is to be used with a FUOTA task.

  • lo_ra_wan (AWSCDK::IResolvable, AWSCDK::IoTWireless::CfnFuotaTask::LoRaWANProperty) —

    The LoRaWAN information used with a FUOTA task.

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

    The ID of the multicast group to associate with a FUOTA task.

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

    The ID of the wireless device to associate with a multicast group.

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

    The description of the new resource.

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

    The ID of the multicast group to disassociate from a FUOTA task.

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

    The ID of the wireless device to disassociate from a FUOTA task.

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

    The name of a FUOTA task.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    The tags are an array of key-value pairs to attach to the specified resource.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'io_t_wireless/cfn_fuota_task_props.rb', line 19

def initialize(firmware_update_image:, firmware_update_role:, lo_ra_wan:, associate_multicast_group: nil, associate_wireless_device: nil, description: nil, disassociate_multicast_group: nil, disassociate_wireless_device: nil, name: nil, tags: nil)
  @firmware_update_image = firmware_update_image
  Jsii::Type.check_type(@firmware_update_image, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "firmwareUpdateImage")
  @firmware_update_role = firmware_update_role
  Jsii::Type.check_type(@firmware_update_role, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "firmwareUpdateRole")
  @lo_ra_wan = lo_ra_wan.is_a?(Hash) ? ::AWSCDK::IoTWireless::CfnFuotaTask::LoRaWANProperty.new(**lo_ra_wan.transform_keys(&:to_sym)) : lo_ra_wan
  Jsii::Type.check_type(@lo_ra_wan, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3R3aXJlbGVzcy5DZm5GdW90YVRhc2suTG9SYVdBTlByb3BlcnR5In1dfX0=")), "loRaWan")
  @associate_multicast_group = associate_multicast_group
  Jsii::Type.check_type(@associate_multicast_group, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "associateMulticastGroup") unless @associate_multicast_group.nil?
  @associate_wireless_device = associate_wireless_device
  Jsii::Type.check_type(@associate_wireless_device, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "associateWirelessDevice") unless @associate_wireless_device.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @disassociate_multicast_group = disassociate_multicast_group
  Jsii::Type.check_type(@disassociate_multicast_group, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "disassociateMulticastGroup") unless @disassociate_multicast_group.nil?
  @disassociate_wireless_device = disassociate_wireless_device
  Jsii::Type.check_type(@disassociate_wireless_device, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "disassociateWirelessDevice") unless @disassociate_wireless_device.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#associate_multicast_group ⇒ String? (readonly)

The ID of the multicast group to associate with a FUOTA task.

Returns:

  • (String, nil)

See Also:



61
62
63
 
# File 'io_t_wireless/cfn_fuota_task_props.rb', line 61

def associate_multicast_group
  @associate_multicast_group
end

#associate_wireless_device ⇒ String? (readonly)

The ID of the wireless device to associate with a multicast group.

Returns:

  • (String, nil)

See Also:



66
67
68
 
# File 'io_t_wireless/cfn_fuota_task_props.rb', line 66

def associate_wireless_device
  @associate_wireless_device
end

#description ⇒ String? (readonly)

The description of the new resource.

Returns:

  • (String, nil)

See Also:



71
72
73
 
# File 'io_t_wireless/cfn_fuota_task_props.rb', line 71

def description
  @description
end

#disassociate_multicast_group ⇒ String? (readonly)

The ID of the multicast group to disassociate from a FUOTA task.

Returns:

  • (String, nil)

See Also:



76
77
78
 
# File 'io_t_wireless/cfn_fuota_task_props.rb', line 76

def disassociate_multicast_group
  @disassociate_multicast_group
end

#disassociate_wireless_device ⇒ String? (readonly)

The ID of the wireless device to disassociate from a FUOTA task.

Returns:

  • (String, nil)

See Also:



81
82
83
 
# File 'io_t_wireless/cfn_fuota_task_props.rb', line 81

def disassociate_wireless_device
  @disassociate_wireless_device
end

#firmware_update_image ⇒ String (readonly)

The S3 URI points to a firmware update image that is to be used with a FUOTA task.

Returns:

  • (String)

See Also:



46
47
48
 
# File 'io_t_wireless/cfn_fuota_task_props.rb', line 46

def firmware_update_image
  @firmware_update_image
end

#firmware_update_role ⇒ String (readonly)

The firmware update role that is to be used with a FUOTA task.

Returns:

  • (String)

See Also:



51
52
53
 
# File 'io_t_wireless/cfn_fuota_task_props.rb', line 51

def firmware_update_role
  @firmware_update_role
end

#lo_ra_wan ⇒ AWSCDK::IResolvable, AWSCDK::IoTWireless::CfnFuotaTask::LoRaWANProperty (readonly)

The LoRaWAN information used with a FUOTA task.

Returns:

See Also:



56
57
58
 
# File 'io_t_wireless/cfn_fuota_task_props.rb', line 56

def lo_ra_wan
  @lo_ra_wan
end

#name ⇒ String? (readonly)

The name of a FUOTA task.

Returns:

  • (String, nil)

See Also:



86
87
88
 
# File 'io_t_wireless/cfn_fuota_task_props.rb', line 86

def name
  @name
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

The tags are an array of key-value pairs to attach to the specified resource.

Tags can have a minimum of 0 and a maximum of 50 items.

Returns:

See Also:



93
94
95
 
# File 'io_t_wireless/cfn_fuota_task_props.rb', line 93

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'io_t_wireless/cfn_fuota_task_props.rb', line 95

def self.jsii_properties
  {
    :firmware_update_image => "firmwareUpdateImage",
    :firmware_update_role => "firmwareUpdateRole",
    :lo_ra_wan => "loRaWan",
    :associate_multicast_group => "associateMulticastGroup",
    :associate_wireless_device => "associateWirelessDevice",
    :description => "description",
    :disassociate_multicast_group => "disassociateMulticastGroup",
    :disassociate_wireless_device => "disassociateWirelessDevice",
    :name => "name",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'io_t_wireless/cfn_fuota_task_props.rb', line 110

def to_jsii
  result = {}
  result.merge!({
    "firmwareUpdateImage" => @firmware_update_image,
    "firmwareUpdateRole" => @firmware_update_role,
    "loRaWan" => @lo_ra_wan,
    "associateMulticastGroup" => @associate_multicast_group,
    "associateWirelessDevice" => @associate_wireless_device,
    "description" => @description,
    "disassociateMulticastGroup" => @disassociate_multicast_group,
    "disassociateWirelessDevice" => @disassociate_wireless_device,
    "name" => @name,
    "tags" => @tags,
  })
  result.compact
end