paws.compute (version 0.1.12)

batch_update_compute_environment: Updates an AWS Batch compute environment

Description

Updates an AWS Batch compute environment.

Usage

batch_update_compute_environment(computeEnvironment, state,
  computeResources, serviceRole)

Value

A list with the following syntax:

list(
  computeEnvironmentName = "string",
  computeEnvironmentArn = "string"
)

Arguments

computeEnvironment

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

state

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

computeResources

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

serviceRole

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

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

Request syntax

svc$update_compute_environment(
  computeEnvironment = "string",
  state = "ENABLED"|"DISABLED",
  computeResources = list(
    minvCpus = 123,
    maxvCpus = 123,
    desiredvCpus = 123,
    subnets = list(
      "string"
    ),
    securityGroupIds = list(
      "string"
    )
  ),
  serviceRole = "string"
)

Examples

if (FALSE) {
# This example disables the P2OnDemand compute environment so it can be
# deleted.
svc$update_compute_environment(
  computeEnvironment = "P2OnDemand",
  state = "DISABLED"
)
}