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	awscc.iotwireless.multicast_groups

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string	Multicast group id. Returned after successful create.
region	string	AWS region.

For more information, see AWS::IoTWireless::MulticastGroup.

Methods

Name	Resource	Accessible by	Required Params
create_resource	multicast_groups	INSERT	LoRaWAN, region
delete_resource	multicast_groups	DELETE	Identifier, region
update_resource	multicast_groups	UPDATE	Identifier, PatchDocument, region
list_resources	multicast_groups_list_only	SELECT	region
get_resource	multicast_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.iotwireless.multicast_groups
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all multicast_groups in a region.

SELECT
  region,
  id
FROM awscc.iotwireless.multicast_groups_list_only
WHERE
  region = '{{ region }}';

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 awscc.iotwireless.multicast_groups (
  LoRaWAN,
  region
)
SELECT
  '{{ lo_ra_wan }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.iotwireless.multicast_groups (
  Name,
  Description,
  LoRaWAN,
  Tags,
  AssociateWirelessDevice,
  DisassociateWirelessDevice,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ lo_ra_wan }}',
  '{{ tags }}',
  '{{ associate_wireless_device }}',
  '{{ disassociate_wireless_device }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: lo_ra_wan
      value:
        rf_region: '{{ rf_region }}'
        dl_class: '{{ dl_class }}'
        number_of_devices_requested: '{{ number_of_devices_requested }}'
        number_of_devices_in_group: '{{ number_of_devices_in_group }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: associate_wireless_device
      value: '{{ associate_wireless_device }}'
    - name: disassociate_wireless_device
      value: '{{ disassociate_wireless_device }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iotwireless.multicast_groups
SET PatchDocument = string('{{ {
    "Name": name,
    "Description": description,
    "Tags": tags,
    "AssociateWirelessDevice": associate_wireless_device,
    "DisassociateWirelessDevice": disassociate_wireless_device
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.iotwireless.multicast_groups
WHERE
  Identifier = '{{ id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

iotwireless:CreateMulticastGroup,
iotwireless:TagResource

Read

iotwireless:GetMulticastGroup,
iotwireless:ListTagsForResource

Update

iotwireless:UpdateMulticastGroup,
iotwireless:GetMulticastGroup,
iotwireless:TagResource,
iotwireless:UntagResource,
iotwireless:AssociateWirelessDeviceWithMulticastGroup,
iotwireless:DisassociateWirelessDeviceFromMulticastGroup

Delete

iotwireless:DeleteMulticastGroup

List

iotwireless:ListMulticastGroups,
iotwireless:ListTagsForResource