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:
CfnResourceA CloudFormation
AWS::IoTWireless::WirelessDevice.Provisions a wireless device.
- CloudformationResource:
AWS::IoTWireless::WirelessDevice
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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", 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", tags=[CfnTag( key="key", value="value" )], thing_arn="thingArn" )
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) – 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.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_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:
- 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
addPropertyOverrideor prefixpathwith “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
valueargument toaddOverridewill 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 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.
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).- Parameters:
policy (
Optional[RemovalPolicy]) –apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
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:
- 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
- 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
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.
Maximum length is 2048.
- destination_name
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.
- last_uplink_received_at
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.
Must be at least one of OtaaV10x, OtaaV11, AbpV11, or AbpV10x.
- 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 construct tree node associated with this construct.
- 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
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
The ARN of the thing to associate with the wireless device.
- type
The wireless device type.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto 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:
objectABP device object for LoRaWAN specification v1.0.x.
- Parameters:
dev_addr (
str) – The DevAddr value.session_keys (
Union[IResolvable,SessionKeysAbpV10xProperty,Dict[str,Any]]) – Session keys for ABP v1.0.x.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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.
- session_keys
Session keys for ABP v1.0.x.
AbpV11Property
- class CfnWirelessDevice.AbpV11Property(*, dev_addr, session_keys)
Bases:
objectABP device object for create APIs for v1.1.
- Parameters:
dev_addr (
str) – The DevAddr value.session_keys (
Union[IResolvable,SessionKeysAbpV11Property,Dict[str,Any]]) – Session keys for ABP v1.1.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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.
- session_keys
Session keys for ABP v1.1.
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:
objectLoRaWAN object for create functions.
- Parameters:
abp_v10_x (
Union[IResolvable,AbpV10xProperty,Dict[str,Any],None]) – LoRaWAN object for create APIs.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.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.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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", 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
LoRaWAN object for create APIs.
- 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.
- 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 CfnWirelessDevice.OtaaV10xProperty(*, app_eui, app_key)
Bases:
objectOTAA device object for create APIs for v1.0.x.
- Parameters:
app_eui (
str) – The AppEUI value, with pattern of[a-fA-F0-9]{16}.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.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iotwireless as iotwireless otaa_v10x_property = iotwireless.CfnWirelessDevice.OtaaV10xProperty( app_eui="appEui", app_key="appKey" )
Attributes
- app_eui
The AppEUI value, with pattern of
[a-fA-F0-9]{16}.
- 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.
OtaaV11Property
- class CfnWirelessDevice.OtaaV11Property(*, app_key, join_eui, nwk_key)
Bases:
objectOTAA 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.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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.
- 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 CfnWirelessDevice.SessionKeysAbpV10xProperty(*, app_s_key, nwk_s_key)
Bases:
objectLoRaWAN object for create APIs.
- 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.
nwk_s_key (
str) –The NwkSKey is a secret key, which you should handle in a similar way as you would an application password. You can protect the NwkSKey value by storing it in the AWS Secrets Manager and use the secretsmanager to reference this value.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iotwireless as iotwireless session_keys_abp_v10x_property = iotwireless.CfnWirelessDevice.SessionKeysAbpV10xProperty( app_sKey="appSKey", nwk_sKey="nwkSKey" )
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.
- nwk_s_key
The NwkSKey is a secret key, which you should handle in a similar way as you would an application password.
You can protect the NwkSKey value by storing it in the AWS Secrets Manager and use the secretsmanager to reference this value.
SessionKeysAbpV11Property
- class CfnWirelessDevice.SessionKeysAbpV11Property(*, app_s_key, f_nwk_s_int_key, nwk_s_enc_key, s_nwk_s_int_key)
Bases:
objectSession 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.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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.
- 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.