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

Class: Aws::Batch::Types::UpdateComputeEnvironmentRequest

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

Overview

Note:

When making an API call, you may pass UpdateComputeEnvironmentRequest data as a hash:

{
  compute_environment: "String", # required
  state: "ENABLED", # accepts ENABLED, DISABLED
  compute_resources: {
    minv_cpus: 1,
    maxv_cpus: 1,
    desiredv_cpus: 1,
  },
  service_role: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#compute_environmentString

The name or full Amazon Resource Name (ARN) of the compute environment to update.

Returns:

  • (String)


1951
1952
1953
1954
1955
1956
1957
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1951

class UpdateComputeEnvironmentRequest < Struct.new(
  :compute_environment,
  :state,
  :compute_resources,
  :service_role)
  include Aws::Structure
end

#compute_resourcesTypes::ComputeResourceUpdate

Details of the compute resources managed by the compute environment. Required for a managed compute environment.



1951
1952
1953
1954
1955
1956
1957
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1951

class UpdateComputeEnvironmentRequest < Struct.new(
  :compute_environment,
  :state,
  :compute_resources,
  :service_role)
  include Aws::Structure
end

#service_roleString

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.

Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

Returns:

  • (String)


1951
1952
1953
1954
1955
1956
1957
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1951

class UpdateComputeEnvironmentRequest < Struct.new(
  :compute_environment,
  :state,
  :compute_resources,
  :service_role)
  include Aws::Structure
end

#stateString

The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.

Returns:

  • (String)


1951
1952
1953
1954
1955
1956
1957
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1951

class UpdateComputeEnvironmentRequest < Struct.new(
  :compute_environment,
  :state,
  :compute_resources,
  :service_role)
  include Aws::Structure
end