AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
An object that represents the attributes of a compute environment that can be updated. For more information, see Updating compute environments in the Batch User Guide.
Namespace: Amazon.Batch.Model
Assembly: AWSSDK.Batch.dll
Version: 3.x.y.z
public class ComputeResourceUpdate
The ComputeResourceUpdate type exposes the following members
Name | Description | |
---|---|---|
ComputeResourceUpdate() |
Name | Type | Description | |
---|---|---|---|
AllocationStrategy | Amazon.Batch.CRUpdateAllocationStrategy |
Gets and sets the property AllocationStrategy. The allocation strategy to use for the compute resource if there's not enough instances of the best fitting instance type that can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation strategies in the Batch User Guide.
When updating a compute environment, changing the allocation strategy requires an
infrastructure update of the compute environment. For more information, see Updating
compute environments in the Batch User Guide. This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
With |
|
BidPercentage | System.Int32 |
Gets and sets the property BidPercentage. The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. For most use cases, we recommend leaving this field empty. When updating a compute environment, changing the bid percentage requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. |
|
DesiredvCpus | System.Int32 |
Gets and sets the property DesiredvCpus. The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values based on job queue demand. This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. Batch doesn't support changing the desired number of vCPUs of an existing compute environment. Don't specify this parameter for compute environments using Amazon EKS clusters.
When you update the
Additionally, the updated |
|
Ec2Configuration | System.Collections.Generic.List<Amazon.Batch.Model.Ec2Configuration> |
Gets and sets the property Ec2Configuration.
Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances
in the compute environment. If
When updating a compute environment, changing this setting requires an infrastructure
update of the compute environment. For more information, see Updating
compute environments in the Batch User Guide. To remove the Amazon EC2
configuration and any custom AMI ID specified in One or two values can be provided. This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. |
|
Ec2KeyPair | System.String |
Gets and sets the property Ec2KeyPair. The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this value to an empty string. When updating a compute environment, changing the Amazon EC2 key pair requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. |
|
ImageId | System.String |
Gets and sets the property ImageId.
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
This parameter is overridden by the When updating a compute environment, changing the AMI ID requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide. |
|
InstanceRole | System.String |
Gets and sets the property InstanceRole.
The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.
Required for Amazon EC2 instances. You can specify the short name or full Amazon Resource
Name (ARN) of an instance profile. For example, When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. |
|
InstanceTypes | System.Collections.Generic.List<System.String> |
Gets and sets the property InstanceTypes.
The instances types that can be launched. You can specify instance families to launch
any instance type within those families (for example, When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.
Currently, |
|
LaunchTemplate | Amazon.Batch.Model.LaunchTemplateSpecification |
Gets and sets the property LaunchTemplate.
The updated launch template to use for your compute resources. You must specify either
the launch template ID or launch template name in the request, but not both. For more
information, see Launch
template support in the Batch User Guide. To remove the custom launch template
and use the default launch template, set When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. |
|
MaxvCpus | System.Int32 |
Gets and sets the property MaxvCpus. The maximum number of Amazon EC2 vCPUs that an environment can reach.
With |
|
MinvCpus | System.Int32 |
Gets and sets the property MinvCpus.
The minimum number of vCPUs that an environment should maintain (even if the compute
environment is This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. |
|
PlacementGroup | System.String |
Gets and sets the property PlacementGroup. The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances. When updating a compute environment, changing the placement group requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. |
|
SecurityGroupIds | System.Collections.Generic.List<System.String> |
Gets and sets the property SecurityGroupIds. The Amazon EC2 security groups that are associated with instances launched in the compute environment. This parameter is required for Fargate compute resources, where it can contain up to 5 security groups. For Fargate compute resources, providing an empty list is handled as if this parameter wasn't specified and no change is made. For Amazon EC2 compute resources, providing an empty list removes the security groups from the compute resource. When updating a compute environment, changing the Amazon EC2 security groups requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. |
|
Subnets | System.Collections.Generic.List<System.String> |
Gets and sets the property Subnets. The VPC subnets where the compute resources are launched. Fargate compute resources can contain up to 16 subnets. For Fargate compute resources, providing an empty list will be handled as if this parameter wasn't specified and no change is made. For Amazon EC2 compute resources, providing an empty list removes the VPC subnets from the compute resource. For more information, see VPCs and subnets in the Amazon VPC User Guide. When updating a compute environment, changing the VPC subnets requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the Amazon ECS Developer Guide. Batch on Fargate doesn't currently support Local Zones. |
|
Tags | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property Tags.
Key-value pair tags to be applied to Amazon EC2 resources that are launched in the
compute environment. For Batch, these take the form of When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. |
|
Type | Amazon.Batch.CRType |
Gets and sets the property Type.
The type of compute environment:
If you choose When updating a compute environment, changing the type of a compute environment requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. |
|
UpdateToLatestImageVersion | System.Boolean |
Gets and sets the property UpdateToLatestImageVersion.
Specifies whether the AMI ID is updated to the latest one that's supported by Batch
when the compute environment has an infrastructure update. The default value is
An AMI ID can either be specified in the When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5