software.amazon.awscdk.services.iotwireless

Class CfnMulticastGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iotwireless.CfnMulticastGroup

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.079Z")
 @Stability(value=Stable)
public class CfnMulticastGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTWireless::MulticastGroup`.

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();
 

Nested Class Summary

Nested Classes

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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMulticastGroup(software.constructs.Construct scope, 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)

Method Summary

Modifier and Type	Method and Description
String	getAssociateWirelessDevice() The ID of the wireless device to associate with a multicast group.
String	getAttrArn() The ARN of the multicast group.
String	getAttrId() The ID of the multicast group.
Number	getAttrLoRaWanNumberOfDevicesInGroup() The number of devices that are associated to the multicast group.
Number	getAttrLoRaWanNumberOfDevicesRequested() The number of devices that are requested to be associated with the multicast group.
String	getAttrStatus() The status of a multicast group.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the multicast group.
String	getDisassociateWirelessDevice() The ID of the wireless device to disassociate from a multicast group.
Object	getLoRaWan() The LoRaWAN information that is to be used with the multicast group.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAssociateWirelessDevice(String value) The ID of the wireless device to associate with a multicast group.
void	setDescription(String value) The description of the multicast group.
void	setDisassociateWirelessDevice(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(String value) The name of the multicast group.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnMulticastGroup

protected CfnMulticastGroup(software.amazon.jsii.JsiiObjectRef objRef)

CfnMulticastGroup

protected CfnMulticastGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnMulticastGroup

@Stability(value=Stable)
public CfnMulticastGroup(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnMulticastGroupProps props)

Create a new `AWS::IoTWireless::MulticastGroup`.

Parameters:

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.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The ARN of the multicast group.

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

The ID of the multicast group.

getAttrLoRaWanNumberOfDevicesInGroup

@Stability(value=Stable)
 @NotNull
public Number getAttrLoRaWanNumberOfDevicesInGroup()

The number of devices that are associated to the multicast group.

getAttrLoRaWanNumberOfDevicesRequested

@Stability(value=Stable)
 @NotNull
public Number getAttrLoRaWanNumberOfDevicesRequested()

The number of devices that are requested to be associated with the multicast group.

getAttrStatus

@Stability(value=Stable)
 @NotNull
public String getAttrStatus()

The status of a multicast group.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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.

getLoRaWan

@Stability(value=Stable)
 @NotNull
public Object getLoRaWan()

The LoRaWAN information that is to be used with the multicast group.

setLoRaWan

@Stability(value=Stable)
public void setLoRaWan(@NotNull
                                                CfnMulticastGroup.LoRaWANProperty value)

The LoRaWAN information that is to be used with the multicast group.

setLoRaWan

@Stability(value=Stable)
public void setLoRaWan(@NotNull
                                                IResolvable value)

The LoRaWAN information that is to be used with the multicast group.

getAssociateWirelessDevice

@Stability(value=Stable)
 @Nullable
public String getAssociateWirelessDevice()

The ID of the wireless device to associate with a multicast group.

setAssociateWirelessDevice

@Stability(value=Stable)
public void setAssociateWirelessDevice(@Nullable
                                                                String value)

The ID of the wireless device to associate with a multicast group.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of the multicast group.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the multicast group.

getDisassociateWirelessDevice

@Stability(value=Stable)
 @Nullable
public String getDisassociateWirelessDevice()

The ID of the wireless device to disassociate from a multicast group.

setDisassociateWirelessDevice

@Stability(value=Stable)
public void setDisassociateWirelessDevice(@Nullable
                                                                   String value)

The ID of the wireless device to disassociate from a multicast group.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of the multicast group.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the multicast group.