Class: Aws::Deadline::Types::GetFleetResponse

Inherits:

Struct

• Object
• Struct
• Aws::Deadline::Types::GetFleetResponse

Includes:

Structure

Defined in:

lib/aws-sdk-deadline/types.rb

Overview

Mixin that adds an optional ARN field to response structures. Apply to SummaryMixins (flows into Get, Summary, and BatchGet) and Create outputs.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:description]

Instance Attribute Summary

• #auto_scaling_status ⇒ String

  The Auto Scaling status of the fleet.

• #capabilities ⇒ Types::FleetCapabilities

  Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.

• #configuration ⇒ Types::FleetConfiguration

  The configuration setting for the fleet.

• #created_at ⇒ Time

  The date and time the resource was created.

• #created_by ⇒ String

  The user or system that created this resource.

• #description ⇒ String

  The description of the fleet.

• #display_name ⇒ String

  The display name of the fleet.

• #farm_id ⇒ String

  The farm ID of the farm in the fleet.

• #fleet_id ⇒ String

  The fleet ID.

• #host_configuration ⇒ Types::HostConfiguration

  The 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 specified in the fleet.

• #min_worker_count ⇒ Integer

  The minimum number of workers specified in the fleet.

• #role_arn ⇒ String

  The IAM role ARN.

• #status ⇒ String

  The status of the fleet.

• #status_message ⇒ String

  A message that communicates a suspended status of the fleet.

• #target_worker_count ⇒ Integer

  The number of target workers in the fleet.

• #updated_at ⇒ Time

  The date and time the resource was updated.

• #updated_by ⇒ String

  The user or system that updated this resource.

• #worker_count ⇒ Integer

  The number of workers in the fleet.

Instance Attribute Details

#auto_scaling_status ⇒ String

The Auto Scaling status of the fleet. Either ‘GROWING`, `STEADY`, or `SHRINKING`.

Returns:

• (String)

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

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end

#capabilities ⇒ Types::FleetCapabilities

Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.

Returns:

• (Types::FleetCapabilities)

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

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end

#configuration ⇒ Types::FleetConfiguration

The configuration setting for the fleet.

Returns:

• (Types::FleetConfiguration)

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

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end

#created_at ⇒ Time

The date and time the resource was created.

Returns:

• (Time)

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

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end

#created_by ⇒ String

The user or system that created this resource.

Returns:

• (String)

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

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end

#description ⇒ String

The description of the fleet.

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 'lib/aws-sdk-deadline/types.rb', line 4838

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end

#display_name ⇒ String

The display name of the fleet.

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 'lib/aws-sdk-deadline/types.rb', line 4838

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end

#farm_id ⇒ String

The farm ID of the farm in the fleet.

Returns:

• (String)

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

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end

#fleet_id ⇒ String

The fleet ID.

Returns:

• (String)

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

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end

#host_configuration ⇒ Types::HostConfiguration

The 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 'lib/aws-sdk-deadline/types.rb', line 4838

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end

#max_worker_count ⇒ Integer

The maximum number of workers specified in the fleet.

Returns:

• (Integer)

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

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end

#min_worker_count ⇒ Integer

The minimum number of workers specified in the fleet.

Returns:

• (Integer)

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

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end

#role_arn ⇒ String

The IAM role ARN.

Returns:

• (String)

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

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end

#status ⇒ String

The status of the fleet.

Returns:

• (String)

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

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end

#status_message ⇒ String

A message that communicates a suspended status of the fleet.

Returns:

• (String)

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

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end

#target_worker_count ⇒ Integer

The number of target workers in the fleet.

Returns:

• (Integer)

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

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end

#updated_at ⇒ Time

The date and time the resource was updated.

Returns:

• (Time)

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

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end

#updated_by ⇒ String

The user or system that updated this resource.

Returns:

• (String)

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

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end

#worker_count ⇒ Integer

The number of workers in the fleet.

Returns:

• (Integer)

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

class GetFleetResponse < Struct.new(
  :fleet_id,
  :farm_id,
  :display_name,
  :status,
  :status_message,
  :auto_scaling_status,
  :target_worker_count,
  :worker_count,
  :min_worker_count,
  :max_worker_count,
  :configuration,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :description,
  :host_configuration,
  :capabilities,
  :role_arn)
  SENSITIVE = [:description]
  include Aws::Structure
end