CfnDeviceProfile
- class aws_cdk.aws_iotwireless.CfnDeviceProfile(scope, id, *, lo_ra_wan=None, name=None, tags=None)
Bases:
CfnResource
A CloudFormation
AWS::IoTWireless::DeviceProfile
.Creates a new device profile.
- CloudformationResource:
AWS::IoTWireless::DeviceProfile
- 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_device_profile = iotwireless.CfnDeviceProfile(self, "MyCfnDeviceProfile", lo_ra_wan=iotwireless.CfnDeviceProfile.LoRaWANDeviceProfileProperty( class_bTimeout=123, class_cTimeout=123, factory_preset_freqs_list=[123], mac_version="macVersion", max_duty_cycle=123, max_eirp=123, ping_slot_dr=123, ping_slot_freq=123, ping_slot_period=123, reg_params_revision="regParamsRevision", rf_region="rfRegion", rx_data_rate2=123, rx_delay1=123, rx_dr_offset1=123, rx_freq2=123, supports32_bit_fCnt=False, supports_class_b=False, supports_class_c=False, supports_join=False ), name="name", tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::IoTWireless::DeviceProfile
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
lo_ra_wan (
Union
[LoRaWANDeviceProfileProperty
,Dict
[str
,Any
],IResolvable
,None
]) – LoRaWAN device profile object.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.
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
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 prefixpath
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 toaddOverride
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 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
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::DeviceProfile'
- attr_arn
The ARN of the device profile created.
- CloudformationAttribute:
Arn
- attr_id
The ID of the device profile created.
- CloudformationAttribute:
Id
- 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.
- lo_ra_wan
LoRaWAN device profile object.
- 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.
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
LoRaWANDeviceProfileProperty
- class CfnDeviceProfile.LoRaWANDeviceProfileProperty(*, class_b_timeout=None, class_c_timeout=None, factory_preset_freqs_list=None, mac_version=None, max_duty_cycle=None, max_eirp=None, ping_slot_dr=None, ping_slot_freq=None, ping_slot_period=None, reg_params_revision=None, rf_region=None, rx_data_rate2=None, rx_delay1=None, rx_dr_offset1=None, rx_freq2=None, supports32_bit_f_cnt=None, supports_class_b=None, supports_class_c=None, supports_join=None)
Bases:
object
LoRaWAN device profile object.
- Parameters:
class_b_timeout (
Union
[int
,float
,None
]) – The ClassBTimeout value.class_c_timeout (
Union
[int
,float
,None
]) – The ClassCTimeout value.factory_preset_freqs_list (
Union
[IResolvable
,Sequence
[Union
[int
,float
]],None
]) – The list of values that make up the FactoryPresetFreqs value. Valid range of values include a minimum value of 1000000 and a maximum value of 16700000.mac_version (
Optional
[str
]) – The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile.max_duty_cycle (
Union
[int
,float
,None
]) – The MaxDutyCycle value.max_eirp (
Union
[int
,float
,None
]) – The MaxEIRP value.ping_slot_dr (
Union
[int
,float
,None
]) – The PingSlotDR value.ping_slot_freq (
Union
[int
,float
,None
]) – The PingSlotFreq value.ping_slot_period (
Union
[int
,float
,None
]) – The PingSlotPeriod value.reg_params_revision (
Optional
[str
]) – The version of regional parameters.rf_region (
Optional
[str
]) – The frequency band (RFRegion) value.rx_data_rate2 (
Union
[int
,float
,None
]) – The RXDataRate2 value.rx_delay1 (
Union
[int
,float
,None
]) – The RXDelay1 value.rx_dr_offset1 (
Union
[int
,float
,None
]) – The RXDROffset1 value.rx_freq2 (
Union
[int
,float
,None
]) – The RXFreq2 value.supports32_bit_f_cnt (
Union
[bool
,IResolvable
,None
]) – The Supports32BitFCnt value.supports_class_b (
Union
[bool
,IResolvable
,None
]) – The SupportsClassB value.supports_class_c (
Union
[bool
,IResolvable
,None
]) – The SupportsClassC value.supports_join (
Union
[bool
,IResolvable
,None
]) – The SupportsJoin 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 lo_ra_wANDevice_profile_property = iotwireless.CfnDeviceProfile.LoRaWANDeviceProfileProperty( class_bTimeout=123, class_cTimeout=123, factory_preset_freqs_list=[123], mac_version="macVersion", max_duty_cycle=123, max_eirp=123, ping_slot_dr=123, ping_slot_freq=123, ping_slot_period=123, reg_params_revision="regParamsRevision", rf_region="rfRegion", rx_data_rate2=123, rx_delay1=123, rx_dr_offset1=123, rx_freq2=123, supports32_bit_fCnt=False, supports_class_b=False, supports_class_c=False, supports_join=False )
Attributes
- class_b_timeout
The ClassBTimeout value.
- class_c_timeout
The ClassCTimeout value.
- factory_preset_freqs_list
The list of values that make up the FactoryPresetFreqs value.
Valid range of values include a minimum value of 1000000 and a maximum value of 16700000.
- mac_version
The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile.
- max_duty_cycle
The MaxDutyCycle value.
- max_eirp
The MaxEIRP value.
- ping_slot_dr
The PingSlotDR value.
- ping_slot_freq
The PingSlotFreq value.
- ping_slot_period
The PingSlotPeriod value.
- reg_params_revision
The version of regional parameters.
- rf_region
The frequency band (RFRegion) value.
- rx_data_rate2
The RXDataRate2 value.
- rx_delay1
The RXDelay1 value.
- rx_dr_offset1
The RXDROffset1 value.
- rx_freq2
The RXFreq2 value.
- supports32_bit_f_cnt
The Supports32BitFCnt value.
- supports_class_b
The SupportsClassB value.
- supports_class_c
The SupportsClassC value.