fuota_tasks

Creates, updates, deletes or gets a fuota_task resource or lists fuota_tasks in a region

Overview

Name	fuota_tasks
Type	Resource
Description	Create and manage FUOTA tasks.
Id	aws.iotwireless.fuota_tasks

Fields

Name	Datatype	Description
name	string	Name of FUOTA task
description	string	FUOTA task description
lo_ra_wan	object	FUOTA task LoRaWAN
firmware_update_image	string	FUOTA task firmware update image binary S3 link
firmware_update_role	string	FUOTA task firmware IAM role for reading S3
arn	string	FUOTA task arn. Returned after successful create.
id	string	FUOTA task id. Returned after successful create.
tags	array	A list of key-value pairs that contain metadata for the FUOTA task.
fuota_task_status	string	FUOTA task status. Returned after successful read.
associate_wireless_device	string	Wireless device to associate. Only for update request.
disassociate_wireless_device	string	Wireless device to disassociate. Only for update request.
associate_multicast_group	string	Multicast group to associate. Only for update request.
disassociate_multicast_group	string	Multicast group to disassociate. Only for update request.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	LoRaWAN, FirmwareUpdateImage, FirmwareUpdateRole, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all fuota_tasks in a region.

SELECT
region,
name,
description,
lo_ra_wan,
firmware_update_image,
firmware_update_role,
arn,
id,
tags,
fuota_task_status,
associate_wireless_device,
disassociate_wireless_device,
associate_multicast_group,
disassociate_multicast_group
FROM aws.iotwireless.fuota_tasks
WHERE region = 'us-east-1';

Gets all properties from an individual fuota_task.

SELECT
region,
name,
description,
lo_ra_wan,
firmware_update_image,
firmware_update_role,
arn,
id,
tags,
fuota_task_status,
associate_wireless_device,
disassociate_wireless_device,
associate_multicast_group,
disassociate_multicast_group
FROM aws.iotwireless.fuota_tasks
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new fuota_task resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.iotwireless.fuota_tasks (
 LoRaWAN,
 FirmwareUpdateImage,
 FirmwareUpdateRole,
 region
)
SELECT 
'{{ LoRaWAN }}',
 '{{ FirmwareUpdateImage }}',
 '{{ FirmwareUpdateRole }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iotwireless.fuota_tasks (
 Name,
 Description,
 LoRaWAN,
 FirmwareUpdateImage,
 FirmwareUpdateRole,
 Tags,
 AssociateWirelessDevice,
 DisassociateWirelessDevice,
 AssociateMulticastGroup,
 DisassociateMulticastGroup,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Description }}',
 '{{ LoRaWAN }}',
 '{{ FirmwareUpdateImage }}',
 '{{ FirmwareUpdateRole }}',
 '{{ Tags }}',
 '{{ AssociateWirelessDevice }}',
 '{{ DisassociateWirelessDevice }}',
 '{{ AssociateMulticastGroup }}',
 '{{ DisassociateMulticastGroup }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: fuota_task
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Description
        value: '{{ Description }}'
      - name: LoRaWAN
        value:
          RfRegion: '{{ RfRegion }}'
          DlClass: '{{ DlClass }}'
          NumberOfDevicesRequested: '{{ NumberOfDevicesRequested }}'
          NumberOfDevicesInGroup: '{{ NumberOfDevicesInGroup }}'
      - name: FirmwareUpdateImage
        value: '{{ FirmwareUpdateImage }}'
      - name: FirmwareUpdateRole
        value: '{{ FirmwareUpdateRole }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: AssociateWirelessDevice
        value: '{{ AssociateWirelessDevice }}'
      - name: DisassociateWirelessDevice
        value: '{{ DisassociateWirelessDevice }}'
      - name: AssociateMulticastGroup
        value: '{{ AssociateMulticastGroup }}'
      - name: DisassociateMulticastGroup
        value: '{{ DisassociateMulticastGroup }}'

DELETE example

/*+ delete */
DELETE FROM aws.iotwireless.fuota_tasks
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

To operate on the fuota_tasks resource, the following permissions are required:

Create

iotwireless:CreateFuotaTask,
iotwireless:TagResource,
iotwireless:ListTagsForResource,
iam:GetRole,
iam:PassRole

Read

iotwireless:GetFuotaTask,
iotwireless:ListTagsForResource

Update

iam:PassRole,
iotwireless:UpdateFuotaTask,
iotwireless:UntagResource,
iotwireless:ListTagsForResource,
iotwireless:AssociateMulticastGroupWithFuotaTask,
iotwireless:DisassociateMulticastGroupFromFuotaTask,
iotwireless:AssociateWirelessDeviceWithFuotaTask,
iotwireless:DisassociateWirelessDeviceFromFuotaTask

Delete

iotwireless:DeleteFuotaTask

List

iotwireless:ListFuotaTasks,
iotwireless:ListTagsForResource