Class: Aws::DeviceFarm::Types::UpdateDevicePoolRequest

Inherits:

Struct

• Object
• Struct
• Aws::DeviceFarm::Types::UpdateDevicePoolRequest

Includes:

Structure

Defined in:

lib/aws-sdk-devicefarm/types.rb

Overview

Represents a request to the update device pool operation.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the Device Farm device pool to update.

• #clear_max_devices ⇒ Boolean

  Sets whether the ‘maxDevices` parameter applies to your device pool.

• #description ⇒ String

  A description of the device pool to update.

• #max_devices ⇒ Integer

  The number of devices that Device Farm can add to your device pool.

• #name ⇒ String

  A string that represents the name of the device pool to update.

• #rules ⇒ Array<Types::Rule>

  Represents the rules to modify for the device pool.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the Device Farm device pool to update.

Returns:

• (String)

# File 'lib/aws-sdk-devicefarm/types.rb', line 5987

class UpdateDevicePoolRequest < Struct.new(
  :arn,
  :name,
  :description,
  :rules,
  :max_devices,
  :clear_max_devices)
  SENSITIVE = []
  include Aws::Structure
end

#clear_max_devices ⇒ Boolean

Sets whether the ‘maxDevices` parameter applies to your device pool. If you set this parameter to `true`, the `maxDevices` parameter does not apply, and Device Farm does not limit the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that meet the criteria specified in the `rules` parameter.

If you use this parameter in your request, you cannot use the ‘maxDevices` parameter in the same request.

Returns:

• (Boolean)

# File 'lib/aws-sdk-devicefarm/types.rb', line 5987

class UpdateDevicePoolRequest < Struct.new(
  :arn,
  :name,
  :description,
  :rules,
  :max_devices,
  :clear_max_devices)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the device pool to update.

Returns:

• (String)

# File 'lib/aws-sdk-devicefarm/types.rb', line 5987

class UpdateDevicePoolRequest < Struct.new(
  :arn,
  :name,
  :description,
  :rules,
  :max_devices,
  :clear_max_devices)
  SENSITIVE = []
  include Aws::Structure
end

#max_devices ⇒ Integer

The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the ‘rules` parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.

By specifying the maximum number of devices, you can control the costs that you incur by running tests.

If you use this parameter in your request, you cannot use the ‘clearMaxDevices` parameter in the same request.

Returns:

• (Integer)

# File 'lib/aws-sdk-devicefarm/types.rb', line 5987

class UpdateDevicePoolRequest < Struct.new(
  :arn,
  :name,
  :description,
  :rules,
  :max_devices,
  :clear_max_devices)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A string that represents the name of the device pool to update.

Returns:

• (String)

# File 'lib/aws-sdk-devicefarm/types.rb', line 5987

class UpdateDevicePoolRequest < Struct.new(
  :arn,
  :name,
  :description,
  :rules,
  :max_devices,
  :clear_max_devices)
  SENSITIVE = []
  include Aws::Structure
end

#rules ⇒ Array<Types::Rule>

Represents the rules to modify for the device pool. Updating rules is optional. If you update rules for your request, the update replaces the existing rules.

Returns:

• (Array<Types::Rule>)

# File 'lib/aws-sdk-devicefarm/types.rb', line 5987

class UpdateDevicePoolRequest < Struct.new(
  :arn,
  :name,
  :description,
  :rules,
  :max_devices,
  :clear_max_devices)
  SENSITIVE = []
  include Aws::Structure
end