CfnWirelessDevice

class aws_cdk.aws_iotwireless.CfnWirelessDevice(scope, id, *, destination_name, type, description=None, last_uplink_received_at=None, lo_ra_wan=None, name=None, positioning=None, tags=None, thing_arn=None)

Bases: CfnResource

Provisions a wireless device.

See:

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

CloudformationResource:

AWS::IoTWireless::WirelessDevice

ExampleMetadata:

fixture=_generated

Example:

# 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 = iotwireless.CfnWirelessDevice(self, "MyCfnWirelessDevice",
    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_sKey="appSKey",
                nwk_sKey="nwkSKey"
            )
        ),
        abp_v11=iotwireless.CfnWirelessDevice.AbpV11Property(
            dev_addr="devAddr",
            session_keys=iotwireless.CfnWirelessDevice.SessionKeysAbpV11Property(
                app_sKey="appSKey",
                f_nwk_sInt_key="fNwkSIntKey",
                nwk_sEnc_key="nwkSEncKey",
                s_nwk_sInt_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"
)
Parameters:
  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

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

  • type (str) – The wireless device type.

  • description (Optional[str]) – The description of the new resource. Maximum length is 2048.

  • last_uplink_received_at (Optional[str]) – The date and time when the most recent uplink was received.

  • lo_ra_wan (Union[IResolvable, LoRaWANDeviceProperty, Dict[str, Any], None]) – The device configuration information to use to create the wireless device. Must be at least one of OtaaV10x, OtaaV11, AbpV11, or AbpV10x.

  • name (Optional[str]) – The name of the new resource.

  • positioning (Optional[str]) – FPort values for the GNSS, Stream, and ClockSync functions of the positioning information.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

  • thing_arn (Optional[str]) – The ARN of the thing to associate with the wireless device.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:
  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:
  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::IoTWireless::WirelessDevice'
attr_arn

The ARN of the wireless device created.

CloudformationAttribute:

Arn

attr_id

The ID of the wireless device created.

CloudformationAttribute:

Id

attr_thing_name

The name of the thing associated with the wireless device.

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

CloudformationAttribute:

ThingName

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

The description of the new resource.

destination_name

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

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

lo_ra_wan

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name of the new resource.

node

The tree node.

positioning

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

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Tag Manager which manages the tags for this resource.

tags_raw

The tags are an array of key-value pairs to attach to the specified resource.

thing_arn

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

type

The wireless device type.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AbpV10xProperty

class CfnWirelessDevice.AbpV10xProperty(*, dev_addr, session_keys)

Bases: object

ABP device object for LoRaWAN specification v1.0.x.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-abpv10x.html

ExampleMetadata:

fixture=_generated

Example:

# 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

abp_v10x_property = iotwireless.CfnWirelessDevice.AbpV10xProperty(
    dev_addr="devAddr",
    session_keys=iotwireless.CfnWirelessDevice.SessionKeysAbpV10xProperty(
        app_sKey="appSKey",
        nwk_sKey="nwkSKey"
    )
)

Attributes

dev_addr

The DevAddr value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-abpv10x.html#cfn-iotwireless-wirelessdevice-abpv10x-devaddr

session_keys

Session keys for ABP v1.0.x.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-abpv10x.html#cfn-iotwireless-wirelessdevice-abpv10x-sessionkeys

AbpV11Property

class CfnWirelessDevice.AbpV11Property(*, dev_addr, session_keys)

Bases: object

ABP device object for create APIs for v1.1.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-abpv11.html

ExampleMetadata:

fixture=_generated

Example:

# 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

abp_v11_property = iotwireless.CfnWirelessDevice.AbpV11Property(
    dev_addr="devAddr",
    session_keys=iotwireless.CfnWirelessDevice.SessionKeysAbpV11Property(
        app_sKey="appSKey",
        f_nwk_sInt_key="fNwkSIntKey",
        nwk_sEnc_key="nwkSEncKey",
        s_nwk_sInt_key="sNwkSIntKey"
    )
)

Attributes

dev_addr

The DevAddr value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-abpv11.html#cfn-iotwireless-wirelessdevice-abpv11-devaddr

session_keys

Session keys for ABP v1.1.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-abpv11.html#cfn-iotwireless-wirelessdevice-abpv11-sessionkeys

ApplicationProperty

class CfnWirelessDevice.ApplicationProperty(*, destination_name=None, f_port=None, type=None)

Bases: object

A list of optional LoRaWAN application information, which can be used for geolocation.

Parameters:
  • destination_name (Optional[str]) – The name of the position data destination that describes the IoT rule that processes the device’s position data.

  • f_port (Union[int, float, None]) – The name of the new destination for the device.

  • type (Optional[str]) – Application type, which can be specified to obtain real-time position information of your LoRaWAN device.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-application.html

ExampleMetadata:

fixture=_generated

Example:

# 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

application_property = iotwireless.CfnWirelessDevice.ApplicationProperty(
    destination_name="destinationName",
    f_port=123,
    type="type"
)

Attributes

destination_name

The name of the position data destination that describes the IoT rule that processes the device’s position data.

See:

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

f_port

The name of the new destination for the device.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-application.html#cfn-iotwireless-wirelessdevice-application-fport

type

Application type, which can be specified to obtain real-time position information of your LoRaWAN device.

See:

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

FPortsProperty

class CfnWirelessDevice.FPortsProperty(*, applications=None)

Bases: object

List of FPorts assigned for different LoRaWAN application packages to use.

Parameters:

applications (Union[IResolvable, Sequence[Union[IResolvable, ApplicationProperty, Dict[str, Any]]], None]) – LoRaWAN application configuration, which can be used to perform geolocation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-fports.html

ExampleMetadata:

fixture=_generated

Example:

# 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

f_ports_property = iotwireless.CfnWirelessDevice.FPortsProperty(
    applications=[iotwireless.CfnWirelessDevice.ApplicationProperty(
        destination_name="destinationName",
        f_port=123,
        type="type"
    )]
)

Attributes

applications

LoRaWAN application configuration, which can be used to perform geolocation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-fports.html#cfn-iotwireless-wirelessdevice-fports-applications

LoRaWANDeviceProperty

class CfnWirelessDevice.LoRaWANDeviceProperty(*, abp_v10_x=None, abp_v11=None, dev_eui=None, device_profile_id=None, f_ports=None, otaa_v10_x=None, otaa_v11=None, service_profile_id=None)

Bases: object

LoRaWAN object for create functions.

Parameters:
  • abp_v10_x (Union[IResolvable, AbpV10xProperty, Dict[str, Any], None]) – ABP device object for LoRaWAN specification v1.0.x.

  • abp_v11 (Union[IResolvable, AbpV11Property, Dict[str, Any], None]) – ABP device object for create APIs for v1.1.

  • dev_eui (Optional[str]) – The DevEUI value.

  • device_profile_id (Optional[str]) – The ID of the device profile for the new wireless device.

  • f_ports (Union[IResolvable, FPortsProperty, Dict[str, Any], None]) – List of FPort assigned for different LoRaWAN application packages to use.

  • otaa_v10_x (Union[IResolvable, OtaaV10xProperty, Dict[str, Any], None]) – OTAA device object for create APIs for v1.0.x.

  • otaa_v11 (Union[IResolvable, OtaaV11Property, Dict[str, Any], None]) – OTAA device object for v1.1 for create APIs.

  • service_profile_id (Optional[str]) – The ID of the service profile.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-lorawandevice.html

ExampleMetadata:

fixture=_generated

Example:

# 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

lo_ra_wANDevice_property = iotwireless.CfnWirelessDevice.LoRaWANDeviceProperty(
    abp_v10_x=iotwireless.CfnWirelessDevice.AbpV10xProperty(
        dev_addr="devAddr",
        session_keys=iotwireless.CfnWirelessDevice.SessionKeysAbpV10xProperty(
            app_sKey="appSKey",
            nwk_sKey="nwkSKey"
        )
    ),
    abp_v11=iotwireless.CfnWirelessDevice.AbpV11Property(
        dev_addr="devAddr",
        session_keys=iotwireless.CfnWirelessDevice.SessionKeysAbpV11Property(
            app_sKey="appSKey",
            f_nwk_sInt_key="fNwkSIntKey",
            nwk_sEnc_key="nwkSEncKey",
            s_nwk_sInt_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"
)

Attributes

abp_v10_x

ABP device object for LoRaWAN specification v1.0.x.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-lorawandevice.html#cfn-iotwireless-wirelessdevice-lorawandevice-abpv10x

abp_v11

ABP device object for create APIs for v1.1.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-lorawandevice.html#cfn-iotwireless-wirelessdevice-lorawandevice-abpv11

dev_eui

The DevEUI value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-lorawandevice.html#cfn-iotwireless-wirelessdevice-lorawandevice-deveui

device_profile_id

The ID of the device profile for the new wireless device.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-lorawandevice.html#cfn-iotwireless-wirelessdevice-lorawandevice-deviceprofileid

f_ports

List of FPort assigned for different LoRaWAN application packages to use.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-lorawandevice.html#cfn-iotwireless-wirelessdevice-lorawandevice-fports

otaa_v10_x

OTAA device object for create APIs for v1.0.x.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-lorawandevice.html#cfn-iotwireless-wirelessdevice-lorawandevice-otaav10x

otaa_v11

OTAA device object for v1.1 for create APIs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-lorawandevice.html#cfn-iotwireless-wirelessdevice-lorawandevice-otaav11

service_profile_id

The ID of the service profile.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-lorawandevice.html#cfn-iotwireless-wirelessdevice-lorawandevice-serviceprofileid

OtaaV10xProperty

class CfnWirelessDevice.OtaaV10xProperty(*, app_eui, app_key)

Bases: object

OTAA device object for v1.0.x.

Parameters:
  • app_eui (str) – The AppEUI value. You specify this value when using LoRaWAN versions v1.0.2 or v1.0.3.

  • app_key (str) – The AppKey value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-otaav10x.html

ExampleMetadata:

fixture=_generated

Example:

# 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

otaa_v10x_property = iotwireless.CfnWirelessDevice.OtaaV10xProperty(
    app_eui="appEui",
    app_key="appKey"
)

Attributes

app_eui

The AppEUI value.

You specify this value when using LoRaWAN versions v1.0.2 or v1.0.3.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-otaav10x.html#cfn-iotwireless-wirelessdevice-otaav10x-appeui

app_key

The AppKey value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-otaav10x.html#cfn-iotwireless-wirelessdevice-otaav10x-appkey

OtaaV11Property

class CfnWirelessDevice.OtaaV11Property(*, app_key, join_eui, nwk_key)

Bases: object

OTAA device object for v1.1 for create APIs.

Parameters:
  • app_key (str) – The AppKey is a secret key, which you should handle in a similar way as you would an application password. You can protect the AppKey value by storing it in the AWS Secrets Manager and use the secretsmanager to reference this value.

  • join_eui (str) – The JoinEUI value.

  • nwk_key (str) –

    The NwkKey is a secret key, which you should handle in a similar way as you would an application password. You can protect the NwkKey value by storing it in the AWS Secrets Manager and use the secretsmanager to reference this value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-otaav11.html

ExampleMetadata:

fixture=_generated

Example:

# 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

otaa_v11_property = iotwireless.CfnWirelessDevice.OtaaV11Property(
    app_key="appKey",
    join_eui="joinEui",
    nwk_key="nwkKey"
)

Attributes

app_key

The AppKey is a secret key, which you should handle in a similar way as you would an application password.

You can protect the AppKey value by storing it in the AWS Secrets Manager and use the secretsmanager to reference this value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-otaav11.html#cfn-iotwireless-wirelessdevice-otaav11-appkey

join_eui

The JoinEUI value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-otaav11.html#cfn-iotwireless-wirelessdevice-otaav11-joineui

nwk_key

The NwkKey is a secret key, which you should handle in a similar way as you would an application password.

You can protect the NwkKey value by storing it in the AWS Secrets Manager and use the secretsmanager to reference this value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-otaav11.html#cfn-iotwireless-wirelessdevice-otaav11-nwkkey

SessionKeysAbpV10xProperty

class CfnWirelessDevice.SessionKeysAbpV10xProperty(*, app_s_key, nwk_s_key)

Bases: object

Session keys for ABP v1.0.x.

Parameters:
  • app_s_key (str) – The AppSKey value.

  • nwk_s_key (str) – The NwkKey value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-sessionkeysabpv10x.html

ExampleMetadata:

fixture=_generated

Example:

# 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

session_keys_abp_v10x_property = iotwireless.CfnWirelessDevice.SessionKeysAbpV10xProperty(
    app_sKey="appSKey",
    nwk_sKey="nwkSKey"
)

Attributes

app_s_key

The AppSKey value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-sessionkeysabpv10x.html#cfn-iotwireless-wirelessdevice-sessionkeysabpv10x-appskey

nwk_s_key

The NwkKey value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-sessionkeysabpv10x.html#cfn-iotwireless-wirelessdevice-sessionkeysabpv10x-nwkskey

SessionKeysAbpV11Property

class CfnWirelessDevice.SessionKeysAbpV11Property(*, app_s_key, f_nwk_s_int_key, nwk_s_enc_key, s_nwk_s_int_key)

Bases: object

Session keys for ABP v1.1.

Parameters:
  • app_s_key (str) –

    The AppSKey is a secret key, which you should handle in a similar way as you would an application password. You can protect the AppSKey value by storing it in the AWS Secrets Manager and use the secretsmanager to reference this value.

  • f_nwk_s_int_key (str) –

    The FNwkSIntKey is a secret key, which you should handle in a similar way as you would an application password. You can protect the FNwkSIntKey value by storing it in the AWS Secrets Manager and use the secretsmanager to reference this value.

  • nwk_s_enc_key (str) –

    The NwkSEncKey is a secret key, which you should handle in a similar way as you would an application password. You can protect the NwkSEncKey value by storing it in the AWS Secrets Manager and use the secretsmanager to reference this value.

  • s_nwk_s_int_key (str) –

    The SNwkSIntKey is a secret key, which you should handle in a similar way as you would an application password. You can protect the SNwkSIntKey value by storing it in the AWS Secrets Manager and use the secretsmanager to reference this value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-sessionkeysabpv11.html

ExampleMetadata:

fixture=_generated

Example:

# 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

session_keys_abp_v11_property = iotwireless.CfnWirelessDevice.SessionKeysAbpV11Property(
    app_sKey="appSKey",
    f_nwk_sInt_key="fNwkSIntKey",
    nwk_sEnc_key="nwkSEncKey",
    s_nwk_sInt_key="sNwkSIntKey"
)

Attributes

app_s_key

The AppSKey is a secret key, which you should handle in a similar way as you would an application password.

You can protect the AppSKey value by storing it in the AWS Secrets Manager and use the secretsmanager to reference this value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-sessionkeysabpv11.html#cfn-iotwireless-wirelessdevice-sessionkeysabpv11-appskey

f_nwk_s_int_key

The FNwkSIntKey is a secret key, which you should handle in a similar way as you would an application password.

You can protect the FNwkSIntKey value by storing it in the AWS Secrets Manager and use the secretsmanager to reference this value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-sessionkeysabpv11.html#cfn-iotwireless-wirelessdevice-sessionkeysabpv11-fnwksintkey

nwk_s_enc_key

The NwkSEncKey is a secret key, which you should handle in a similar way as you would an application password.

You can protect the NwkSEncKey value by storing it in the AWS Secrets Manager and use the secretsmanager to reference this value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-sessionkeysabpv11.html#cfn-iotwireless-wirelessdevice-sessionkeysabpv11-nwksenckey

s_nwk_s_int_key

The SNwkSIntKey is a secret key, which you should handle in a similar way as you would an application password.

You can protect the SNwkSIntKey value by storing it in the AWS Secrets Manager and use the secretsmanager to reference this value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-sessionkeysabpv11.html#cfn-iotwireless-wirelessdevice-sessionkeysabpv11-snwksintkey