Package software.amazon.awscdk.services.iotwireless

Interface CfnWirelessDeviceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWirelessDeviceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-27T17:02:03.676Z")
@Stability(Stable)
public interface CfnWirelessDeviceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnWirelessDevice.

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.*;
 CfnWirelessDeviceProps cfnWirelessDeviceProps = CfnWirelessDeviceProps.builder()
         .destinationName("destinationName")
         .type("type")
         // the properties below are optional
         .description("description")
         .lastUplinkReceivedAt("lastUplinkReceivedAt")
         .loRaWan(LoRaWANDeviceProperty.builder()
                 .abpV10X(AbpV10xProperty.builder()
                         .devAddr("devAddr")
                         .sessionKeys(SessionKeysAbpV10xProperty.builder()
                                 .appSKey("appSKey")
                                 .nwkSKey("nwkSKey")
                                 .build())
                         .build())
                 .abpV11(AbpV11Property.builder()
                         .devAddr("devAddr")
                         .sessionKeys(SessionKeysAbpV11Property.builder()
                                 .appSKey("appSKey")
                                 .fNwkSIntKey("fNwkSIntKey")
                                 .nwkSEncKey("nwkSEncKey")
                                 .sNwkSIntKey("sNwkSIntKey")
                                 .build())
                         .build())
                 .devEui("devEui")
                 .deviceProfileId("deviceProfileId")
                 .fPorts(FPortsProperty.builder()
                         .applications(List.of(ApplicationProperty.builder()
                                 .destinationName("destinationName")
                                 .fPort(123)
                                 .type("type")
                                 .build()))
                         .build())
                 .otaaV10X(OtaaV10xProperty.builder()
                         .appEui("appEui")
                         .appKey("appKey")
                         .build())
                 .otaaV11(OtaaV11Property.builder()
                         .appKey("appKey")
                         .joinEui("joinEui")
                         .nwkKey("nwkKey")
                         .build())
                 .serviceProfileId("serviceProfileId")
                 .build())
         .name("name")
         .positioning("positioning")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .thingArn("thingArn")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnWirelessDeviceProps.Builder	builder()
default String	getDescription()	The description of the new resource.
String	getDestinationName()	The name of the destination to assign to the new wireless device.
default String	getLastUplinkReceivedAt()	The date and time when the most recent uplink was received.
default Object	getLoRaWan()	The device configuration information to use to create the wireless device.
default String	getName()	The name of the new resource.
default String	getPositioning()	FPort values for the GNSS, Stream, and ClockSync functions of the positioning information.
default List<CfnTag>	getTags()	The tags are an array of key-value pairs to attach to the specified resource.
default String	getThingArn()	The ARN of the thing to associate with the wireless device.
String	getType()	The wireless device type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestinationName

@Stability(Stable)
@NotNull
String getDestinationName()

The name of the destination to assign to the new wireless device.

Can have only have alphanumeric, - (hyphen) and _ (underscore) characters and it can't have any spaces.

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

The wireless device type.

See Also:

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

getDescription

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

The description of the new resource.

Maximum length is 2048.

See Also:

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

getLastUplinkReceivedAt

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

The date and time when the most recent uplink was received.

See Also:

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

getLoRaWan

@Stability(Stable)
@Nullable
default Object getLoRaWan()

The device configuration information to use to create the wireless device.

Must be at least one of OtaaV10x, OtaaV11, AbpV11, or AbpV10x.

See Also:

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

getName

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

The name of the new resource.

See Also:

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

getPositioning

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

FPort values for the GNSS, Stream, and ClockSync functions of the positioning information.

See Also:

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

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-wirelessdevice.html#cfn-iotwireless-wirelessdevice-tags

getThingArn

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

The ARN of the thing to associate with the wireless device.

See Also:

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

builder

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

Returns:

a CfnWirelessDeviceProps.Builder of CfnWirelessDeviceProps