Package software.amazon.awscdk.services.iotwireless

Class CfnWirelessDevice

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iotwireless.CfnWirelessDevice
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:58.013Z") @Stability(Stable) public class CfnWirelessDevice extends CfnResource implements IInspectable
A CloudFormation AWS::IoTWireless::WirelessDevice.

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")
                 .otaaV10X(OtaaV10xProperty.builder()
                         .appEui("appEui")
                         .appKey("appKey")
                         .build())
                 .otaaV11(OtaaV11Property.builder()
                         .appKey("appKey")
                         .joinEui("joinEui")
                         .nwkKey("nwkKey")
                         .build())
                 .serviceProfileId("serviceProfileId")
                 .build())
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .thingArn("thingArn")
         .build();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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()
      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.

    • getDestinationName

      @Stability(Stable) @NotNull public 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.

    • setDestinationName

      @Stability(Stable) public void setDestinationName(@NotNull String value)
      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.

    • 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.

      Maximum length is 2048.

    • setDescription

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

      Maximum length is 2048.

    • 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.

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

    • setLoRaWan

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

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

    • setLoRaWan

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

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

    • 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.

    • 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.