Class: AWSCDK::IoTWireless::CfnServiceProfile

Inherits:
CfnResource
  • Object
show all
Includes:
AWSCDK::IInspectable, AWSCDK::ITaggable, AWSCDK::Interfaces::AWSIotwireless::IServiceProfileRef
Defined in:
io_t_wireless/cfn_service_profile.rb

Overview

Creates a new service profile.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnServiceProfile

Create a new AWS::IoTWireless::ServiceProfile.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::IoTWireless::CfnServiceProfileProps, nil) (defaults to: nil) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'io_t_wireless/cfn_service_profile.rb', line 18

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::IoTWireless::CfnServiceProfileProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90d2lyZWxlc3MuQ2ZuU2VydmljZVByb2ZpbGVQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_service_profile(resource) ⇒ String

Parameters:

Returns:

  • (String) 


92
93
94
95
 
# File 'io_t_wireless/cfn_service_profile.rb', line 92

def self.arn_for_service_profile(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pb3R3aXJlbGVzcy5JU2VydmljZVByb2ZpbGVSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotwireless.CfnServiceProfile", "arnForServiceProfile", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


225
226
227
 
# File 'io_t_wireless/cfn_service_profile.rb', line 225

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_iotwireless.CfnServiceProfile", "CFN_RESOURCE_TYPE_NAME")
end

.from_service_profile_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSIotwireless::IServiceProfileRef

Creates a new IServiceProfileRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



103
104
105
106
107
108
 
# File 'io_t_wireless/cfn_service_profile.rb', line 103

def self.from_service_profile_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotwireless.CfnServiceProfile", "fromServiceProfileArn", [scope, id, arn])
end

.from_service_profile_id(scope, id, service_profile_id) ⇒ AWSCDK::Interfaces::AWSIotwireless::IServiceProfileRef

Creates a new IServiceProfileRef from a serviceProfileId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • service_profile_id (String)

Returns:



116
117
118
119
120
121
 
# File 'io_t_wireless/cfn_service_profile.rb', line 116

def self.from_service_profile_id(scope, id, service_profile_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(service_profile_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serviceProfileId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotwireless.CfnServiceProfile", "fromServiceProfileId", [scope, id, service_profile_id])
end

.is_cfn_service_profile(x) ⇒ Boolean

Checks whether the given object is a CfnServiceProfile.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


127
128
129
130
 
# File 'io_t_wireless/cfn_service_profile.rb', line 127

def self.is_cfn_service_profile(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotwireless.CfnServiceProfile", "isCfnServiceProfile", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'io_t_wireless/cfn_service_profile.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_lo_ra_wan_channel_mask => { kind: :property, name: "attrLoRaWanChannelMask", is_optional: false },
    :attr_lo_ra_wan_dev_status_req_freq => { kind: :property, name: "attrLoRaWanDevStatusReqFreq", is_optional: false },
    :attr_lo_ra_wan_dl_bucket_size => { kind: :property, name: "attrLoRaWanDlBucketSize", is_optional: false },
    :attr_lo_ra_wan_dl_rate => { kind: :property, name: "attrLoRaWanDlRate", is_optional: false },
    :attr_lo_ra_wan_dl_rate_policy => { kind: :property, name: "attrLoRaWanDlRatePolicy", is_optional: false },
    :attr_lo_ra_wan_dr_max => { kind: :property, name: "attrLoRaWanDrMax", is_optional: false },
    :attr_lo_ra_wan_dr_min => { kind: :property, name: "attrLoRaWanDrMin", is_optional: false },
    :attr_lo_ra_wan_hr_allowed => { kind: :property, name: "attrLoRaWanHrAllowed", is_optional: false },
    :attr_lo_ra_wan_min_gw_diversity => { kind: :property, name: "attrLoRaWanMinGwDiversity", is_optional: false },
    :attr_lo_ra_wan_nwk_geo_loc => { kind: :property, name: "attrLoRaWanNwkGeoLoc", is_optional: false },
    :attr_lo_ra_wan_report_dev_status_battery => { kind: :property, name: "attrLoRaWanReportDevStatusBattery", is_optional: false },
    :attr_lo_ra_wan_report_dev_status_margin => { kind: :property, name: "attrLoRaWanReportDevStatusMargin", is_optional: false },
    :attr_lo_ra_wan_response => { kind: :property, name: "attrLoRaWanResponse", is_optional: false },
    :attr_lo_ra_wan_target_per => { kind: :property, name: "attrLoRaWanTargetPer", is_optional: false },
    :attr_lo_ra_wan_ul_bucket_size => { kind: :property, name: "attrLoRaWanUlBucketSize", is_optional: false },
    :attr_lo_ra_wan_ul_rate => { kind: :property, name: "attrLoRaWanUlRate", is_optional: false },
    :attr_lo_ra_wan_ul_rate_policy => { kind: :property, name: "attrLoRaWanUlRatePolicy", is_optional: false },
    :service_profile_ref => { kind: :property, name: "serviceProfileRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :lo_ra_wan => { kind: :property, name: "loRaWan", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



448
449
450
451
 
# File 'io_t_wireless/cfn_service_profile.rb', line 448

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

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:



460
461
462
463
 
# File 'io_t_wireless/cfn_service_profile.rb', line 460

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



470
471
472
473
 
# File 'io_t_wireless/cfn_service_profile.rb', line 470

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



481
482
483
484
485
 
# File 'io_t_wireless/cfn_service_profile.rb', line 481

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override 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,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override 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 (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


538
539
540
541
542
 
# File 'io_t_wireless/cfn_service_profile.rb', line 538

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



548
549
550
551
 
# File 'io_t_wireless/cfn_service_profile.rb', line 548

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



560
561
562
563
564
 
# File 'io_t_wireless/cfn_service_profile.rb', line 560

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



573
574
575
576
 
# File 'io_t_wireless/cfn_service_profile.rb', line 573

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



595
596
597
598
599
600
 
# File 'io_t_wireless/cfn_service_profile.rb', line 595

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The ARN of the service profile created.

Returns:

  • (String) 


232
233
234
 
# File 'io_t_wireless/cfn_service_profile.rb', line 232

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_id ⇒ String

The ID of the service profile created.

Returns:

  • (String) 


239
240
241
 
# File 'io_t_wireless/cfn_service_profile.rb', line 239

def attr_id()
  jsii_get_property("attrId")
end

#attr_lo_ra_wan_channel_mask ⇒ String

The ChannelMask value.

Returns:

  • (String) 


246
247
248
 
# File 'io_t_wireless/cfn_service_profile.rb', line 246

def attr_lo_ra_wan_channel_mask()
  jsii_get_property("attrLoRaWanChannelMask")
end

#attr_lo_ra_wan_dev_status_req_freq ⇒ Numeric

The DevStatusReqFreq value.

Returns:

  • (Numeric) 


253
254
255
 
# File 'io_t_wireless/cfn_service_profile.rb', line 253

def attr_lo_ra_wan_dev_status_req_freq()
  jsii_get_property("attrLoRaWanDevStatusReqFreq")
end

#attr_lo_ra_wan_dl_bucket_size ⇒ Numeric

The DLBucketSize value.

Returns:

  • (Numeric) 


260
261
262
 
# File 'io_t_wireless/cfn_service_profile.rb', line 260

def attr_lo_ra_wan_dl_bucket_size()
  jsii_get_property("attrLoRaWanDlBucketSize")
end

#attr_lo_ra_wan_dl_rate ⇒ Numeric

The DLRate value.

Returns:

  • (Numeric) 


267
268
269
 
# File 'io_t_wireless/cfn_service_profile.rb', line 267

def attr_lo_ra_wan_dl_rate()
  jsii_get_property("attrLoRaWanDlRate")
end

#attr_lo_ra_wan_dl_rate_policy ⇒ String

The DLRatePolicy value.

Returns:

  • (String) 


274
275
276
 
# File 'io_t_wireless/cfn_service_profile.rb', line 274

def attr_lo_ra_wan_dl_rate_policy()
  jsii_get_property("attrLoRaWanDlRatePolicy")
end

#attr_lo_ra_wan_dr_max ⇒ Numeric

The DRMax value.

Returns:

  • (Numeric) 


281
282
283
 
# File 'io_t_wireless/cfn_service_profile.rb', line 281

def attr_lo_ra_wan_dr_max()
  jsii_get_property("attrLoRaWanDrMax")
end

#attr_lo_ra_wan_dr_min ⇒ Numeric

The DRMin value.

Returns:

  • (Numeric) 


288
289
290
 
# File 'io_t_wireless/cfn_service_profile.rb', line 288

def attr_lo_ra_wan_dr_min()
  jsii_get_property("attrLoRaWanDrMin")
end

#attr_lo_ra_wan_hr_allowed ⇒ AWSCDK::IResolvable

The HRAllowed value that describes whether handover roaming is allowed.

Returns:



295
296
297
 
# File 'io_t_wireless/cfn_service_profile.rb', line 295

def attr_lo_ra_wan_hr_allowed()
  jsii_get_property("attrLoRaWanHrAllowed")
end

#attr_lo_ra_wan_min_gw_diversity ⇒ Numeric

The MinGwDiversity value.

Returns:

  • (Numeric) 


302
303
304
 
# File 'io_t_wireless/cfn_service_profile.rb', line 302

def attr_lo_ra_wan_min_gw_diversity()
  jsii_get_property("attrLoRaWanMinGwDiversity")
end

#attr_lo_ra_wan_nwk_geo_loc ⇒ AWSCDK::IResolvable

The NwkGeoLoc value.

Returns:



309
310
311
 
# File 'io_t_wireless/cfn_service_profile.rb', line 309

def attr_lo_ra_wan_nwk_geo_loc()
  jsii_get_property("attrLoRaWanNwkGeoLoc")
end

#attr_lo_ra_wan_report_dev_status_battery ⇒ AWSCDK::IResolvable

The ReportDevStatusBattery value.

Returns:



316
317
318
 
# File 'io_t_wireless/cfn_service_profile.rb', line 316

def attr_lo_ra_wan_report_dev_status_battery()
  jsii_get_property("attrLoRaWanReportDevStatusBattery")
end

#attr_lo_ra_wan_report_dev_status_margin ⇒ AWSCDK::IResolvable

The ReportDevStatusMargin value.

Returns:



323
324
325
 
# File 'io_t_wireless/cfn_service_profile.rb', line 323

def attr_lo_ra_wan_report_dev_status_margin()
  jsii_get_property("attrLoRaWanReportDevStatusMargin")
end

#attr_lo_ra_wan_response ⇒ AWSCDK::IResolvable

Returns:



328
329
330
 
# File 'io_t_wireless/cfn_service_profile.rb', line 328

def attr_lo_ra_wan_response()
  jsii_get_property("attrLoRaWanResponse")
end

#attr_lo_ra_wan_target_per ⇒ Numeric

The TargetPer value.

Returns:

  • (Numeric) 


335
336
337
 
# File 'io_t_wireless/cfn_service_profile.rb', line 335

def attr_lo_ra_wan_target_per()
  jsii_get_property("attrLoRaWanTargetPer")
end

#attr_lo_ra_wan_ul_bucket_size ⇒ Numeric

The UlBucketSize value.

Returns:

  • (Numeric) 


342
343
344
 
# File 'io_t_wireless/cfn_service_profile.rb', line 342

def attr_lo_ra_wan_ul_bucket_size()
  jsii_get_property("attrLoRaWanUlBucketSize")
end

#attr_lo_ra_wan_ul_rate ⇒ Numeric

The ULRate value.

Returns:

  • (Numeric) 


349
350
351
 
# File 'io_t_wireless/cfn_service_profile.rb', line 349

def attr_lo_ra_wan_ul_rate()
  jsii_get_property("attrLoRaWanUlRate")
end

#attr_lo_ra_wan_ul_rate_policy ⇒ String

The ULRatePolicy value.

Returns:

  • (String) 


356
357
358
 
# File 'io_t_wireless/cfn_service_profile.rb', line 356

def attr_lo_ra_wan_ul_rate_policy()
  jsii_get_property("attrLoRaWanUlRatePolicy")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



178
179
180
 
# File 'io_t_wireless/cfn_service_profile.rb', line 178

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


183
184
185
 
# File 'io_t_wireless/cfn_service_profile.rb', line 183

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


604
605
606
607
 
# File 'io_t_wireless/cfn_service_profile.rb', line 604

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


188
189
190
 
# File 'io_t_wireless/cfn_service_profile.rb', line 188

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


195
196
197
 
# File 'io_t_wireless/cfn_service_profile.rb', line 195

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


140
141
142
 
# File 'io_t_wireless/cfn_service_profile.rb', line 140

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



200
201
202
 
# File 'io_t_wireless/cfn_service_profile.rb', line 200

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

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:

Returns:



617
618
619
620
621
 
# File 'io_t_wireless/cfn_service_profile.rb', line 617

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



628
629
630
631
 
# File 'io_t_wireless/cfn_service_profile.rb', line 628

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



698
699
700
701
 
# File 'io_t_wireless/cfn_service_profile.rb', line 698

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#lo_ra_wan ⇒ AWSCDK::IResolvable, ...

LoRaWAN service profile object.

Returns:



377
378
379
 
# File 'io_t_wireless/cfn_service_profile.rb', line 377

def lo_ra_wan()
  jsii_get_property("loRaWan")
end

#lo_ra_wan=(value) ⇒ Object 



381
382
383
384
385
 
# File 'io_t_wireless/cfn_service_profile.rb', line 381

def lo_ra_wan=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::IoTWireless::CfnServiceProfile::LoRaWANServiceProfileProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3R3aXJlbGVzcy5DZm5TZXJ2aWNlUHJvZmlsZS5Mb1JhV0FOU2VydmljZVByb2ZpbGVQcm9wZXJ0eSJ9XX19")), "loRaWan") unless value.nil?
  jsii_set_property("loRaWan", value)
end

#logical_id ⇒ String

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 override_logical_id(new_logical_id).

Returns:

  • (String) 


152
153
154
 
# File 'io_t_wireless/cfn_service_profile.rb', line 152

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

The name of the new resource.

Returns:

  • (String, nil) 


390
391
392
 
# File 'io_t_wireless/cfn_service_profile.rb', line 390

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



394
395
396
397
 
# File 'io_t_wireless/cfn_service_profile.rb', line 394

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless value.nil?
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


135
136
137
 
# File 'io_t_wireless/cfn_service_profile.rb', line 135

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



639
640
641
 
# File 'io_t_wireless/cfn_service_profile.rb', line 639

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



646
647
648
 
# File 'io_t_wireless/cfn_service_profile.rb', line 646

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



439
440
441
442
 
# File 'io_t_wireless/cfn_service_profile.rb', line 439

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

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 }).

Returns:

  • (String) 


171
172
173
 
# File 'io_t_wireless/cfn_service_profile.rb', line 171

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



657
658
659
660
 
# File 'io_t_wireless/cfn_service_profile.rb', line 657

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


664
665
666
667
 
# File 'io_t_wireless/cfn_service_profile.rb', line 664

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



674
675
676
677
678
 
# File 'io_t_wireless/cfn_service_profile.rb', line 674

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#service_profile_ref ⇒ AWSCDK::Interfaces::AWSIotwireless::ServiceProfileReference

A reference to a ServiceProfile resource.

Returns:



363
364
365
 
# File 'io_t_wireless/cfn_service_profile.rb', line 363

def service_profile_ref()
  jsii_get_property("serviceProfileRef")
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



683
684
685
 
# File 'io_t_wireless/cfn_service_profile.rb', line 683

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



161
162
163
 
# File 'io_t_wireless/cfn_service_profile.rb', line 161

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



370
371
372
 
# File 'io_t_wireless/cfn_service_profile.rb', line 370

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags are an array of key-value pairs to attach to the specified resource.

Returns:



402
403
404
 
# File 'io_t_wireless/cfn_service_profile.rb', line 402

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



406
407
408
409
410
 
# File 'io_t_wireless/cfn_service_profile.rb', line 406

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



415
416
417
 
# File 'io_t_wireless/cfn_service_profile.rb', line 415

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


208
209
210
 
# File 'io_t_wireless/cfn_service_profile.rb', line 208

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


218
219
220
 
# File 'io_t_wireless/cfn_service_profile.rb', line 218

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


689
690
691
692
 
# File 'io_t_wireless/cfn_service_profile.rb', line 689

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


428
429
430
431
432
433
 
# File 'io_t_wireless/cfn_service_profile.rb', line 428

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end