Class CfnMulticastGroup
A CloudFormation AWS::IoTWireless::MulticastGroup
.
Inherited Members
Namespace: Amazon.CDK.AWS.IoTWireless
Assembly: Amazon.CDK.AWS.IoTWireless.dll
Syntax (csharp)
public class CfnMulticastGroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnMulticastGroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
A multicast group.
CloudformationResource: AWS::IoTWireless::MulticastGroup
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTWireless;
var cfnMulticastGroup = new CfnMulticastGroup(this, "MyCfnMulticastGroup", new CfnMulticastGroupProps {
LoRaWan = new LoRaWANProperty {
DlClass = "dlClass",
RfRegion = "rfRegion",
// the properties below are optional
NumberOfDevicesInGroup = 123,
NumberOfDevicesRequested = 123
},
// the properties below are optional
AssociateWirelessDevice = "associateWirelessDevice",
Description = "description",
DisassociateWirelessDevice = "disassociateWirelessDevice",
Name = "name",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnMulticastGroup(Construct, String, ICfnMulticastGroupProps) | Create a new |
CfnMulticastGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnMulticastGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AssociateWirelessDevice | The ID of the wireless device to associate with a multicast group. |
AttrArn | The ARN of the multicast group. |
AttrId | The ID of the multicast group. |
AttrLoRaWanNumberOfDevicesInGroup | The number of devices that are associated to the multicast group. |
AttrLoRaWanNumberOfDevicesRequested | The number of devices that are requested to be associated with the multicast group. |
AttrStatus | The status of a multicast group. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The description of the multicast group. |
DisassociateWirelessDevice | The ID of the wireless device to disassociate from a multicast group. |
LoRaWan | The LoRaWAN information that is to be used with the multicast group. |
Name | The name of the multicast group. |
Tags | The tags are an array of key-value pairs to attach to the specified resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnMulticastGroup(Construct, String, ICfnMulticastGroupProps)
Create a new AWS::IoTWireless::MulticastGroup
.
public CfnMulticastGroup(Construct scope, string id, ICfnMulticastGroupProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnMulticastGroupProps
- resource properties.
CfnMulticastGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnMulticastGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnMulticastGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnMulticastGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AssociateWirelessDevice
The ID of the wireless device to associate with a multicast group.
public virtual string AssociateWirelessDevice { get; set; }
Property Value
System.String
Remarks
AttrArn
The ARN of the multicast group.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrId
The ID of the multicast group.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrLoRaWanNumberOfDevicesInGroup
The number of devices that are associated to the multicast group.
public virtual double AttrLoRaWanNumberOfDevicesInGroup { get; }
Property Value
System.Double
Remarks
CloudformationAttribute: LoRaWAN.NumberOfDevicesInGroup
AttrLoRaWanNumberOfDevicesRequested
The number of devices that are requested to be associated with the multicast group.
public virtual double AttrLoRaWanNumberOfDevicesRequested { get; }
Property Value
System.Double
Remarks
CloudformationAttribute: LoRaWAN.NumberOfDevicesRequested
AttrStatus
The status of a multicast group.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Status
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
The description of the multicast group.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
DisassociateWirelessDevice
The ID of the wireless device to disassociate from a multicast group.
public virtual string DisassociateWirelessDevice { get; set; }
Property Value
System.String
Remarks
LoRaWan
The LoRaWAN information that is to be used with the multicast group.
public virtual object LoRaWan { get; set; }
Property Value
System.Object
Remarks
Name
The name of the multicast group.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Tags
The tags are an array of key-value pairs to attach to the specified resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
Tags can have a minimum of 0 and a maximum of 50 items.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>