Update Compute Environment
batch_update_compute_environment | R Documentation |
Updates an Batch compute environment¶
Description¶
Updates an Batch compute environment.
Usage¶
batch_update_compute_environment(computeEnvironment, state,
unmanagedvCpus, computeResources, serviceRole, updatePolicy, context)
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
If the state is If the state is Compute environments in a When an instance is idle, the instance scales down to the
|
unmanagedvCpus |
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. |
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 Batch User Guide. |
serviceRole |
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 Depending on how you created your Batch service role, its ARN might
contain the |
updatePolicy |
Specifies the updated infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide. |
context |
Reserved. |
Value¶
A list with the following syntax:
list(
computeEnvironmentName = "string",
computeEnvironmentArn = "string"
)
Request syntax¶
svc$update_compute_environment(
computeEnvironment = "string",
state = "ENABLED"|"DISABLED",
unmanagedvCpus = 123,
computeResources = list(
minvCpus = 123,
maxvCpus = 123,
desiredvCpus = 123,
subnets = list(
"string"
),
securityGroupIds = list(
"string"
),
allocationStrategy = "BEST_FIT_PROGRESSIVE"|"SPOT_CAPACITY_OPTIMIZED"|"SPOT_PRICE_CAPACITY_OPTIMIZED",
instanceTypes = list(
"string"
),
ec2KeyPair = "string",
instanceRole = "string",
tags = list(
"string"
),
placementGroup = "string",
bidPercentage = 123,
launchTemplate = list(
launchTemplateId = "string",
launchTemplateName = "string",
version = "string",
overrides = list(
list(
launchTemplateId = "string",
launchTemplateName = "string",
version = "string",
targetInstanceTypes = list(
"string"
)
)
)
),
ec2Configuration = list(
list(
imageType = "string",
imageIdOverride = "string",
imageKubernetesVersion = "string"
)
),
updateToLatestImageVersion = TRUE|FALSE,
type = "EC2"|"SPOT"|"FARGATE"|"FARGATE_SPOT",
imageId = "string"
),
serviceRole = "string",
updatePolicy = list(
terminateJobsOnUpdate = TRUE|FALSE,
jobExecutionTimeoutMinutes = 123
),
context = "string"
)
Examples¶
## Not run:
# This example disables the P2OnDemand compute environment so it can be
# deleted.
svc$update_compute_environment(
computeEnvironment = "P2OnDemand",
state = "DISABLED"
)
## End(Not run)