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.
Update-BATComputeEnvironment-ComputeEnvironment <String>-ComputeResources_AllocationStrategy <CRUpdateAllocationStrategy>-ComputeResources_BidPercentage <Int32>-ComputeResources_DesiredvCpu <Int32>-ComputeResources_Ec2Configuration <Ec2Configuration[]>-ComputeResources_Ec2KeyPair <String>-ComputeResources_ImageId <String>-ComputeResources_InstanceRole <String>-ComputeResources_InstanceType <String[]>-UpdatePolicy_JobExecutionTimeoutMinute <Int64>-LaunchTemplate_LaunchTemplateId <String>-LaunchTemplate_LaunchTemplateName <String>-ComputeResources_MaxvCpu <Int32>-ComputeResources_MinvCpu <Int32>-ComputeResources_PlacementGroup <String>-ComputeResources_SecurityGroupId <String[]>-ServiceRole <String>-State <CEState>-ComputeResources_Subnet <String[]>-ComputeResources_Tag <Hashtable>-UpdatePolicy_TerminateJobsOnUpdate <Boolean>-ComputeResources_Type <CRType>-UnmanagedvCpu <Int32>-ComputeResources_UpdateToLatestImageVersion <Boolean>-LaunchTemplate_Version <String>-Select <String>-PassThru <SwitchParameter>-Force <SwitchParameter>
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
BEST_FIT
isn't supported when updating a compute environment.This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.BEST_FIT_PROGRESSIVE
and SPOT_CAPACITY_OPTIMIZED
strategies, Batch might need to go above maxvCpus
to meet your capacity requirements. In this event, Batch never exceeds maxvCpus
by more than a single instance. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ComputeResources_DesiredvCpus |
Ec2Configuration
isn't specified, the default is ECS_AL2
.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 EC2 configuration and any custom AMI ID specified in imageIdOverride
, set this value to an empty string.One or two values can be provided.This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
imageIdOverride
member of the Ec2Configuration
structure. To remove the custom AMI ID and use the default AMI ID, set this value to an empty string.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, and shouldn't be specified.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. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
ecsInstanceRole
or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole
. For more information, see Amazon ECS instance role in the Batch User Guide.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, and shouldn't be specified. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
c5
or p3
), or you can specify specific sizes within a family (such as c5.8xlarge
). You can also choose optimal
to select instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.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, and shouldn't be specified.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, optimal
uses instance types from the C4, M4, and R4 instance families. In Regions that don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families are used. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ComputeResources_InstanceTypes |
BEST_FIT_PROGRESSIVE
and SPOT_CAPACITY_OPTIMIZED
allocation strategies, Batch might need to exceed maxvCpus
to meet your capacity requirements. In this event, Batch never exceeds maxvCpus
by more than a single instance. That is, no more than a single instance from among those specified in your compute environment. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ComputeResources_MaxvCpus |
DISABLED
).This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ComputeResources_MinvCpus |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ComputeResources_SecurityGroupIds |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ComputeResources_Subnets |
{ "Name": "Batch Instance - C4OnDemand" }
. This is helpful for recognizing your Batch instances in the Amazon EC2 console. These tags aren't seen when using the Batch ListTagsForResource
API operation.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, and shouldn't be specified. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ComputeResources_Tags |
EC2
, SPOT
, FARGATE
, or FARGATE_SPOT
. For more information, see Compute environments in the Batch User Guide. If you choose SPOT
, you must also specify an Amazon EC2 Spot Fleet role with the spotIamFleetRole
parameter. For more information, see Amazon EC2 spot fleet role in the Batch User Guide.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. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
false
.If an AMI ID is specified in the imageId
or imageIdOverride
parameters or by the launch template specified in the launchTemplate
parameter, this parameter is ignored. For more information on updating AMI IDs during an infrastructure update, see Updating the AMI ID in the Batch User Guide.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. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ComputeResources_LaunchTemplate_LaunchTemplateId |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ComputeResources_LaunchTemplate_LaunchTemplateName |
$Latest
, or $Default
.If the value is $Latest
, the latest version of the launch template is used. If the value is $Default
, the default version of the launch template is used.updateToLatestImageVersion
parameter for the compute environment is set to true
. During an infrastructure update, if either $Latest
or $Default
is specified, Batch re-evaluates the launch template version, and it might use a different version of the launch template. This is the case even if the launch template isn't specified in the update. 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.$Default
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ComputeResources_LaunchTemplate_Version |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
/
, 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. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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. However, they scale in to minvCpus
value after instances become idle. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | UnmanagedvCpus |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | UpdatePolicy_JobExecutionTimeoutMinutes |
false
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
AWS Tools for PowerShell: 2.x.y.z