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

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

Overview

Contains the parameters for ‘UpdateComputeEnvironment`.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#compute_environment ⇒ String

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

Returns:

  • (String) 


8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
 
# File 'lib/aws-sdk-batch/types.rb', line 8251

class UpdateComputeEnvironmentRequest < Struct.new(
  :compute_environment,
  :state,
  :unmanagedv_cpus,
  :compute_resources,
  :service_role,
  :update_policy,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#compute_resources ⇒ Types::ComputeResourceUpdate

Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see [Compute Environments] in the *Batch User Guide*.

[1]: docs.aws.amazon.com/batch/latest/userguide/compute_environments.html

Returns:



8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
 
# File 'lib/aws-sdk-batch/types.rb', line 8251

class UpdateComputeEnvironmentRequest < Struct.new(
  :compute_environment,
  :state,
  :unmanagedv_cpus,
  :compute_resources,
  :service_role,
  :update_policy,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#context ⇒ String

Reserved.

Returns:

  • (String) 


8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
 
# File 'lib/aws-sdk-batch/types.rb', line 8251

class UpdateComputeEnvironmentRequest < Struct.new(
  :compute_environment,
  :state,
  :unmanagedv_cpus,
  :compute_resources,
  :service_role,
  :update_policy,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#service_role ⇒ String

The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see [Batch service IAM role] in the *Batch User Guide*.

If the compute environment has a service-linked role, it can’t be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can’t be changed to use a service-linked role. To update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see [Updating compute environments] in the *Batch User Guide*.

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

<note markdown=“1”> Depending on how you created your Batch service role, its ARN might contain the ‘service-role` path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn’t 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.

</note>

[1]: docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html [2]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

Returns:

  • (String) 


8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
 
# File 'lib/aws-sdk-batch/types.rb', line 8251

class UpdateComputeEnvironmentRequest < Struct.new(
  :compute_environment,
  :state,
  :unmanagedv_cpus,
  :compute_resources,
  :service_role,
  :update_policy,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

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.

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.

<note markdown=“1”> 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*.

</note>

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.

[1]: docs.aws.amazon.com/batch/latest/userguide/compute_environment_parameters.html#compute_environment_state

Returns:

  • (String) 


8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
 
# File 'lib/aws-sdk-batch/types.rb', line 8251

class UpdateComputeEnvironmentRequest < Struct.new(
  :compute_environment,
  :state,
  :unmanagedv_cpus,
  :compute_resources,
  :service_role,
  :update_policy,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#unmanagedv_cpus ⇒ Integer

The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don’t specify this parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn’t provided for a fair share job queue, no vCPU capacity is reserved.

Returns:

  • (Integer) 


8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
 
# File 'lib/aws-sdk-batch/types.rb', line 8251

class UpdateComputeEnvironmentRequest < Struct.new(
  :compute_environment,
  :state,
  :unmanagedv_cpus,
  :compute_resources,
  :service_role,
  :update_policy,
  :context)
  SENSITIVE = []
  include Aws::Structure
end

#update_policy ⇒ Types::UpdatePolicy

Specifies the updated infrastructure update policy for the compute environment. For more information about infrastructure updates, see

Updating compute environments][1

in the *Batch User Guide*.

[1]: docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

Returns:



8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
 
# File 'lib/aws-sdk-batch/types.rb', line 8251

class UpdateComputeEnvironmentRequest < Struct.new(
  :compute_environment,
  :state,
  :unmanagedv_cpus,
  :compute_resources,
  :service_role,
  :update_policy,
  :context)
  SENSITIVE = []
  include Aws::Structure
end