Class: AWSCDK::IoTWireless::CfnFuotaTask

Inherits:
CfnResource
  • Object
show all
Includes:
AWSCDK::IInspectable, AWSCDK::ITaggable, AWSCDK::Interfaces::AWSIotwireless::IFuotaTaskRef
Defined in:
io_t_wireless/cfn_fuota_task.rb

Overview

A FUOTA task.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnFuotaTask

Create a new AWS::IoTWireless::FuotaTask.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::IoTWireless::CfnFuotaTaskProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::IoTWireless::CfnFuotaTaskProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90d2lyZWxlc3MuQ2ZuRnVvdGFUYXNrUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_fuota_task(resource) ⇒ String

Parameters:

Returns:

  • (String) 


84
85
86
87
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 84

def self.arn_for_fuota_task(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pb3R3aXJlbGVzcy5JRnVvdGFUYXNrUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotwireless.CfnFuotaTask", "arnForFuotaTask", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


217
218
219
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 217

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_iotwireless.CfnFuotaTask", "CFN_RESOURCE_TYPE_NAME")
end

.from_fuota_task_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSIotwireless::IFuotaTaskRef

Creates a new IFuotaTaskRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



95
96
97
98
99
100
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 95

def self.from_fuota_task_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotwireless.CfnFuotaTask", "fromFuotaTaskArn", [scope, id, arn])
end

.from_fuota_task_id(scope, id, fuota_task_id) ⇒ AWSCDK::Interfaces::AWSIotwireless::IFuotaTaskRef

Creates a new IFuotaTaskRef from a fuotaTaskId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • fuota_task_id (String)

Returns:



108
109
110
111
112
113
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 108

def self.from_fuota_task_id(scope, id, fuota_task_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(fuota_task_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fuotaTaskId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotwireless.CfnFuotaTask", "fromFuotaTaskId", [scope, id, fuota_task_id])
end

.is_cfn_fuota_task(x) ⇒ Boolean

Checks whether the given object is a CfnFuotaTask.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


119
120
121
122
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 119

def self.is_cfn_fuota_task(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotwireless.CfnFuotaTask", "isCfnFuotaTask", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_fuota_task_status => { kind: :property, name: "attrFuotaTaskStatus", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_lo_ra_wan_start_time => { kind: :property, name: "attrLoRaWanStartTime", is_optional: false },
    :fuota_task_ref => { kind: :property, name: "fuotaTaskRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :firmware_update_image => { kind: :property, name: "firmwareUpdateImage", is_optional: false },
    :firmware_update_role => { kind: :property, name: "firmwareUpdateRole", is_optional: false },
    :lo_ra_wan => { kind: :property, name: "loRaWan", is_optional: false },
    :associate_multicast_group => { kind: :property, name: "associateMulticastGroup", is_optional: true },
    :associate_wireless_device => { kind: :property, name: "associateWirelessDevice", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :disassociate_multicast_group => { kind: :property, name: "disassociateMulticastGroup", is_optional: true },
    :disassociate_wireless_device => { kind: :property, name: "disassociateWirelessDevice", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



421
422
423
424
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 421

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



433
434
435
436
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 433

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



443
444
445
446
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 443

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



454
455
456
457
458
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 454

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


511
512
513
514
515
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 511

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



521
522
523
524
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 521

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



533
534
535
536
537
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 533

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



546
547
548
549
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 546

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



568
569
570
571
572
573
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 568

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#associate_multicast_group ⇒ String?

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

Returns:

  • (String, nil) 


303
304
305
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 303

def associate_multicast_group()
  jsii_get_property("associateMulticastGroup")
end

#associate_multicast_group=(value) ⇒ Object 



307
308
309
310
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 307

def associate_multicast_group=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "associateMulticastGroup") unless value.nil?
  jsii_set_property("associateMulticastGroup", value)
end

#associate_wireless_device ⇒ String?

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

Returns:

  • (String, nil) 


315
316
317
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 315

def associate_wireless_device()
  jsii_get_property("associateWirelessDevice")
end

#associate_wireless_device=(value) ⇒ Object 



319
320
321
322
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 319

def associate_wireless_device=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "associateWirelessDevice") unless value.nil?
  jsii_set_property("associateWirelessDevice", value)
end

#attr_arn ⇒ String

The ARN of a FUOTA task.

Returns:

  • (String) 


224
225
226
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 224

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_fuota_task_status ⇒ String

The status of a FUOTA task.

Returns:

  • (String) 


231
232
233
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 231

def attr_fuota_task_status()
  jsii_get_property("attrFuotaTaskStatus")
end

#attr_id ⇒ String

The ID of a FUOTA task.

Returns:

  • (String) 


238
239
240
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 238

def attr_id()
  jsii_get_property("attrId")
end

#attr_lo_ra_wan_start_time ⇒ String

Start time of a FUOTA task.

Returns:

  • (String) 


245
246
247
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 245

def attr_lo_ra_wan_start_time()
  jsii_get_property("attrLoRaWanStartTime")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



170
171
172
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 170

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


175
176
177
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 175

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


577
578
579
580
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 577

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


180
181
182
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 180

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


187
188
189
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 187

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


132
133
134
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 132

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of the new resource.

Returns:

  • (String, nil) 


327
328
329
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 327

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



331
332
333
334
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 331

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#disassociate_multicast_group ⇒ String?

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

Returns:

  • (String, nil) 


339
340
341
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 339

def disassociate_multicast_group()
  jsii_get_property("disassociateMulticastGroup")
end

#disassociate_multicast_group=(value) ⇒ Object 



343
344
345
346
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 343

def disassociate_multicast_group=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "disassociateMulticastGroup") unless value.nil?
  jsii_set_property("disassociateMulticastGroup", value)
end

#disassociate_wireless_device ⇒ String?

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

Returns:

  • (String, nil) 


351
352
353
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 351

def disassociate_wireless_device()
  jsii_get_property("disassociateWirelessDevice")
end

#disassociate_wireless_device=(value) ⇒ Object 



355
356
357
358
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 355

def disassociate_wireless_device=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "disassociateWirelessDevice") unless value.nil?
  jsii_set_property("disassociateWirelessDevice", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



192
193
194
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 192

def env()
  jsii_get_property("env")
end

#firmware_update_image ⇒ String

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

Returns:

  • (String) 


266
267
268
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 266

def firmware_update_image()
  jsii_get_property("firmwareUpdateImage")
end

#firmware_update_image=(value) ⇒ Object 



270
271
272
273
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 270

def firmware_update_image=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "firmwareUpdateImage")
  jsii_set_property("firmwareUpdateImage", value)
end

#firmware_update_role ⇒ String

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

Returns:

  • (String) 


278
279
280
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 278

def firmware_update_role()
  jsii_get_property("firmwareUpdateRole")
end

#firmware_update_role=(value) ⇒ Object 



282
283
284
285
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 282

def firmware_update_role=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "firmwareUpdateRole")
  jsii_set_property("firmwareUpdateRole", value)
end

#fuota_task_ref ⇒ AWSCDK::Interfaces::AWSIotwireless::FuotaTaskReference

A reference to a FuotaTask resource.

Returns:



252
253
254
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 252

def fuota_task_ref()
  jsii_get_property("fuotaTaskRef")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



590
591
592
593
594
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 590

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



601
602
603
604
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 601

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



671
672
673
674
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 671

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#lo_ra_wan ⇒ AWSCDK::IResolvable, AWSCDK::IoTWireless::CfnFuotaTask::LoRaWANProperty

The LoRaWAN information used with a FUOTA task.

Returns:



290
291
292
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 290

def lo_ra_wan()
  jsii_get_property("loRaWan")
end

#lo_ra_wan=(value) ⇒ Object 



294
295
296
297
298
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 294

def lo_ra_wan=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::IoTWireless::CfnFuotaTask::LoRaWANProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3R3aXJlbGVzcy5DZm5GdW90YVRhc2suTG9SYVdBTlByb3BlcnR5In1dfX0=")), "loRaWan")
  jsii_set_property("loRaWan", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


144
145
146
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 144

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

The name of a FUOTA task.

Returns:

  • (String, nil) 


363
364
365
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 363

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



367
368
369
370
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 367

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless value.nil?
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


127
128
129
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 127

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



612
613
614
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 612

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



619
620
621
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 619

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



412
413
414
415
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 412

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


163
164
165
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 163

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



630
631
632
633
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 630

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


637
638
639
640
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 637

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



647
648
649
650
651
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 647

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



656
657
658
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 656

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



153
154
155
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 153

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



259
260
261
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 259

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



375
376
377
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 375

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



379
380
381
382
383
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 379

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



388
389
390
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 388

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


200
201
202
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 200

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


210
211
212
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 210

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


662
663
664
665
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 662

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


401
402
403
404
405
406
 
# File 'io_t_wireless/cfn_fuota_task.rb', line 401

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end