Package software.amazon.awscdk.services.iotwireless

Class CfnWirelessDevice

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.CfnWirelessDevice
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IWirelessDeviceRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:38.610Z") @Stability(Stable) public class CfnWirelessDevice extends CfnResource implements IInspectable, IWirelessDeviceRef, ITaggable
Provisions a wireless device.

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.*;
 CfnWirelessDevice cfnWirelessDevice = CfnWirelessDevice.Builder.create(this, "MyCfnWirelessDevice")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnWirelessDevice

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

    • CfnWirelessDevice

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

    • CfnWirelessDevice

      @Stability(Stable) public CfnWirelessDevice(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnWirelessDeviceProps props)
      Create a new AWS::IoTWireless::WirelessDevice.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForWirelessDevice

      @Stability(Stable) @NotNull public static String arnForWirelessDevice(@NotNull IWirelessDeviceRef resource)
      Parameters:
      resource - This parameter is required.

    • fromWirelessDeviceArn

      @Stability(Stable) @NotNull public static IWirelessDeviceRef fromWirelessDeviceArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IWirelessDeviceRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromWirelessDeviceId

      @Stability(Stable) @NotNull public static IWirelessDeviceRef fromWirelessDeviceId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String wirelessDeviceId)
      Creates a new IWirelessDeviceRef from a wirelessDeviceId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      wirelessDeviceId - This parameter is required.

    • isCfnWirelessDevice

      @Stability(Stable) @NotNull public static Boolean isCfnWirelessDevice(@NotNull Object x)
      Checks whether the given object is a CfnWirelessDevice.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The ARN of the wireless device created.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the wireless device created.

    • getAttrThingName

      @Stability(Stable) @NotNull public String getAttrThingName()
      The name of the thing associated with the wireless device.

      The value is empty if a thing isn't associated with the device.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getWirelessDeviceRef

      @Stability(Stable) @NotNull public WirelessDeviceReference getWirelessDeviceRef()
      A reference to a WirelessDevice resource.
      Specified by:
      getWirelessDeviceRef in interface IWirelessDeviceRef

    • getDestinationName

      @Stability(Stable) @NotNull public String getDestinationName()
      The name of the destination to assign to the new wireless device.

    • setDestinationName

      @Stability(Stable) public void setDestinationName(@NotNull String value)
      The name of the destination to assign to the new wireless device.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The wireless device type.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The wireless device type.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the new resource.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the new resource.

    • getLastUplinkReceivedAt

      @Stability(Stable) @Nullable public String getLastUplinkReceivedAt()
      The date and time when the most recent uplink was received.

    • setLastUplinkReceivedAt

      @Stability(Stable) public void setLastUplinkReceivedAt(@Nullable String value)
      The date and time when the most recent uplink was received.

    • getLoRaWan

      @Stability(Stable) @Nullable public Object getLoRaWan()
      The device configuration information to use to create the wireless device.

      Returns union: either IResolvable or CfnWirelessDevice.LoRaWANDeviceProperty

    • setLoRaWan

      @Stability(Stable) public void setLoRaWan(@Nullable IResolvable value)
      The device configuration information to use to create the wireless device.

    • setLoRaWan

      @Stability(Stable) public void setLoRaWan(@Nullable CfnWirelessDevice.LoRaWANDeviceProperty value)
      The device configuration information to use to create the wireless device.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the new resource.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the new resource.

    • getPositioning

      @Stability(Stable) @Nullable public String getPositioning()
      FPort values for the GNSS, Stream, and ClockSync functions of the positioning information.

    • setPositioning

      @Stability(Stable) public void setPositioning(@Nullable String value)
      FPort values for the GNSS, Stream, and ClockSync functions of the positioning information.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags are an array of key-value pairs to attach to the specified resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags are an array of key-value pairs to attach to the specified resource.

    • getThingArn

      @Stability(Stable) @Nullable public String getThingArn()
      The ARN of the thing to associate with the wireless device.

    • setThingArn

      @Stability(Stable) public void setThingArn(@Nullable String value)
      The ARN of the thing to associate with the wireless device.