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:

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-19T23:08:46.546Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnWirelessDevice.AbpV10xProperty ABP device object for LoRaWAN specification v1.0.x.
static interface	CfnWirelessDevice.AbpV11Property ABP device object for create APIs for v1.1.
static class	CfnWirelessDevice.Builder A fluent builder for CfnWirelessDevice.
static interface	CfnWirelessDevice.LoRaWANDeviceProperty LoRaWAN object for create functions.
static interface	CfnWirelessDevice.OtaaV10xProperty OTAA device object for create APIs for v1.0.x.
static interface	CfnWirelessDevice.OtaaV11Property OTAA device object for v1.1 for create APIs.
static interface	CfnWirelessDevice.SessionKeysAbpV10xProperty LoRaWAN object for create APIs.
static interface	CfnWirelessDevice.SessionKeysAbpV11Property Session keys for ABP v1.1.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

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
	CfnWirelessDevice(Construct scope, String id, CfnWirelessDeviceProps props) Create a new `AWS::IoTWireless::WirelessDevice`.
protected	CfnWirelessDevice(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWirelessDevice(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the wireless device created.
String	getAttrId() The ID of the wireless device created.
String	getAttrThingName() The name of the thing associated with the wireless device.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the new resource.
String	getDestinationName() The name of the destination to assign to the new wireless device.
String	getLastUplinkReceivedAt() The date and time when the most recent uplink was received.
Object	getLoRaWan() The device configuration information to use to create the wireless device.
String	getName() The name of the new resource.
TagManager	getTags() The tags are an array of key-value pairs to attach to the specified resource.
String	getThingArn() The ARN of the thing to associate with the wireless device.
String	getType() The wireless device type.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) The description of the new resource.
void	setDestinationName(String value) The name of the destination to assign to the new wireless device.
void	setLastUplinkReceivedAt(String value) The date and time when the most recent uplink was received.
void	setLoRaWan(CfnWirelessDevice.LoRaWANDeviceProperty value) The device configuration information to use to create the wireless device.
void	setLoRaWan(IResolvable value) The device configuration information to use to create the wireless device.
void	setName(String value) The name of the new resource.
void	setThingArn(String value) The ARN of the thing to associate with the wireless device.
void	setType(String value) The wireless device type.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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

CfnWirelessDevice

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

CfnWirelessDevice

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

CfnWirelessDevice

@Stability(value=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 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 wireless device created.

getAttrId

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

The ID of the wireless device created.

getAttrThingName

@Stability(value=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(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.

getDestinationName

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getType()

The wireless device type.

setType

@Stability(value=Stable)
public void setType(@NotNull
                                             String value)

The wireless device type.

getDescription

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

The description of the new resource.

Maximum length is 2048.

setDescription

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

The description of the new resource.

Maximum length is 2048.

getLastUplinkReceivedAt

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

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

setLastUplinkReceivedAt

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

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

getLoRaWan

@Stability(value=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(value=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(value=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(value=Stable)
 @Nullable
public String getName()

The name of the new resource.

setName

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

The name of the new resource.

getThingArn

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

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

setThingArn

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

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