UpdateComputeEnvironmentRequest Class

Container for the parameters to the UpdateComputeEnvironment operation. Updates an Batch compute environment.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Batch.AmazonBatchRequest
      Amazon.Batch.Model.UpdateComputeEnvironmentRequest

Namespace: Amazon.Batch.Model
Assembly: AWSSDK.Batch.dll
Version: 3.x.y.z

Syntax

public class UpdateComputeEnvironmentRequest : AmazonBatchRequest
         IAmazonWebServiceRequest

The UpdateComputeEnvironmentRequest type exposes the following members

Constructors

	Name	Description
	UpdateComputeEnvironmentRequest()

Properties

Name	Type	Description
ComputeEnvironment	System.String	Gets and sets the property ComputeEnvironment. The name or full Amazon Resource Name (ARN) of the compute environment to update.
ComputeResources	Amazon.Batch.Model.ComputeResourceUpdate	Gets and sets the property 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	System.String	Gets and sets the property 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 `/`, then you must either specify the full role ARN (recommended) or prefix the role name with the path. 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.
State	Amazon.Batch.CEState	Gets and sets the property 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 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. 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. 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.
UnmanagedvCpus	System.Int32	Gets and sets the property 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.
UpdatePolicy	Amazon.Batch.Model.UpdatePolicy	Gets and sets the property 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.

Examples

This example disables the P2OnDemand compute environment so it can be deleted.

To update a compute environment


var client = new AmazonBatchClient();
var response = client.UpdateComputeEnvironment(new UpdateComputeEnvironmentRequest 
{
    ComputeEnvironment = "P2OnDemand",
    State = "DISABLED"
});

string computeEnvironmentArn = response.ComputeEnvironmentArn;
string computeEnvironmentName = response.ComputeEnvironmentName;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5