Class: AWSCDK::DeviceFarm::CfnNetworkProfileProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
device_farm/cfn_network_profile_props.rb

Overview

Properties for defining a CfnNetworkProfile.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, project_arn:, description: nil, downlink_bandwidth_bits: nil, downlink_delay_ms: nil, downlink_jitter_ms: nil, downlink_loss_percent: nil, tags: nil, uplink_bandwidth_bits: nil, uplink_delay_ms: nil, uplink_jitter_ms: nil, uplink_loss_percent: nil) ⇒ CfnNetworkProfileProps

Returns a new instance of CfnNetworkProfileProps.

Parameters:

  • name (String) —

    The name of the network profile.

  • project_arn (String) —

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

  • description (String, nil) (defaults to: nil) —

    The description of the network profile.

  • downlink_bandwidth_bits (Numeric, nil) (defaults to: nil) —

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

  • downlink_delay_ms (Numeric, nil) (defaults to: nil) —

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

  • downlink_jitter_ms (Numeric, nil) (defaults to: nil) —

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

  • downlink_loss_percent (Numeric, nil) (defaults to: nil) —

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

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

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

  • uplink_bandwidth_bits (Numeric, nil) (defaults to: nil) —

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

  • uplink_delay_ms (Numeric, nil) (defaults to: nil) —

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

  • uplink_jitter_ms (Numeric, nil) (defaults to: nil) —

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

  • uplink_loss_percent (Numeric, nil) (defaults to: nil) —

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



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'device_farm/cfn_network_profile_props.rb', line 21

def initialize(name:, project_arn:, description: nil, downlink_bandwidth_bits: nil, downlink_delay_ms: nil, downlink_jitter_ms: nil, downlink_loss_percent: nil, tags: nil, uplink_bandwidth_bits: nil, uplink_delay_ms: nil, uplink_jitter_ms: nil, uplink_loss_percent: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @project_arn = project_arn
  Jsii::Type.check_type(@project_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "projectArn")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @downlink_bandwidth_bits = downlink_bandwidth_bits
  Jsii::Type.check_type(@downlink_bandwidth_bits, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "downlinkBandwidthBits") unless @downlink_bandwidth_bits.nil?
  @downlink_delay_ms = downlink_delay_ms
  Jsii::Type.check_type(@downlink_delay_ms, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "downlinkDelayMs") unless @downlink_delay_ms.nil?
  @downlink_jitter_ms = downlink_jitter_ms
  Jsii::Type.check_type(@downlink_jitter_ms, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "downlinkJitterMs") unless @downlink_jitter_ms.nil?
  @downlink_loss_percent = downlink_loss_percent
  Jsii::Type.check_type(@downlink_loss_percent, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "downlinkLossPercent") unless @downlink_loss_percent.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @uplink_bandwidth_bits = uplink_bandwidth_bits
  Jsii::Type.check_type(@uplink_bandwidth_bits, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "uplinkBandwidthBits") unless @uplink_bandwidth_bits.nil?
  @uplink_delay_ms = uplink_delay_ms
  Jsii::Type.check_type(@uplink_delay_ms, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "uplinkDelayMs") unless @uplink_delay_ms.nil?
  @uplink_jitter_ms = uplink_jitter_ms
  Jsii::Type.check_type(@uplink_jitter_ms, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "uplinkJitterMs") unless @uplink_jitter_ms.nil?
  @uplink_loss_percent = uplink_loss_percent
  Jsii::Type.check_type(@uplink_loss_percent, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "uplinkLossPercent") unless @uplink_loss_percent.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

The description of the network profile.

Returns:

  • (String, nil)

See Also:



62
63
64
 
# File 'device_farm/cfn_network_profile_props.rb', line 62

def description
  @description
end

#downlink_bandwidth_bits ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



67
68
69
 
# File 'device_farm/cfn_network_profile_props.rb', line 67

def downlink_bandwidth_bits
  @downlink_bandwidth_bits
end

#downlink_delay_ms ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



72
73
74
 
# File 'device_farm/cfn_network_profile_props.rb', line 72

def downlink_delay_ms
  @downlink_delay_ms
end

#downlink_jitter_ms ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



77
78
79
 
# File 'device_farm/cfn_network_profile_props.rb', line 77

def downlink_jitter_ms
  @downlink_jitter_ms
end

#downlink_loss_percent ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



82
83
84
 
# File 'device_farm/cfn_network_profile_props.rb', line 82

def downlink_loss_percent
  @downlink_loss_percent
end

#name ⇒ String (readonly)

The name of the network profile.

Returns:

  • (String)

See Also:



52
53
54
 
# File 'device_farm/cfn_network_profile_props.rb', line 52

def name
  @name
end

#project_arn ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



57
58
59
 
# File 'device_farm/cfn_network_profile_props.rb', line 57

def project_arn
  @project_arn
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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

For more information, see Tag in the guide .

Returns:

See Also:



89
90
91
 
# File 'device_farm/cfn_network_profile_props.rb', line 89

def tags
  @tags
end

#uplink_bandwidth_bits ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



94
95
96
 
# File 'device_farm/cfn_network_profile_props.rb', line 94

def uplink_bandwidth_bits
  @uplink_bandwidth_bits
end

#uplink_delay_ms ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



99
100
101
 
# File 'device_farm/cfn_network_profile_props.rb', line 99

def uplink_delay_ms
  @uplink_delay_ms
end

#uplink_jitter_ms ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



104
105
106
 
# File 'device_farm/cfn_network_profile_props.rb', line 104

def uplink_jitter_ms
  @uplink_jitter_ms
end

#uplink_loss_percent ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



109
110
111
 
# File 'device_farm/cfn_network_profile_props.rb', line 109

def uplink_loss_percent
  @uplink_loss_percent
end

Class Method Details

.jsii_properties ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'device_farm/cfn_network_profile_props.rb', line 111

def self.jsii_properties
  {
    :name => "name",
    :project_arn => "projectArn",
    :description => "description",
    :downlink_bandwidth_bits => "downlinkBandwidthBits",
    :downlink_delay_ms => "downlinkDelayMs",
    :downlink_jitter_ms => "downlinkJitterMs",
    :downlink_loss_percent => "downlinkLossPercent",
    :tags => "tags",
    :uplink_bandwidth_bits => "uplinkBandwidthBits",
    :uplink_delay_ms => "uplinkDelayMs",
    :uplink_jitter_ms => "uplinkJitterMs",
    :uplink_loss_percent => "uplinkLossPercent",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'device_farm/cfn_network_profile_props.rb', line 128

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "projectArn" => @project_arn,
    "description" => @description,
    "downlinkBandwidthBits" => @downlink_bandwidth_bits,
    "downlinkDelayMs" => @downlink_delay_ms,
    "downlinkJitterMs" => @downlink_jitter_ms,
    "downlinkLossPercent" => @downlink_loss_percent,
    "tags" => @tags,
    "uplinkBandwidthBits" => @uplink_bandwidth_bits,
    "uplinkDelayMs" => @uplink_delay_ms,
    "uplinkJitterMs" => @uplink_jitter_ms,
    "uplinkLossPercent" => @uplink_loss_percent,
  })
  result.compact
end