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 that represents an Batch compute environment.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#compute_environment_arnString

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

Returns:

  • (String)


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 310

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)
  SENSITIVE = []
  include Aws::Structure
end

#compute_environment_nameString

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)


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 310

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)
  SENSITIVE = []
  include Aws::Structure
end

#compute_resourcesTypes::ComputeResource

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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 310

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)
  SENSITIVE = []
  include Aws::Structure
end

#container_orchestration_typeString

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

Returns:

  • (String)


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 310

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)
  SENSITIVE = []
  include Aws::Structure
end

#ecs_cluster_arnString

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

Returns:

  • (String)


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 310

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)
  SENSITIVE = []
  include Aws::Structure
end

#eks_configurationTypes::EksConfiguration

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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 310

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)
  SENSITIVE = []
  include Aws::Structure
end

#service_roleString

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)


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 310

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)
  SENSITIVE = []
  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 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. However, they scale in to minvCpus value after instances become idle.

Returns:

  • (String)


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 310

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)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 310

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)
  SENSITIVE = []
  include Aws::Structure
end

#status_reasonString

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

Returns:

  • (String)


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 310

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)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The tags applied to the compute environment.

Returns:

  • (Hash<String,String>)


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 310

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)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

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

Returns:

  • (String)


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 310

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)
  SENSITIVE = []
  include Aws::Structure
end

#unmanagedv_cpusInteger

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

Returns:

  • (Integer)


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 310

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)
  SENSITIVE = []
  include Aws::Structure
end

#update_policyTypes::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:



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 310

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)
  SENSITIVE = []
  include Aws::Structure
end

#uuidString

Unique identifier for the compute environment.

Returns:

  • (String)


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 310

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)
  SENSITIVE = []
  include Aws::Structure
end