A multicast group.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::IoTWireless::MulticastGroup",
"Properties" : {
"AssociateWirelessDevice" : String
,
"Description" : String
,
"DisassociateWirelessDevice" : String
,
"LoRaWAN" : LoRaWAN
,
"Name" : String
,
"Tags" : [ Tag, ... ]
}
}
YAML
Type: AWS::IoTWireless::MulticastGroup
Properties:
AssociateWirelessDevice: String
Description: String
DisassociateWirelessDevice: String
LoRaWAN:
LoRaWAN
Name: String
Tags:
- Tag
Properties
AssociateWirelessDevice
-
The ID of the wireless device to associate with a multicast group.
Required: No
Type: String
Maximum:
256
Update requires: No interruption
Description
-
The description of the multicast group.
Required: No
Type: String
Maximum:
2048
Update requires: No interruption
DisassociateWirelessDevice
-
The ID of the wireless device to disassociate from a multicast group.
Required: No
Type: String
Maximum:
256
Update requires: No interruption
LoRaWAN
-
The LoRaWAN information that is to be used with the multicast group.
Required: Yes
Type: LoRaWAN
Update requires: No interruption
Name
-
The name of the multicast group.
Required: No
Type: String
Maximum:
256
Update requires: No interruption
-
The tags are an array of key-value pairs to attach to the specified resource. Tags can have a minimum of 0 and a maximum of 50 items.
Required: No
Type: Array of Tag
Maximum:
200
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the multicast group.
Fn::GetAtt
Arn
-
The ARN of the multicast group.
Id
-
The ID of the multicast group.
LoRaWAN.NumberOfDevicesInGroup
-
The number of devices that are associated to the multicast group.
LoRaWAN.NumberOfDevicesRequested
-
The number of devices that are requested to be associated with the multicast group.
Status
-
The status of a multicast group.