Class: AWSCDK::DeviceFarm::CfnNetworkProfile

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSDevicefarm::INetworkProfileRef
Defined in:
device_farm/cfn_network_profile.rb

Overview

Creates a network profile.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnNetworkProfile

Create a new AWS::DeviceFarm::NetworkProfile.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::DeviceFarm::CfnNetworkProfileProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'device_farm/cfn_network_profile.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::DeviceFarm::CfnNetworkProfileProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGV2aWNlZmFybS5DZm5OZXR3b3JrUHJvZmlsZVByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_network_profile(resource) ⇒ String

Parameters:

Returns:

  • (String) 


83
84
85
86
 
# File 'device_farm/cfn_network_profile.rb', line 83

def self.arn_for_network_profile(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19kZXZpY2VmYXJtLklOZXR3b3JrUHJvZmlsZVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_devicefarm.CfnNetworkProfile", "arnForNetworkProfile", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


190
191
192
 
# File 'device_farm/cfn_network_profile.rb', line 190

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

.is_cfn_network_profile(x) ⇒ Boolean

Checks whether the given object is a CfnNetworkProfile.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


92
93
94
95
 
# File 'device_farm/cfn_network_profile.rb', line 92

def self.is_cfn_network_profile(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_devicefarm.CfnNetworkProfile", "isCfnNetworkProfile", [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
 
# File 'device_farm/cfn_network_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 },
    :network_profile_ref => { kind: :property, name: "networkProfileRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :project_arn => { kind: :property, name: "projectArn", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: true },
    :downlink_bandwidth_bits => { kind: :property, name: "downlinkBandwidthBits", is_optional: true },
    :downlink_delay_ms => { kind: :property, name: "downlinkDelayMs", is_optional: true },
    :downlink_jitter_ms => { kind: :property, name: "downlinkJitterMs", is_optional: true },
    :downlink_loss_percent => { kind: :property, name: "downlinkLossPercent", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :uplink_bandwidth_bits => { kind: :property, name: "uplinkBandwidthBits", is_optional: true },
    :uplink_delay_ms => { kind: :property, name: "uplinkDelayMs", is_optional: true },
    :uplink_jitter_ms => { kind: :property, name: "uplinkJitterMs", is_optional: true },
    :uplink_loss_percent => { kind: :property, name: "uplinkLossPercent", 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.



398
399
400
401
 
# File 'device_farm/cfn_network_profile.rb', line 398

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:



410
411
412
413
 
# File 'device_farm/cfn_network_profile.rb', line 410

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:



420
421
422
423
 
# File 'device_farm/cfn_network_profile.rb', line 420

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:



431
432
433
434
435
 
# File 'device_farm/cfn_network_profile.rb', line 431

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.


488
489
490
491
492
 
# File 'device_farm/cfn_network_profile.rb', line 488

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.



498
499
500
501
 
# File 'device_farm/cfn_network_profile.rb', line 498

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.



510
511
512
513
514
 
# File 'device_farm/cfn_network_profile.rb', line 510

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:



523
524
525
526
 
# File 'device_farm/cfn_network_profile.rb', line 523

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:



545
546
547
548
549
550
 
# File 'device_farm/cfn_network_profile.rb', line 545

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 Amazon Resource Name (ARN) of the network profile.

See Amazon resource names in the General Reference guide .

Returns:

  • (String) 


199
200
201
 
# File 'device_farm/cfn_network_profile.rb', line 199

def attr_arn()
  jsii_get_property("attrArn")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



143
144
145
 
# File 'device_farm/cfn_network_profile.rb', line 143

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


148
149
150
 
# File 'device_farm/cfn_network_profile.rb', line 148

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


554
555
556
557
 
# File 'device_farm/cfn_network_profile.rb', line 554

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


153
154
155
 
# File 'device_farm/cfn_network_profile.rb', line 153

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


160
161
162
 
# File 'device_farm/cfn_network_profile.rb', line 160

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


105
106
107
 
# File 'device_farm/cfn_network_profile.rb', line 105

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of the network profile.

Returns:

  • (String, nil) 


244
245
246
 
# File 'device_farm/cfn_network_profile.rb', line 244

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



248
249
250
251
 
# File 'device_farm/cfn_network_profile.rb', line 248

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

#downlink_bandwidth_bits ⇒ Numeric?

The data throughput rate in bits per second, as an integer from 0 to 104857600.

Returns:

  • (Numeric, nil) 


256
257
258
 
# File 'device_farm/cfn_network_profile.rb', line 256

def downlink_bandwidth_bits()
  jsii_get_property("downlinkBandwidthBits")
end

#downlink_bandwidth_bits=(value) ⇒ Object 



260
261
262
263
 
# File 'device_farm/cfn_network_profile.rb', line 260

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

#downlink_delay_ms ⇒ Numeric?

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

Returns:

  • (Numeric, nil) 


268
269
270
 
# File 'device_farm/cfn_network_profile.rb', line 268

def downlink_delay_ms()
  jsii_get_property("downlinkDelayMs")
end

#downlink_delay_ms=(value) ⇒ Object 



272
273
274
275
 
# File 'device_farm/cfn_network_profile.rb', line 272

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

#downlink_jitter_ms ⇒ Numeric?

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

Returns:

  • (Numeric, nil) 


280
281
282
 
# File 'device_farm/cfn_network_profile.rb', line 280

def downlink_jitter_ms()
  jsii_get_property("downlinkJitterMs")
end

#downlink_jitter_ms=(value) ⇒ Object 



284
285
286
287
 
# File 'device_farm/cfn_network_profile.rb', line 284

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

#downlink_loss_percent ⇒ Numeric?

Proportion of received packets that fail to arrive from 0 to 100 percent.

Returns:

  • (Numeric, nil) 


292
293
294
 
# File 'device_farm/cfn_network_profile.rb', line 292

def downlink_loss_percent()
  jsii_get_property("downlinkLossPercent")
end

#downlink_loss_percent=(value) ⇒ Object 



296
297
298
299
 
# File 'device_farm/cfn_network_profile.rb', line 296

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



165
166
167
 
# File 'device_farm/cfn_network_profile.rb', line 165

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:



567
568
569
570
571
 
# File 'device_farm/cfn_network_profile.rb', line 567

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:



578
579
580
581
 
# File 'device_farm/cfn_network_profile.rb', line 578

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:



648
649
650
651
 
# File 'device_farm/cfn_network_profile.rb', line 648

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


117
118
119
 
# File 'device_farm/cfn_network_profile.rb', line 117

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the network profile.

Returns:

  • (String) 


220
221
222
 
# File 'device_farm/cfn_network_profile.rb', line 220

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



224
225
226
227
 
# File 'device_farm/cfn_network_profile.rb', line 224

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

#network_profile_ref ⇒ AWSCDK::Interfaces::AWSDevicefarm::NetworkProfileReference

A reference to a NetworkProfile resource.

Returns:



206
207
208
 
# File 'device_farm/cfn_network_profile.rb', line 206

def network_profile_ref()
  jsii_get_property("networkProfileRef")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


100
101
102
 
# File 'device_farm/cfn_network_profile.rb', line 100

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:



589
590
591
 
# File 'device_farm/cfn_network_profile.rb', line 589

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:



596
597
598
 
# File 'device_farm/cfn_network_profile.rb', line 596

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.



389
390
391
392
 
# File 'device_farm/cfn_network_profile.rb', line 389

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

#project_arn ⇒ String

The Amazon Resource Name (ARN) of the specified project.

Returns:

  • (String) 


232
233
234
 
# File 'device_farm/cfn_network_profile.rb', line 232

def project_arn()
  jsii_get_property("projectArn")
end

#project_arn=(value) ⇒ Object 



236
237
238
239
 
# File 'device_farm/cfn_network_profile.rb', line 236

def project_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "projectArn")
  jsii_set_property("projectArn", value)
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) 


136
137
138
 
# File 'device_farm/cfn_network_profile.rb', line 136

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:



607
608
609
610
 
# File 'device_farm/cfn_network_profile.rb', line 607

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


614
615
616
617
 
# File 'device_farm/cfn_network_profile.rb', line 614

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:



624
625
626
627
628
 
# File 'device_farm/cfn_network_profile.rb', line 624

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

#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.



633
634
635
 
# File 'device_farm/cfn_network_profile.rb', line 633

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:



126
127
128
 
# File 'device_farm/cfn_network_profile.rb', line 126

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



213
214
215
 
# File 'device_farm/cfn_network_profile.rb', line 213

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

An array of key-value pairs to apply to this resource.

Returns:



304
305
306
 
# File 'device_farm/cfn_network_profile.rb', line 304

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



308
309
310
311
312
 
# File 'device_farm/cfn_network_profile.rb', line 308

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



365
366
367
 
# File 'device_farm/cfn_network_profile.rb', line 365

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


173
174
175
 
# File 'device_farm/cfn_network_profile.rb', line 173

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


183
184
185
 
# File 'device_farm/cfn_network_profile.rb', line 183

def updated_properties()
  jsii_get_property("updatedProperties")
end

#uplink_bandwidth_bits ⇒ Numeric?

The data throughput rate in bits per second, as an integer from 0 to 104857600.

Returns:

  • (Numeric, nil) 


317
318
319
 
# File 'device_farm/cfn_network_profile.rb', line 317

def uplink_bandwidth_bits()
  jsii_get_property("uplinkBandwidthBits")
end

#uplink_bandwidth_bits=(value) ⇒ Object 



321
322
323
324
 
# File 'device_farm/cfn_network_profile.rb', line 321

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

#uplink_delay_ms ⇒ Numeric?

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

Returns:

  • (Numeric, nil) 


329
330
331
 
# File 'device_farm/cfn_network_profile.rb', line 329

def uplink_delay_ms()
  jsii_get_property("uplinkDelayMs")
end

#uplink_delay_ms=(value) ⇒ Object 



333
334
335
336
 
# File 'device_farm/cfn_network_profile.rb', line 333

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

#uplink_jitter_ms ⇒ Numeric?

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

Returns:

  • (Numeric, nil) 


341
342
343
 
# File 'device_farm/cfn_network_profile.rb', line 341

def uplink_jitter_ms()
  jsii_get_property("uplinkJitterMs")
end

#uplink_jitter_ms=(value) ⇒ Object 



345
346
347
348
 
# File 'device_farm/cfn_network_profile.rb', line 345

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

#uplink_loss_percent ⇒ Numeric?

Proportion of transmitted packets that fail to arrive from 0 to 100 percent.

Returns:

  • (Numeric, nil) 


353
354
355
 
# File 'device_farm/cfn_network_profile.rb', line 353

def uplink_loss_percent()
  jsii_get_property("uplinkLossPercent")
end

#uplink_loss_percent=(value) ⇒ Object 



357
358
359
360
 
# File 'device_farm/cfn_network_profile.rb', line 357

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

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


639
640
641
642
 
# File 'device_farm/cfn_network_profile.rb', line 639

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) 


378
379
380
381
382
383
 
# File 'device_farm/cfn_network_profile.rb', line 378

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