CfnServiceProfile

class aws_cdk.aws_iotwireless.CfnServiceProfile(scope, id, *, lo_ra_wan=None, name=None, tags=None)

Bases: CfnResource

A CloudFormation AWS::IoTWireless::ServiceProfile.

Creates a new service profile.

CloudformationResource:: AWS::IoTWireless::ServiceProfile
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-serviceprofile.html
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_service_profile = iotwireless.CfnServiceProfile(self, "MyCfnServiceProfile",
    lo_ra_wan=iotwireless.CfnServiceProfile.LoRaWANServiceProfileProperty(
        add_gw_metadata=False,
        channel_mask="channelMask",
        dev_status_req_freq=123,
        dl_bucket_size=123,
        dl_rate=123,
        dl_rate_policy="dlRatePolicy",
        dr_max=123,
        dr_min=123,
        hr_allowed=False,
        min_gw_diversity=123,
        nwk_geo_loc=False,
        pr_allowed=False,
        ra_allowed=False,
        report_dev_status_battery=False,
        report_dev_status_margin=False,
        target_per=123,
        ul_bucket_size=123,
        ul_rate=123,
        ul_rate_policy="ulRatePolicy"
    ),
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::IoTWireless::ServiceProfile.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
lo_ra_wan (Union[IResolvable, LoRaWANServiceProfileProperty, Dict[str, Any], None]) – LoRaWAN service 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

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 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: 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:

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::ServiceProfile'

attr_arn

The ARN of the service profile created.

CloudformationAttribute:: Arn

attr_id

The ID of the service profile created.

CloudformationAttribute:: Id

attr_lo_ra_wan_channel_mask

The ChannelMask value.

CloudformationAttribute:: LoRaWAN.ChannelMask

attr_lo_ra_wan_dev_status_req_freq

The DevStatusReqFreq value.

CloudformationAttribute:: LoRaWAN.DevStatusReqFreq

attr_lo_ra_wan_dl_bucket_size

The DLBucketSize value.

CloudformationAttribute:: LoRaWAN.DlBucketSize

attr_lo_ra_wan_dl_rate

The DLRate value.

CloudformationAttribute:: LoRaWAN.DlRate

attr_lo_ra_wan_dl_rate_policy

The DLRatePolicy value.

CloudformationAttribute:: LoRaWAN.DlRatePolicy

attr_lo_ra_wan_dr_max

The DRMax value.

CloudformationAttribute:: LoRaWAN.DrMax

attr_lo_ra_wan_dr_min

The DRMin value.

CloudformationAttribute:: LoRaWAN.DrMin

attr_lo_ra_wan_hr_allowed

The HRAllowed value that describes whether handover roaming is allowed.

CloudformationAttribute:: LoRaWAN.HrAllowed

attr_lo_ra_wan_min_gw_diversity

The MinGwDiversity value.

CloudformationAttribute:: LoRaWAN.MinGwDiversity

attr_lo_ra_wan_nwk_geo_loc

The NwkGeoLoc value.

CloudformationAttribute:: LoRaWAN.NwkGeoLoc

attr_lo_ra_wan_pr_allowed

The PRAllowed value that describes whether passive roaming is allowed.

CloudformationAttribute:: LoRaWAN.PrAllowed

attr_lo_ra_wan_ra_allowed

The RAAllowed value that describes whether roaming activation is allowed.

CloudformationAttribute:: LoRaWAN.RaAllowed

attr_lo_ra_wan_report_dev_status_battery

The ReportDevStatusBattery value.

CloudformationAttribute:: LoRaWAN.ReportDevStatusBattery

attr_lo_ra_wan_report_dev_status_margin

The ReportDevStatusMargin value.

CloudformationAttribute:: LoRaWAN.ReportDevStatusMargin

attr_lo_ra_wan_response

LoRaWANResponse

Type:: cloudformationAttribute

attr_lo_ra_wan_target_per

The TargetPer value.

CloudformationAttribute:: LoRaWAN.TargetPer

attr_lo_ra_wan_ul_bucket_size

The UlBucketSize value.

CloudformationAttribute:: LoRaWAN.UlBucketSize

attr_lo_ra_wan_ul_rate

The ULRate value.

CloudformationAttribute:: LoRaWAN.UlRate

attr_lo_ra_wan_ul_rate_policy

The ULRatePolicy value.

CloudformationAttribute:: LoRaWAN.UlRatePolicy

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 service profile object.

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

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.

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

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.

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

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

LoRaWANServiceProfileProperty

class CfnServiceProfile.LoRaWANServiceProfileProperty(*, add_gw_metadata=None, channel_mask=None, dev_status_req_freq=None, dl_bucket_size=None, dl_rate=None, dl_rate_policy=None, dr_max=None, dr_min=None, hr_allowed=None, min_gw_diversity=None, nwk_geo_loc=None, pr_allowed=None, ra_allowed=None, report_dev_status_battery=None, report_dev_status_margin=None, target_per=None, ul_bucket_size=None, ul_rate=None, ul_rate_policy=None)

Bases: object

LoRaWANServiceProfile object.

Parameters:

add_gw_metadata (Union[bool, IResolvable, None]) – The AddGWMetaData value.
channel_mask (Optional[str]) – The ChannelMask value. This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt
dev_status_req_freq (Union[int, float, None]) – The DevStatusReqFreq value. This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt
dl_bucket_size (Union[int, float, None]) – The DLBucketSize value. This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt
dl_rate (Union[int, float, None]) – The DLRate value. This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt
dl_rate_policy (Optional[str]) – The DLRatePolicy value. This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt
dr_max (Union[int, float, None]) – The DRMax value. This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt
dr_min (Union[int, float, None]) – The DRMin value. This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt
hr_allowed (Union[bool, IResolvable, None]) – The HRAllowed value that describes whether handover roaming is allowed. This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt
min_gw_diversity (Union[int, float, None]) – The MinGwDiversity value. This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt
nwk_geo_loc (Union[bool, IResolvable, None]) – The NwkGeoLoc value. This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt
pr_allowed (Union[bool, IResolvable, None]) – The PRAllowed value that describes whether passive roaming is allowed. This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt
ra_allowed (Union[bool, IResolvable, None]) – The RAAllowed value that describes whether roaming activation is allowed.
report_dev_status_battery (Union[bool, IResolvable, None]) – The ReportDevStatusBattery value. This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt
report_dev_status_margin (Union[bool, IResolvable, None]) – The ReportDevStatusMargin value. This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt
target_per (Union[int, float, None]) – The TargetPer value. This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt
ul_bucket_size (Union[int, float, None]) – The UlBucketSize value. This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt
ul_rate (Union[int, float, None]) – The ULRate value. This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt
ul_rate_policy (Optional[str]) – The ULRatePolicy value. This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html

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_wANService_profile_property = iotwireless.CfnServiceProfile.LoRaWANServiceProfileProperty(
    add_gw_metadata=False,
    channel_mask="channelMask",
    dev_status_req_freq=123,
    dl_bucket_size=123,
    dl_rate=123,
    dl_rate_policy="dlRatePolicy",
    dr_max=123,
    dr_min=123,
    hr_allowed=False,
    min_gw_diversity=123,
    nwk_geo_loc=False,
    pr_allowed=False,
    ra_allowed=False,
    report_dev_status_battery=False,
    report_dev_status_margin=False,
    target_per=123,
    ul_bucket_size=123,
    ul_rate=123,
    ul_rate_policy="ulRatePolicy"
)

Attributes

add_gw_metadata

The AddGWMetaData value.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-addgwmetadata

channel_mask

The ChannelMask value.

This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-channelmask

dev_status_req_freq

The DevStatusReqFreq value.

This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-devstatusreqfreq

dl_bucket_size

The DLBucketSize value.

This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-dlbucketsize

dl_rate

The DLRate value.

This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-dlrate

dl_rate_policy

The DLRatePolicy value.

This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-dlratepolicy

dr_max

The DRMax value.

This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-drmax

dr_min

The DRMin value.

This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-drmin

hr_allowed

The HRAllowed value that describes whether handover roaming is allowed.

This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-hrallowed

min_gw_diversity

The MinGwDiversity value.

This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-mingwdiversity

nwk_geo_loc

The NwkGeoLoc value.

This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-nwkgeoloc

pr_allowed

The PRAllowed value that describes whether passive roaming is allowed.

This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-prallowed

ra_allowed

The RAAllowed value that describes whether roaming activation is allowed.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-raallowed

report_dev_status_battery

The ReportDevStatusBattery value.

This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-reportdevstatusbattery

report_dev_status_margin

The ReportDevStatusMargin value.

This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-reportdevstatusmargin

target_per

The TargetPer value.

This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-targetper

ul_bucket_size

The UlBucketSize value.

This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-ulbucketsize

ul_rate

The ULRate value.

This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-ulrate

ul_rate_policy

The ULRatePolicy value.

This property is ReadOnly and can’t be inputted for create. It’s returned with Fn::GetAtt

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-serviceprofile-lorawanserviceprofile.html#cfn-iotwireless-serviceprofile-lorawanserviceprofile-ulratepolicy