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

Inherits:

Struct

Object
Struct
Aws::Batch::Types::ComputeEnvironmentDetail

show all

Defined in:: gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

An object that represents an Batch compute environment.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#compute_environment_arn ⇒ String
The Amazon Resource Name (ARN) of the compute environment.
#compute_environment_name ⇒ String
The name of the compute environment.
#compute_resources ⇒ Types::ComputeResource
The compute resources defined for the compute environment.
#container_orchestration_type ⇒ String
The orchestration type of the compute environment.
#context ⇒ String
Reserved.
#ecs_cluster_arn ⇒ String
The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.
#eks_configuration ⇒ Types::EksConfiguration
The configuration for the Amazon EKS cluster that supports the Batch compute environment.
#service_role ⇒ String
The service role that's associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf.
#state ⇒ String
The state of the compute environment.
#status ⇒ String
The current status of the compute environment (for example, CREATING or VALID).
#status_reason ⇒ String
A short, human-readable string to provide additional details for the current status of the compute environment.
#tags ⇒ Hash<String,String>
The tags applied to the compute environment.
#type ⇒ String
The type of the compute environment: MANAGED or UNMANAGED.
#unmanagedv_cpus ⇒ Integer
The maximum number of VCPUs expected to be used for an unmanaged compute environment.
#update_policy ⇒ Types::UpdatePolicy
Specifies the infrastructure update policy for the compute environment.
#uuid ⇒ String
Unique identifier for the compute environment.

Instance Attribute Details

#compute_environment_arn ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 403

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :unmanagedv_cpus,
  :ecs_cluster_arn,
  :tags,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role,
  :update_policy,
  :eks_configuration,
  :container_orchestration_type,
  :uuid,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#compute_environment_name ⇒ `String`

The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 403

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :unmanagedv_cpus,
  :ecs_cluster_arn,
  :tags,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role,
  :update_policy,
  :eks_configuration,
  :container_orchestration_type,
  :uuid,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#compute_resources ⇒ `Types::ComputeResource`

The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.

Returns:

(Types::ComputeResource)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 403

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :unmanagedv_cpus,
  :ecs_cluster_arn,
  :tags,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role,
  :update_policy,
  :eks_configuration,
  :container_orchestration_type,
  :uuid,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#container_orchestration_type ⇒ `String`

The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 403

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :unmanagedv_cpus,
  :ecs_cluster_arn,
  :tags,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role,
  :update_policy,
  :eks_configuration,
  :container_orchestration_type,
  :uuid,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#context ⇒ `String`

Reserved.

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 403

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :unmanagedv_cpus,
  :ecs_cluster_arn,
  :tags,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role,
  :update_policy,
  :eks_configuration,
  :container_orchestration_type,
  :uuid,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#ecs_cluster_arn ⇒ `String`

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 403

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :unmanagedv_cpus,
  :ecs_cluster_arn,
  :tags,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role,
  :update_policy,
  :eks_configuration,
  :container_orchestration_type,
  :uuid,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#eks_configuration ⇒ `Types::EksConfiguration`

The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the containerOrchestrationType is EKS.

Returns:

(Types::EksConfiguration)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 403

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :unmanagedv_cpus,
  :ecs_cluster_arn,
  :tags,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role,
  :update_policy,
  :eks_configuration,
  :container_orchestration_type,
  :uuid,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#service_role ⇒ `String`

The service role that's associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 403

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :unmanagedv_cpus,
  :ecs_cluster_arn,
  :tags,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role,
  :update_policy,
  :eks_configuration,
  :container_orchestration_type,
  :uuid,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ `String`

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

If the state is ENABLED, then the 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 Batch scheduler doesn't 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 don't scale out.

Compute environments in a DISABLED state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see State in the Batch User Guide.

When an instance is idle, the instance scales down to the minvCpus value. However, the instance size doesn't change. For example, consider a c5.8xlarge instance with a minvCpus value of 4 and a desiredvCpus value of 36. This instance doesn't scale down to a c5.large instance.

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 403

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :unmanagedv_cpus,
  :ecs_cluster_arn,
  :tags,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role,
  :update_policy,
  :eks_configuration,
  :container_orchestration_type,
  :uuid,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 403

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :unmanagedv_cpus,
  :ecs_cluster_arn,
  :tags,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role,
  :update_policy,
  :eks_configuration,
  :container_orchestration_type,
  :uuid,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 403

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :unmanagedv_cpus,
  :ecs_cluster_arn,
  :tags,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role,
  :update_policy,
  :eks_configuration,
  :container_orchestration_type,
  :uuid,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

The tags applied to the compute environment.

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 403

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :unmanagedv_cpus,
  :ecs_cluster_arn,
  :tags,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role,
  :update_policy,
  :eks_configuration,
  :container_orchestration_type,
  :uuid,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ `String`

The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute environments in the Batch User Guide.

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 403

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :unmanagedv_cpus,
  :ecs_cluster_arn,
  :tags,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role,
  :update_policy,
  :eks_configuration,
  :container_orchestration_type,
  :uuid,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#unmanagedv_cpus ⇒ `Integer`

The maximum number of VCPUs expected to be used for an unmanaged compute environment.

Returns:

(Integer)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 403

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :unmanagedv_cpus,
  :ecs_cluster_arn,
  :tags,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role,
  :update_policy,
  :eks_configuration,
  :container_orchestration_type,
  :uuid,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#update_policy ⇒ `Types::UpdatePolicy`

Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.

Returns:

(Types::UpdatePolicy)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 403

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :unmanagedv_cpus,
  :ecs_cluster_arn,
  :tags,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role,
  :update_policy,
  :eks_configuration,
  :container_orchestration_type,
  :uuid,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#uuid ⇒ `String`

Unique identifier for the compute environment.

Returns:

(String)

# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 403

class ComputeEnvironmentDetail < Struct.new(
  :compute_environment_name,
  :compute_environment_arn,
  :unmanagedv_cpus,
  :ecs_cluster_arn,
  :tags,
  :type,
  :state,
  :status,
  :status_reason,
  :compute_resources,
  :service_role,
  :update_policy,
  :eks_configuration,
  :container_orchestration_type,
  :uuid,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#compute_environment_arn ⇒ String

#compute_environment_name ⇒ String

#compute_resources ⇒ Types::ComputeResource

#container_orchestration_type ⇒ String

#context ⇒ String

#ecs_cluster_arn ⇒ String

#eks_configuration ⇒ Types::EksConfiguration

#service_role ⇒ String

#state ⇒ String

#status ⇒ String

#status_reason ⇒ String

#tags ⇒ Hash<String,String>

#type ⇒ String

#unmanagedv_cpus ⇒ Integer

#update_policy ⇒ Types::UpdatePolicy

#uuid ⇒ String

#compute_environment_arn ⇒ `String`

#compute_environment_name ⇒ `String`

#compute_resources ⇒ `Types::ComputeResource`

#container_orchestration_type ⇒ `String`

#context ⇒ `String`

#ecs_cluster_arn ⇒ `String`

#eks_configuration ⇒ `Types::EksConfiguration`

#service_role ⇒ `String`

#state ⇒ `String`

#status ⇒ `String`

#status_reason ⇒ `String`

#tags ⇒ `Hash<String,String>`

#type ⇒ `String`

#unmanagedv_cpus ⇒ `Integer`

#update_policy ⇒ `Types::UpdatePolicy`

#uuid ⇒ `String`