You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Batch::Types::ComputeEnvironmentDetail

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

An object representing an AWS Batch compute environment.

Instance Attribute Summary collapse

Instance Attribute Details

#compute_environment_arnString

The Amazon Resource Name (ARN) of the compute environment.

Returns:

  • (String)


261
262
263
264
265
266
267
268
269
270
271
272
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 261

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :ecs_cluster_arn,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role)
  include Aws::Structure
end

#compute_environment_nameString

The name of the compute environment.

Returns:

  • (String)


261
262
263
264
265
266
267
268
269
270
271
272
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 261

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :ecs_cluster_arn,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role)
  include Aws::Structure
end

#compute_resourcesTypes::ComputeResource

The compute resources defined for the compute environment.



261
262
263
264
265
266
267
268
269
270
271
272
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 261

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :ecs_cluster_arn,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role)
  include Aws::Structure
end

#ecs_cluster_arnString

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.

Returns:

  • (String)


261
262
263
264
265
266
267
268
269
270
271
272
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 261

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :ecs_cluster_arn,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role)
  include Aws::Structure
end

#service_roleString

The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.

Returns:

  • (String)


261
262
263
264
265
266
267
268
269
270
271
272
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 261

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :ecs_cluster_arn,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role)
  include Aws::Structure
end

#stateString

The state of the compute environment. The valid values are ENABLED or DISABLED.

If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.

If the state is DISABLED, then the AWS Batch scheduler does not attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state do not scale out. However, they scale in to minvCpus value after instances become idle.

Returns:

  • (String)


261
262
263
264
265
266
267
268
269
270
271
272
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 261

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :ecs_cluster_arn,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role)
  include Aws::Structure
end

#statusString

The current status of the compute environment (for example, CREATING or VALID).

Returns:

  • (String)


261
262
263
264
265
266
267
268
269
270
271
272
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 261

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :ecs_cluster_arn,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role)
  include Aws::Structure
end

#status_reasonString

A short, human-readable string to provide additional details about the current status of the compute environment.

Returns:

  • (String)


261
262
263
264
265
266
267
268
269
270
271
272
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 261

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :ecs_cluster_arn,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role)
  include Aws::Structure
end

#typeString

The type of the compute environment.

Returns:

  • (String)


261
262
263
264
265
266
267
268
269
270
271
272
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 261

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :ecs_cluster_arn,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role)
  include Aws::Structure
end