CfnWirelessDevicePropsMixin
- class aws_cdk.mixins_preview.aws_iotwireless.mixins.CfnWirelessDevicePropsMixin(props, *, strategy=None)
Bases:
MixinProvisions a wireless device.
- See:
- CloudformationResource:
AWS::IoTWireless::WirelessDevice
- Mixin:
true
- 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.mixins_preview import mixins from aws_cdk.mixins_preview.aws_iotwireless import mixins as iotwireless_mixins cfn_wireless_device_props_mixin = iotwireless_mixins.CfnWirelessDevicePropsMixin(iotwireless_mixins.CfnWirelessDeviceMixinProps( description="description", destination_name="destinationName", last_uplink_received_at="lastUplinkReceivedAt", lo_ra_wan=iotwireless_mixins.CfnWirelessDevicePropsMixin.LoRaWANDeviceProperty( abp_v10_x=iotwireless_mixins.CfnWirelessDevicePropsMixin.AbpV10xProperty( dev_addr="devAddr", session_keys=iotwireless_mixins.CfnWirelessDevicePropsMixin.SessionKeysAbpV10xProperty( app_sKey="appSKey", nwk_sKey="nwkSKey" ) ), abp_v11=iotwireless_mixins.CfnWirelessDevicePropsMixin.AbpV11Property( dev_addr="devAddr", session_keys=iotwireless_mixins.CfnWirelessDevicePropsMixin.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_mixins.CfnWirelessDevicePropsMixin.FPortsProperty( applications=[iotwireless_mixins.CfnWirelessDevicePropsMixin.ApplicationProperty( destination_name="destinationName", f_port=123, type="type" )] ), otaa_v10_x=iotwireless_mixins.CfnWirelessDevicePropsMixin.OtaaV10xProperty( app_eui="appEui", app_key="appKey" ), otaa_v11=iotwireless_mixins.CfnWirelessDevicePropsMixin.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", type="type" ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::IoTWireless::WirelessDevice.- Parameters:
props (
Union[CfnWirelessDeviceMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['description', 'destinationName', 'lastUplinkReceivedAt', 'loRaWan', 'name', 'positioning', 'tags', 'thingArn', 'type']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
AbpV10xProperty
- class CfnWirelessDevicePropsMixin.AbpV10xProperty(*, dev_addr=None, session_keys=None)
Bases:
objectABP device object for LoRaWAN specification v1.0.x.
- Parameters:
dev_addr (
Optional[str]) – The DevAddr value.session_keys (
Union[IResolvable,SessionKeysAbpV10xProperty,Dict[str,Any],None]) – Session keys for ABP v1.0.x.
- See:
- 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.mixins_preview.aws_iotwireless import mixins as iotwireless_mixins abp_v10x_property = iotwireless_mixins.CfnWirelessDevicePropsMixin.AbpV10xProperty( dev_addr="devAddr", session_keys=iotwireless_mixins.CfnWirelessDevicePropsMixin.SessionKeysAbpV10xProperty( app_sKey="appSKey", nwk_sKey="nwkSKey" ) )
Attributes
- dev_addr
The DevAddr value.
- session_keys
Session keys for ABP v1.0.x.
AbpV11Property
- class CfnWirelessDevicePropsMixin.AbpV11Property(*, dev_addr=None, session_keys=None)
Bases:
objectABP device object for create APIs for v1.1.
- Parameters:
dev_addr (
Optional[str]) – The DevAddr value.session_keys (
Union[IResolvable,SessionKeysAbpV11Property,Dict[str,Any],None]) – Session keys for ABP v1.1.
- See:
- 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.mixins_preview.aws_iotwireless import mixins as iotwireless_mixins abp_v11_property = iotwireless_mixins.CfnWirelessDevicePropsMixin.AbpV11Property( dev_addr="devAddr", session_keys=iotwireless_mixins.CfnWirelessDevicePropsMixin.SessionKeysAbpV11Property( app_sKey="appSKey", f_nwk_sInt_key="fNwkSIntKey", nwk_sEnc_key="nwkSEncKey", s_nwk_sInt_key="sNwkSIntKey" ) )
Attributes
- dev_addr
The DevAddr value.
- session_keys
Session keys for ABP v1.1.
ApplicationProperty
- class CfnWirelessDevicePropsMixin.ApplicationProperty(*, destination_name=None, f_port=None, type=None)
Bases:
objectA 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:
- 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.mixins_preview.aws_iotwireless import mixins as iotwireless_mixins application_property = iotwireless_mixins.CfnWirelessDevicePropsMixin.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.
- f_port
The name of the new destination for the device.
- type
Application type, which can be specified to obtain real-time position information of your LoRaWAN device.
FPortsProperty
- class CfnWirelessDevicePropsMixin.FPortsProperty(*, applications=None)
Bases:
objectList 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:
- 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.mixins_preview.aws_iotwireless import mixins as iotwireless_mixins f_ports_property = iotwireless_mixins.CfnWirelessDevicePropsMixin.FPortsProperty( applications=[iotwireless_mixins.CfnWirelessDevicePropsMixin.ApplicationProperty( destination_name="destinationName", f_port=123, type="type" )] )
Attributes
- applications
LoRaWAN application configuration, which can be used to perform geolocation.
LoRaWANDeviceProperty
- class CfnWirelessDevicePropsMixin.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:
objectLoRaWAN 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:
- 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.mixins_preview.aws_iotwireless import mixins as iotwireless_mixins lo_ra_wANDevice_property = iotwireless_mixins.CfnWirelessDevicePropsMixin.LoRaWANDeviceProperty( abp_v10_x=iotwireless_mixins.CfnWirelessDevicePropsMixin.AbpV10xProperty( dev_addr="devAddr", session_keys=iotwireless_mixins.CfnWirelessDevicePropsMixin.SessionKeysAbpV10xProperty( app_sKey="appSKey", nwk_sKey="nwkSKey" ) ), abp_v11=iotwireless_mixins.CfnWirelessDevicePropsMixin.AbpV11Property( dev_addr="devAddr", session_keys=iotwireless_mixins.CfnWirelessDevicePropsMixin.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_mixins.CfnWirelessDevicePropsMixin.FPortsProperty( applications=[iotwireless_mixins.CfnWirelessDevicePropsMixin.ApplicationProperty( destination_name="destinationName", f_port=123, type="type" )] ), otaa_v10_x=iotwireless_mixins.CfnWirelessDevicePropsMixin.OtaaV10xProperty( app_eui="appEui", app_key="appKey" ), otaa_v11=iotwireless_mixins.CfnWirelessDevicePropsMixin.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.
- abp_v11
ABP device object for create APIs for v1.1.
- dev_eui
The DevEUI value.
- device_profile_id
The ID of the device profile for the new wireless device.
- f_ports
List of FPort assigned for different LoRaWAN application packages to use.
- otaa_v10_x
OTAA device object for create APIs for v1.0.x.
- otaa_v11
OTAA device object for v1.1 for create APIs.
- service_profile_id
The ID of the service profile.
OtaaV10xProperty
- class CfnWirelessDevicePropsMixin.OtaaV10xProperty(*, app_eui=None, app_key=None)
Bases:
objectOTAA device object for v1.0.x.
- Parameters:
app_eui (
Optional[str]) – The AppEUI value. You specify this value when using LoRaWAN versions v1.0.2 or v1.0.3.app_key (
Optional[str]) – The AppKey value.
- See:
- 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.mixins_preview.aws_iotwireless import mixins as iotwireless_mixins otaa_v10x_property = iotwireless_mixins.CfnWirelessDevicePropsMixin.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.
OtaaV11Property
- class CfnWirelessDevicePropsMixin.OtaaV11Property(*, app_key=None, join_eui=None, nwk_key=None)
Bases:
objectOTAA device object for v1.1 for create APIs.
- Parameters:
app_key (
Optional[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 (
Optional[str]) – The JoinEUI value.nwk_key (
Optional[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:
- 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.mixins_preview.aws_iotwireless import mixins as iotwireless_mixins otaa_v11_property = iotwireless_mixins.CfnWirelessDevicePropsMixin.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.
- join_eui
The JoinEUI value.
- 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.
SessionKeysAbpV10xProperty
- class CfnWirelessDevicePropsMixin.SessionKeysAbpV10xProperty(*, app_s_key=None, nwk_s_key=None)
Bases:
objectSession keys for ABP v1.0.x.
- Parameters:
app_s_key (
Optional[str]) – The AppSKey value.nwk_s_key (
Optional[str]) – The NwkKey value.
- See:
- 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.mixins_preview.aws_iotwireless import mixins as iotwireless_mixins session_keys_abp_v10x_property = iotwireless_mixins.CfnWirelessDevicePropsMixin.SessionKeysAbpV10xProperty( app_sKey="appSKey", nwk_sKey="nwkSKey" )
Attributes
- app_s_key
The AppSKey value.
SessionKeysAbpV11Property
- class CfnWirelessDevicePropsMixin.SessionKeysAbpV11Property(*, app_s_key=None, f_nwk_s_int_key=None, nwk_s_enc_key=None, s_nwk_s_int_key=None)
Bases:
objectSession keys for ABP v1.1.
- Parameters:
app_s_key (
Optional[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 (
Optional[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 (
Optional[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 (
Optional[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:
- 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.mixins_preview.aws_iotwireless import mixins as iotwireless_mixins session_keys_abp_v11_property = iotwireless_mixins.CfnWirelessDevicePropsMixin.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.
- 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.
- 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.
- 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.