CfnServiceProfilePropsMixin

class aws_cdk.mixins_preview.aws_iotwireless.mixins.CfnServiceProfilePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a new service profile.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-serviceprofile.html
CloudformationResource:: AWS::IoTWireless::ServiceProfile
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_service_profile_props_mixin = iotwireless_mixins.CfnServiceProfilePropsMixin(iotwireless_mixins.CfnServiceProfileMixinProps(
    lo_ra_wan=iotwireless_mixins.CfnServiceProfilePropsMixin.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"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoTWireless::ServiceProfile.

Parameters:

props (Union[CfnServiceProfileMixinProps, 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:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['loRaWan', 'name', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

LoRaWANServiceProfileProperty

class CfnServiceProfilePropsMixin.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

See:

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.
from aws_cdk.mixins_preview.aws_iotwireless import mixins as iotwireless_mixins

lo_ra_wANService_profile_property = iotwireless_mixins.CfnServiceProfilePropsMixin.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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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