Skip to content
v2.278.0

CfnWirelessDeviceProps Struct ​

Properties for defining a CfnWirelessDevice.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotwireless as iotwireless } from 'aws-cdk-lib';
const cfnWirelessDeviceProps: iotwireless.CfnWirelessDeviceProps = {
  destinationName: 'destinationName',
  type: 'type',

  // the properties below are optional
  description: 'description',
  lastUplinkReceivedAt: 'lastUplinkReceivedAt',
  loRaWan: {
    abpV10X: {
      devAddr: 'devAddr',
      sessionKeys: {
        appSKey: 'appSKey',
        nwkSKey: 'nwkSKey',
      },
    },
    abpV11: {
      devAddr: 'devAddr',
      sessionKeys: {
        appSKey: 'appSKey',
        fNwkSIntKey: 'fNwkSIntKey',
        nwkSEncKey: 'nwkSEncKey',
        sNwkSIntKey: 'sNwkSIntKey',
      },
    },
    devEui: 'devEui',
    deviceProfileId: 'deviceProfileId',
    fPorts: {
      applications: [{
        destinationName: 'destinationName',
        fPort: 123,
        type: 'type',
      }],
    },
    otaaV10X: {
      appEui: 'appEui',
      appKey: 'appKey',
    },
    otaaV11: {
      appKey: 'appKey',
      joinEui: 'joinEui',
      nwkKey: 'nwkKey',
    },
    serviceProfileId: 'serviceProfileId',
  },
  name: 'name',
  positioning: 'positioning',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  thingArn: 'thingArn',
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotwireless as iotwireless

cfn_wireless_device_props = iotwireless.CfnWirelessDeviceProps(
    destination_name="destinationName",
    type="type",

    # the properties below are optional
    description="description",
    last_uplink_received_at="lastUplinkReceivedAt",
    lo_ra_wan=iotwireless.CfnWirelessDevice.LoRaWANDeviceProperty(
        abp_v10_x=iotwireless.CfnWirelessDevice.AbpV10xProperty(
            dev_addr="devAddr",
            session_keys=iotwireless.CfnWirelessDevice.SessionKeysAbpV10xProperty(
                app_s_key="appSKey",
                nwk_s_key="nwkSKey"
            )
        ),
        abp_v11=iotwireless.CfnWirelessDevice.AbpV11Property(
            dev_addr="devAddr",
            session_keys=iotwireless.CfnWirelessDevice.SessionKeysAbpV11Property(
                app_s_key="appSKey",
                f_nwk_s_int_key="fNwkSIntKey",
                nwk_s_enc_key="nwkSEncKey",
                s_nwk_s_int_key="sNwkSIntKey"
            )
        ),
        dev_eui="devEui",
        device_profile_id="deviceProfileId",
        f_ports=iotwireless.CfnWirelessDevice.FPortsProperty(
            applications=[iotwireless.CfnWirelessDevice.ApplicationProperty(
                destination_name="destinationName",
                f_port=123,
                type="type"
            )]
        ),
        otaa_v10_x=iotwireless.CfnWirelessDevice.OtaaV10xProperty(
            app_eui="appEui",
            app_key="appKey"
        ),
        otaa_v11=iotwireless.CfnWirelessDevice.OtaaV11Property(
            app_key="appKey",
            join_eui="joinEui",
            nwk_key="nwkKey"
        ),
        service_profile_id="serviceProfileId"
    ),
    name="name",
    positioning="positioning",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    thing_arn="thingArn"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTWireless;

var cfnWirelessDeviceProps = new CfnWirelessDeviceProps {
    DestinationName = "destinationName",
    Type = "type",

    // the properties below are optional
    Description = "description",
    LastUplinkReceivedAt = "lastUplinkReceivedAt",
    LoRaWan = new LoRaWANDeviceProperty {
        AbpV10X = new AbpV10xProperty {
            DevAddr = "devAddr",
            SessionKeys = new SessionKeysAbpV10xProperty {
                AppSKey = "appSKey",
                NwkSKey = "nwkSKey"
            }
        },
        AbpV11 = new AbpV11Property {
            DevAddr = "devAddr",
            SessionKeys = new SessionKeysAbpV11Property {
                AppSKey = "appSKey",
                FNwkSIntKey = "fNwkSIntKey",
                NwkSEncKey = "nwkSEncKey",
                SNwkSIntKey = "sNwkSIntKey"
            }
        },
        DevEui = "devEui",
        DeviceProfileId = "deviceProfileId",
        FPorts = new FPortsProperty {
            Applications = new [] { new ApplicationProperty {
                DestinationName = "destinationName",
                FPort = 123,
                Type = "type"
            } }
        },
        OtaaV10X = new OtaaV10xProperty {
            AppEui = "appEui",
            AppKey = "appKey"
        },
        OtaaV11 = new OtaaV11Property {
            AppKey = "appKey",
            JoinEui = "joinEui",
            NwkKey = "nwkKey"
        },
        ServiceProfileId = "serviceProfileId"
    },
    Name = "name",
    Positioning = "positioning",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    ThingArn = "thingArn"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnWirelessDeviceProps := &CfnWirelessDeviceProps{
	DestinationName: jsii.String("destinationName"),
	Type: jsii.String("type"),

	// the properties below are optional
	Description: jsii.String("description"),
	LastUplinkReceivedAt: jsii.String("lastUplinkReceivedAt"),
	LoRaWan: &LoRaWANDeviceProperty{
		AbpV10X: &AbpV10xProperty{
			DevAddr: jsii.String("devAddr"),
			SessionKeys: &SessionKeysAbpV10xProperty{
				AppSKey: jsii.String("appSKey"),
				NwkSKey: jsii.String("nwkSKey"),
			},
		},
		AbpV11: &AbpV11Property{
			DevAddr: jsii.String("devAddr"),
			SessionKeys: &SessionKeysAbpV11Property{
				AppSKey: jsii.String("appSKey"),
				FNwkSIntKey: jsii.String("fNwkSIntKey"),
				NwkSEncKey: jsii.String("nwkSEncKey"),
				SNwkSIntKey: jsii.String("sNwkSIntKey"),
			},
		},
		DevEui: jsii.String("devEui"),
		DeviceProfileId: jsii.String("deviceProfileId"),
		FPorts: &FPortsProperty{
			Applications: []interface{}{
				&ApplicationProperty{
					DestinationName: jsii.String("destinationName"),
					FPort: jsii.Number(123),
					Type: jsii.String("type"),
				},
			},
		},
		OtaaV10X: &OtaaV10xProperty{
			AppEui: jsii.String("appEui"),
			AppKey: jsii.String("appKey"),
		},
		OtaaV11: &OtaaV11Property{
			AppKey: jsii.String("appKey"),
			JoinEui: jsii.String("joinEui"),
			NwkKey: jsii.String("nwkKey"),
		},
		ServiceProfileId: jsii.String("serviceProfileId"),
	},
	Name: jsii.String("name"),
	Positioning: jsii.String("positioning"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	ThingArn: jsii.String("thingArn"),
}

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #
The description of the new resource.

Maximum length is 2048.

destinationNamestringdestination_namestrdestinationNameStringDestinationNamestringDestinationName*string required #
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.

lastUplinkReceivedAtoptionalstringlast_uplink_received_atoptionalstrlastUplinkReceivedAtoptionalStringLastUplinkReceivedAtoptionalstringLastUplinkReceivedAtoptional*string #
The date and time when the most recent uplink was received.
loRaWanoptionalIResolvable | CfnWirelessDevice.LoRaWANDevicePropertylo_ra_wanoptionaltyping.Union[IResolvable, LoRaWANDeviceProperty]loRaWanoptionalIResolvableLoRaWanoptionalIResolvableLoRaWanoptionalinterface{} #
The device configuration information to use to create the wireless device.

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

nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string #
The name of the new resource.
positioningoptionalstringpositioningoptionalstrpositioningoptionalStringPositioningoptionalstringPositioningoptional*string #
FPort values for the GNSS, Stream, and ClockSync functions of the positioning information.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
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.

thingArnoptionalstringthing_arnoptionalstrthingArnoptionalStringThingArnoptionalstringThingArnoptional*string #
The ARN of the thing to associate with the wireless device.
typestringtypestrtypeStringTypestringType*string required #
The wireless device type.