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, tags=None, thing_arn=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::IoTWireless::WirelessDevice.

CloudformationResource

AWS::IoTWireless::WirelessDevice

Link

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

Create a new AWS::IoTWireless::WirelessDevice.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • destination_name (str) – AWS::IoTWireless::WirelessDevice.DestinationName.

  • type (str) – AWS::IoTWireless::WirelessDevice.Type.

  • description (Optional[str]) – AWS::IoTWireless::WirelessDevice.Description.

  • last_uplink_received_at (Optional[str]) – AWS::IoTWireless::WirelessDevice.LastUplinkReceivedAt.

  • lo_ra_wan (Union[IResolvable, LoRaWANDeviceProperty, None]) – AWS::IoTWireless::WirelessDevice.LoRaWAN.

  • name (Optional[str]) – AWS::IoTWireless::WirelessDevice.Name.

  • tags (Optional[Sequence[CfnTag]]) – AWS::IoTWireless::WirelessDevice.Tags.

  • thing_arn (Optional[str]) – AWS::IoTWireless::WirelessDevice.ThingArn.

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_depends_on(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_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

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.

Return type

None

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:

# Example automatically generated. See https://github.com/aws/jsii/issues/826
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"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate 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.

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 resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

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.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

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.

Return type

Any

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

Return type

None

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

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

Arn

Type

cloudformationAttribute

Return type

str

attr_id

Id

Type

cloudformationAttribute

Return type

str

attr_thing_name

ThingName

Type

cloudformationAttribute

Return type

str

cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

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.

Return type

List[str]

description

AWS::IoTWireless::WirelessDevice.Description.

Link

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

Return type

Optional[str]

destination_name

AWS::IoTWireless::WirelessDevice.DestinationName.

Link

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

Return type

str

AWS::IoTWireless::WirelessDevice.LastUplinkReceivedAt.

Link

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

Return type

Optional[str]

lo_ra_wan

AWS::IoTWireless::WirelessDevice.LoRaWAN.

Link

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

Return type

Union[IResolvable, LoRaWANDeviceProperty, None]

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

Return type

str

Returns

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

name

AWS::IoTWireless::WirelessDevice.Name.

Link

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

Return type

Optional[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

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 }).

Return type

str

stack

The stack in which this element is defined.

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

Return type

Stack

tags

AWS::IoTWireless::WirelessDevice.Tags.

Link

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

Return type

TagManager

thing_arn

AWS::IoTWireless::WirelessDevice.ThingArn.

Link

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

Return type

Optional[str]

type

AWS::IoTWireless::WirelessDevice.Type.

Link

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

Return type

str

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(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AbpV10xProperty

class CfnWirelessDevice.AbpV10xProperty(*, dev_addr, session_keys)

Bases: object

Parameters
Link

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

Attributes

dev_addr

CfnWirelessDevice.AbpV10xProperty.DevAddr.

Link

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

Return type

str

session_keys

CfnWirelessDevice.AbpV10xProperty.SessionKeys.

Link

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

Return type

Union[IResolvable, SessionKeysAbpV10xProperty]

AbpV11Property

class CfnWirelessDevice.AbpV11Property(*, dev_addr, session_keys)

Bases: object

Parameters
Link

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

Attributes

dev_addr

CfnWirelessDevice.AbpV11Property.DevAddr.

Link

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

Return type

str

session_keys

CfnWirelessDevice.AbpV11Property.SessionKeys.

Link

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

Return type

Union[IResolvable, SessionKeysAbpV11Property]

LoRaWANDeviceProperty

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

Bases: object

Parameters
  • abp_v10_x (Union[IResolvable, AbpV10xProperty, None]) – CfnWirelessDevice.LoRaWANDeviceProperty.AbpV10x.

  • abp_v11 (Union[IResolvable, AbpV11Property, None]) – CfnWirelessDevice.LoRaWANDeviceProperty.AbpV11.

  • dev_eui (Optional[str]) – CfnWirelessDevice.LoRaWANDeviceProperty.DevEui.

  • device_profile_id (Optional[str]) – CfnWirelessDevice.LoRaWANDeviceProperty.DeviceProfileId.

  • otaa_v10_x (Union[IResolvable, OtaaV10xProperty, None]) – CfnWirelessDevice.LoRaWANDeviceProperty.OtaaV10x.

  • otaa_v11 (Union[IResolvable, OtaaV11Property, None]) – CfnWirelessDevice.LoRaWANDeviceProperty.OtaaV11.

  • service_profile_id (Optional[str]) – CfnWirelessDevice.LoRaWANDeviceProperty.ServiceProfileId.

Link

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

Attributes

abp_v10_x

CfnWirelessDevice.LoRaWANDeviceProperty.AbpV10x.

Link

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

Return type

Union[IResolvable, AbpV10xProperty, None]

abp_v11

CfnWirelessDevice.LoRaWANDeviceProperty.AbpV11.

Link

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

Return type

Union[IResolvable, AbpV11Property, None]

dev_eui

CfnWirelessDevice.LoRaWANDeviceProperty.DevEui.

Link

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

Return type

Optional[str]

device_profile_id

CfnWirelessDevice.LoRaWANDeviceProperty.DeviceProfileId.

Link

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

Return type

Optional[str]

otaa_v10_x

CfnWirelessDevice.LoRaWANDeviceProperty.OtaaV10x.

Link

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

Return type

Union[IResolvable, OtaaV10xProperty, None]

otaa_v11

CfnWirelessDevice.LoRaWANDeviceProperty.OtaaV11.

Link

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

Return type

Union[IResolvable, OtaaV11Property, None]

service_profile_id

CfnWirelessDevice.LoRaWANDeviceProperty.ServiceProfileId.

Link

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

Return type

Optional[str]

OtaaV10xProperty

class CfnWirelessDevice.OtaaV10xProperty(*, app_eui, app_key)

Bases: object

Parameters
  • app_eui (str) – CfnWirelessDevice.OtaaV10xProperty.AppEui.

  • app_key (str) – CfnWirelessDevice.OtaaV10xProperty.AppKey.

Link

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

Attributes

app_eui

CfnWirelessDevice.OtaaV10xProperty.AppEui.

Link

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

Return type

str

app_key

CfnWirelessDevice.OtaaV10xProperty.AppKey.

Link

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

Return type

str

OtaaV11Property

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

Bases: object

Parameters
  • app_key (str) – CfnWirelessDevice.OtaaV11Property.AppKey.

  • join_eui (str) – CfnWirelessDevice.OtaaV11Property.JoinEui.

  • nwk_key (str) – CfnWirelessDevice.OtaaV11Property.NwkKey.

Link

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

Attributes

app_key

CfnWirelessDevice.OtaaV11Property.AppKey.

Link

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

Return type

str

join_eui

CfnWirelessDevice.OtaaV11Property.JoinEui.

Link

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

Return type

str

nwk_key

CfnWirelessDevice.OtaaV11Property.NwkKey.

Link

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

Return type

str

SessionKeysAbpV10xProperty

class CfnWirelessDevice.SessionKeysAbpV10xProperty(*, app_s_key, nwk_s_key)

Bases: object

Parameters
  • app_s_key (str) – CfnWirelessDevice.SessionKeysAbpV10xProperty.AppSKey.

  • nwk_s_key (str) – CfnWirelessDevice.SessionKeysAbpV10xProperty.NwkSKey.

Link

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

Attributes

app_s_key

CfnWirelessDevice.SessionKeysAbpV10xProperty.AppSKey.

Link

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

Return type

str

nwk_s_key

CfnWirelessDevice.SessionKeysAbpV10xProperty.NwkSKey.

Link

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

Return type

str

SessionKeysAbpV11Property

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

Bases: object

Parameters
  • app_s_key (str) – CfnWirelessDevice.SessionKeysAbpV11Property.AppSKey.

  • f_nwk_s_int_key (str) – CfnWirelessDevice.SessionKeysAbpV11Property.FNwkSIntKey.

  • nwk_s_enc_key (str) – CfnWirelessDevice.SessionKeysAbpV11Property.NwkSEncKey.

  • s_nwk_s_int_key (str) – CfnWirelessDevice.SessionKeysAbpV11Property.SNwkSIntKey.

Link

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

Attributes

app_s_key

CfnWirelessDevice.SessionKeysAbpV11Property.AppSKey.

Link

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

Return type

str

f_nwk_s_int_key

CfnWirelessDevice.SessionKeysAbpV11Property.FNwkSIntKey.

Link

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

Return type

str

nwk_s_enc_key

CfnWirelessDevice.SessionKeysAbpV11Property.NwkSEncKey.

Link

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

Return type

str

s_nwk_s_int_key

CfnWirelessDevice.SessionKeysAbpV11Property.SNwkSIntKey.

Link

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

Return type

str