Package software.amazon.awscdk.services.iotwireless

Interface CfnMulticastGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMulticastGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:08.678Z")
@Stability(Stable)
public interface CfnMulticastGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnMulticastGroup.

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.*;
 CfnMulticastGroupProps cfnMulticastGroupProps = CfnMulticastGroupProps.builder()
         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMulticastGroupProps.Builder	A builder for CfnMulticastGroupProps
static final class	CfnMulticastGroupProps.Jsii$Proxy	An implementation for CfnMulticastGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnMulticastGroupProps.Builder	builder()
default String	getAssociateWirelessDevice()	The ID of the wireless device to associate with a multicast group.
default String	getDescription()	The description of the multicast group.
default 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.
default String	getName()	The name of the multicast group.
default List<CfnTag>	getTags()	The tags are an array of key-value pairs to attach to the specified resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLoRaWan

@Stability(Stable)
@NotNull
Object getLoRaWan()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html#cfn-iotwireless-multicastgroup-lorawan

getAssociateWirelessDevice

@Stability(Stable)
@Nullable
default String getAssociateWirelessDevice()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html#cfn-iotwireless-multicastgroup-associatewirelessdevice

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the multicast group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html#cfn-iotwireless-multicastgroup-description

getDisassociateWirelessDevice

@Stability(Stable)
@Nullable
default String getDisassociateWirelessDevice()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html#cfn-iotwireless-multicastgroup-disassociatewirelessdevice

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the multicast group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html#cfn-iotwireless-multicastgroup-name

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-multicastgroup.html#cfn-iotwireless-multicastgroup-tags

builder

@Stability(Stable)
static CfnMulticastGroupProps.Builder builder()

Returns:

a CfnMulticastGroupProps.Builder of CfnMulticastGroupProps