multicast_groups

Creates, updates, deletes or gets a multicast_group resource or lists multicast_groups in a region

Overview

Name	multicast_groups
Type	Resource
Description	Create and manage Multicast groups.
Id	aws.iotwireless.multicast_groups

Fields

Name	Datatype	Description
name	string	Name of Multicast group
description	string	Multicast group description
lo_ra_wan	object	Multicast group LoRaWAN
arn	string	Multicast group arn. Returned after successful create.
id	string	Multicast group id. Returned after successful create.
tags	array	A list of key-value pairs that contain metadata for the Multicast group.
status	string	Multicast group 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.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	LoRaWAN, 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 multicast_groups in a region.

SELECT
region,
name,
description,
lo_ra_wan,
arn,
id,
tags,
status,
associate_wireless_device,
disassociate_wireless_device
FROM aws.iotwireless.multicast_groups
WHERE region = 'us-east-1';

Gets all properties from an individual multicast_group.

SELECT
region,
name,
description,
lo_ra_wan,
arn,
id,
tags,
status,
associate_wireless_device,
disassociate_wireless_device
FROM aws.iotwireless.multicast_groups
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

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

Required Properties

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

All Properties

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

Manifest

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

DELETE example

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

Permissions

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

Create

iotwireless:CreateMulticastGroup,
iotwireless:TagResource,
iotwireless:ListTagsForResource

Read

iotwireless:GetMulticastGroup,
iotwireless:ListTagsForResource

Update

iotwireless:UpdateMulticastGroup,
iotwireless:UntagResource,
iotwireless:ListTagsForResource,
iotwireless:AssociateWirelessDeviceWithMulticastGroup,
iotwireless:DisassociateWirelessDeviceFromMulticastGroup

Delete

iotwireless:DeleteMulticastGroup

List

iotwireless:ListMulticastGroups,
iotwireless:ListTagsForResource