Class: AWSCDK::IoTWireless::CfnWirelessDeviceImportTask

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

Overview

Information about an import task for wireless devices.

When creating the resource, either create a single wireless device import task using the Sidewalk manufacturing serial number (SMSN) of the wireless device, or create an import task for multiple devices by specifying both the DeviceCreationFile and the Role .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnWirelessDeviceImportTask

Create a new AWS::IoTWireless::WirelessDeviceImportTask.

Parameters:



20
21
22
23
24
25
26
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::IoTWireless::CfnWirelessDeviceImportTaskProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90d2lyZWxlc3MuQ2ZuV2lyZWxlc3NEZXZpY2VJbXBvcnRUYXNrUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_wireless_device_import_task(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_wireless_device_import_task(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pb3R3aXJlbGVzcy5JV2lyZWxlc3NEZXZpY2VJbXBvcnRUYXNrUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotwireless.CfnWirelessDeviceImportTask", "arnForWirelessDeviceImportTask", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


218
219
220
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 218

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

.from_wireless_device_import_task_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSIotwireless::IWirelessDeviceImportTaskRef

Creates a new IWirelessDeviceImportTaskRef from an ARN.

Parameters:

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

Returns:



96
97
98
99
100
101
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 96

def self.from_wireless_device_import_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.CfnWirelessDeviceImportTask", "fromWirelessDeviceImportTaskArn", [scope, id, arn])
end

.from_wireless_device_import_task_id(scope, id, wireless_device_import_task_id) ⇒ AWSCDK::Interfaces::AWSIotwireless::IWirelessDeviceImportTaskRef

Creates a new IWirelessDeviceImportTaskRef from a wirelessDeviceImportTaskId.

Parameters:

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

Returns:



109
110
111
112
113
114
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 109

def self.from_wireless_device_import_task_id(scope, id, wireless_device_import_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(wireless_device_import_task_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "wirelessDeviceImportTaskId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotwireless.CfnWirelessDeviceImportTask", "fromWirelessDeviceImportTaskId", [scope, id, wireless_device_import_task_id])
end

.is_cfn_wireless_device_import_task(x) ⇒ Boolean

Checks whether the given object is a CfnWirelessDeviceImportTask.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


120
121
122
123
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 120

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

.jsii_overridable_methods ⇒ Object 



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
81
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 28

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_creation_date => { kind: :property, name: "attrCreationDate", is_optional: false },
    :attr_failed_imported_devices_count => { kind: :property, name: "attrFailedImportedDevicesCount", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_initialized_imported_devices_count => { kind: :property, name: "attrInitializedImportedDevicesCount", is_optional: false },
    :attr_onboarded_imported_devices_count => { kind: :property, name: "attrOnboardedImportedDevicesCount", is_optional: false },
    :attr_pending_imported_devices_count => { kind: :property, name: "attrPendingImportedDevicesCount", is_optional: false },
    :attr_sidewalk_device_creation_file_list => { kind: :property, name: "attrSidewalkDeviceCreationFileList", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_status_reason => { kind: :property, name: "attrStatusReason", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :wireless_device_import_task_ref => { kind: :property, name: "wirelessDeviceImportTaskRef", is_optional: false },
    :destination_name => { kind: :property, name: "destinationName", is_optional: false },
    :sidewalk => { kind: :property, name: "sidewalk", is_optional: false },
    :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.



382
383
384
385
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 382

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:



394
395
396
397
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 394

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:



404
405
406
407
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 404

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:



415
416
417
418
419
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 415

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.


472
473
474
475
476
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 472

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.



482
483
484
485
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 482

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.



494
495
496
497
498
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 494

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:



507
508
509
510
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 507

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:



529
530
531
532
533
534
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 529

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

#attr_arn ⇒ String

The ARN (Amazon Resource Name) of the import task.

Returns:

  • (String) 


225
226
227
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 225

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_creation_date ⇒ String

The date and time at which the wireless device import task was created.

Returns:

  • (String) 


232
233
234
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 232

def attr_creation_date()
  jsii_get_property("attrCreationDate")
end

#attr_failed_imported_devices_count ⇒ Numeric

The summary information of count of wireless devices that failed to onboard to the import task.

Returns:

  • (Numeric) 


239
240
241
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 239

def attr_failed_imported_devices_count()
  jsii_get_property("attrFailedImportedDevicesCount")
end

#attr_id ⇒ String

The import task ID.

Returns:

  • (String) 


246
247
248
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 246

def attr_id()
  jsii_get_property("attrId")
end

#attr_initialized_imported_devices_count ⇒ Numeric

The summary information of count of wireless devices that are waiting for the control log to be added to an import task.

Returns:

  • (Numeric) 


253
254
255
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 253

def attr_initialized_imported_devices_count()
  jsii_get_property("attrInitializedImportedDevicesCount")
end

#attr_onboarded_imported_devices_count ⇒ Numeric

The summary information of count of wireless devices that have been onboarded to the import task.

Returns:

  • (Numeric) 


260
261
262
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 260

def attr_onboarded_imported_devices_count()
  jsii_get_property("attrOnboardedImportedDevicesCount")
end

#attr_pending_imported_devices_count ⇒ Numeric

The summary information of count of wireless devices that are waiting in the queue to be onboarded to the import task.

Returns:

  • (Numeric) 


267
268
269
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 267

def attr_pending_imported_devices_count()
  jsii_get_property("attrPendingImportedDevicesCount")
end

#attr_sidewalk_device_creation_file_list ⇒ Array<String>

List of Sidewalk devices that are added to the import task.

Returns:

  • (Array<String>) 


274
275
276
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 274

def attr_sidewalk_device_creation_file_list()
  jsii_get_property("attrSidewalkDeviceCreationFileList")
end

#attr_status ⇒ String

The status of a wireless device import task.

The status can be INITIALIZING , INITIALIZED , PENDING , COMPLETE , FAILED , or DELETING .

Returns:

  • (String) 


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

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_status_reason ⇒ String

The reason that provides additional information about the import task status.

Returns:

  • (String) 


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

def attr_status_reason()
  jsii_get_property("attrStatusReason")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



171
172
173
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 171

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


176
177
178
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 176

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


538
539
540
541
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 538

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}) 


181
182
183
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 181

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


188
189
190
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 188

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


133
134
135
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 133

def creation_stack()
  jsii_get_property("creationStack")
end

#destination_name ⇒ String

The name of the destination that describes the IoT rule to route messages from the Sidewalk devices in the import task to other applications.

Returns:

  • (String) 


311
312
313
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 311

def destination_name()
  jsii_get_property("destinationName")
end

#destination_name=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



193
194
195
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 193

def env()
  jsii_get_property("env")
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:



551
552
553
554
555
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 551

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:



562
563
564
565
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 562

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:



632
633
634
635
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 632

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


145
146
147
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 145

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


128
129
130
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 128

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:



573
574
575
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 573

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:



580
581
582
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 580

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.



373
374
375
376
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 373

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) 


164
165
166
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 164

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:



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

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}) 


598
599
600
601
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 598

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:



608
609
610
611
612
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 608

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.



617
618
619
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 617

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

#sidewalk ⇒ AWSCDK::IResolvable, AWSCDK::IoTWireless::CfnWirelessDeviceImportTask::SidewalkProperty

The Sidewalk-related information of the wireless device import task.

Returns:



323
324
325
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 323

def sidewalk()
  jsii_get_property("sidewalk")
end

#sidewalk=(value) ⇒ Object 



327
328
329
330
331
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 327

def sidewalk=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::IoTWireless::CfnWirelessDeviceImportTask::SidewalkProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3R3aXJlbGVzcy5DZm5XaXJlbGVzc0RldmljZUltcG9ydFRhc2suU2lkZXdhbGtQcm9wZXJ0eSJ9XX19")), "sidewalk")
  jsii_set_property("sidewalk", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



154
155
156
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 154

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



297
298
299
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 297

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Adds to or modifies the tags of the given resource.

Returns:



336
337
338
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 336

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



340
341
342
343
344
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 340

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



349
350
351
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 349

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}) 


201
202
203
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 201

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}) 


211
212
213
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 211

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


623
624
625
626
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 623

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

#wireless_device_import_task_ref ⇒ AWSCDK::Interfaces::AWSIotwireless::WirelessDeviceImportTaskReference

A reference to a WirelessDeviceImportTask resource.

Returns:



304
305
306
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 304

def wireless_device_import_task_ref()
  jsii_get_property("wirelessDeviceImportTaskRef")
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) 


362
363
364
365
366
367
 
# File 'io_t_wireless/cfn_wireless_device_import_task.rb', line 362

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