Class: Aws::Deadline::Types::UpdateFleetRequest

Inherits:

Struct

• Object
• Struct
• Aws::Deadline::Types::UpdateFleetRequest

Defined in:

gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:description]

Instance Attribute Summary

• #client_token ⇒ String

  The unique token which the server uses to recognize retries of the same request.

• #configuration ⇒ Types::FleetConfiguration

  The fleet configuration to update.

• #description ⇒ String

  The description of the fleet to update.

• #display_name ⇒ String

  The display name of the fleet to update.

• #farm_id ⇒ String

  The farm ID to update.

• #fleet_id ⇒ String

  The fleet ID to update.

• #host_configuration ⇒ Types::HostConfiguration

  Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

• #max_worker_count ⇒ Integer

  The maximum number of workers in the fleet.

• #min_worker_count ⇒ Integer

  The minimum number of workers in the fleet.

• #role_arn ⇒ String

  The IAM role ARN that the fleet's workers assume while running jobs.

Instance Attribute Details

#client_token ⇒ String

The unique token which the server uses to recognize retries of the same request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 12134

class UpdateFleetRequest < Struct.new(
  :farm_id,
  :fleet_id,
  :client_token,
  :display_name,
  :description,
  :role_arn,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :host_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#configuration ⇒ Types::FleetConfiguration

The fleet configuration to update.

Returns:

• (Types::FleetConfiguration)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 12134

class UpdateFleetRequest < Struct.new(
  :farm_id,
  :fleet_id,
  :client_token,
  :display_name,
  :description,
  :role_arn,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :host_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#description ⇒ String

The description of the fleet to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 12134

class UpdateFleetRequest < Struct.new(
  :farm_id,
  :fleet_id,
  :client_token,
  :display_name,
  :description,
  :role_arn,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :host_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#display_name ⇒ String

The display name of the fleet to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 12134

class UpdateFleetRequest < Struct.new(
  :farm_id,
  :fleet_id,
  :client_token,
  :display_name,
  :description,
  :role_arn,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :host_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#farm_id ⇒ String

The farm ID to update.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 12134

class UpdateFleetRequest < Struct.new(
  :farm_id,
  :fleet_id,
  :client_token,
  :display_name,
  :description,
  :role_arn,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :host_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#fleet_id ⇒ String

The fleet ID to update.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 12134

class UpdateFleetRequest < Struct.new(
  :farm_id,
  :fleet_id,
  :client_token,
  :display_name,
  :description,
  :role_arn,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :host_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#host_configuration ⇒ Types::HostConfiguration

Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

Returns:

• (Types::HostConfiguration)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 12134

class UpdateFleetRequest < Struct.new(
  :farm_id,
  :fleet_id,
  :client_token,
  :display_name,
  :description,
  :role_arn,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :host_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#max_worker_count ⇒ Integer

The maximum number of workers in the fleet.

Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.

Returns:

• (Integer)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 12134

class UpdateFleetRequest < Struct.new(
  :farm_id,
  :fleet_id,
  :client_token,
  :display_name,
  :description,
  :role_arn,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :host_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#min_worker_count ⇒ Integer

The minimum number of workers in the fleet.

Returns:

• (Integer)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 12134

class UpdateFleetRequest < Struct.new(
  :farm_id,
  :fleet_id,
  :client_token,
  :display_name,
  :description,
  :role_arn,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :host_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end

#role_arn ⇒ String

The IAM role ARN that the fleet's workers assume while running jobs.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 12134

class UpdateFleetRequest < Struct.new(
  :farm_id,
  :fleet_id,
  :client_token,
  :display_name,
  :description,
  :role_arn,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :host_configuration)
  SENSITIVE = [:description]
  include Aws::Structure
end