@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:37.098Z") public class CfnMulticastGroup extends CfnResource implements IInspectable
A multicast group.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.iotwireless.*; CfnMulticastGroup cfnMulticastGroup = CfnMulticastGroup.Builder.create(this, "MyCfnMulticastGroup") .loRaWan(LoRaWANProperty.builder() .dlClass("dlClass") .rfRegion("rfRegion") // the properties below are optional .numberOfDevicesInGroup(123) .numberOfDevicesRequested(123) .build()) // the properties below are optional .associateWirelessDevice("associateWirelessDevice") .description("description") .disassociateWirelessDevice("disassociateWirelessDevice") .name("name") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnMulticastGroup.Builder
A fluent builder for
CfnMulticastGroup . |
static interface |
CfnMulticastGroup.LoRaWANProperty
The LoRaWAN information that is to be used with the multicast group.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnMulticastGroup(Construct scope,
java.lang.String id,
CfnMulticastGroupProps props)
Create a new `AWS::IoTWireless::MulticastGroup`.
|
protected |
CfnMulticastGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnMulticastGroup(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAssociateWirelessDevice()
The ID of the wireless device to associate with a multicast group.
|
java.lang.String |
getAttrArn()
The ARN of the multicast group.
|
java.lang.String |
getAttrId()
The ID of the multicast group.
|
java.lang.Number |
getAttrLoRaWanNumberOfDevicesInGroup()
The number of devices that are associated to the multicast group.
|
java.lang.Number |
getAttrLoRaWanNumberOfDevicesRequested()
The number of devices that are requested to be associated with the multicast group.
|
java.lang.String |
getAttrStatus()
The status of a multicast group.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDescription()
The description of the multicast group.
|
java.lang.String |
getDisassociateWirelessDevice()
The ID of the wireless device to disassociate from a multicast group.
|
java.lang.Object |
getLoRaWan()
The LoRaWAN information that is to be used with the multicast group.
|
java.lang.String |
getName()
The name of the multicast group.
|
TagManager |
getTags()
The tags are an array of key-value pairs to attach to the specified resource.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAssociateWirelessDevice(java.lang.String value)
The ID of the wireless device to associate with a multicast group.
|
void |
setDescription(java.lang.String value)
The description of the multicast group.
|
void |
setDisassociateWirelessDevice(java.lang.String value)
The ID of the wireless device to disassociate from a multicast group.
|
void |
setLoRaWan(CfnMulticastGroup.LoRaWANProperty value)
The LoRaWAN information that is to be used with the multicast group.
|
void |
setLoRaWan(IResolvable value)
The LoRaWAN information that is to be used with the multicast group.
|
void |
setName(java.lang.String value)
The name of the multicast group.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnMulticastGroup(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnMulticastGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnMulticastGroup(Construct scope, java.lang.String id, CfnMulticastGroupProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrId()
public java.lang.Number getAttrLoRaWanNumberOfDevicesInGroup()
public java.lang.Number getAttrLoRaWanNumberOfDevicesRequested()
public java.lang.String getAttrStatus()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
Tags can have a minimum of 0 and a maximum of 50 items.
public java.lang.Object getLoRaWan()
public void setLoRaWan(IResolvable value)
public void setLoRaWan(CfnMulticastGroup.LoRaWANProperty value)
public java.lang.String getAssociateWirelessDevice()
public void setAssociateWirelessDevice(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getDisassociateWirelessDevice()
public void setDisassociateWirelessDevice(java.lang.String value)
public java.lang.String getName()
public void setName(java.lang.String value)