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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

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)

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

#compute_environment_nameString

The name of the compute environment.

Returns:

  • (String)

    The name of the compute environment.

#compute_resourcesTypes::ComputeResource

The compute resources defined for the compute environment.

Returns:

#ecs_cluster_arnString

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

Returns:

  • (String)

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

#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)

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

#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.

Possible values:

  • ENABLED
  • DISABLED

Returns:

  • (String)

    The state of the compute environment.

#statusString

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

Possible values:

  • CREATING
  • UPDATING
  • DELETING
  • DELETED
  • VALID
  • INVALID

Returns:

  • (String)

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

#status_reasonString

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

Returns:

  • (String)

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

#typeString

The type of the compute environment.

Possible values:

  • MANAGED
  • UNMANAGED

Returns:

  • (String)

    The type of the compute environment.