AWS Tools for Windows PowerShell
Command Reference

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.

Synopsis

Calls the AWS Batch UpdateComputeEnvironment API operation.

Syntax

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>

Description

Updates an Batch compute environment.

Parameters

-ComputeEnvironment <String>
The name or full Amazon Resource Name (ARN) of the compute environment to update.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ComputeResources_AllocationStrategy <CRUpdateAllocationStrategy>
The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type 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. 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
Batch will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the previously selected instance types aren't available, Batch will select new instance types.
SPOT_CAPACITY_OPTIMIZED
Batch will select one or more instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.
With both 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)
-ComputeResources_BidPercentage <Int32>
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%, then 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.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, and shouldn't be specified.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_DesiredvCpu <Int32>
The desired number of Amazon EC2 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, and shouldn't be specified.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_DesiredvCpus
-ComputeResources_Ec2Configuration <Ec2Configuration[]>
Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If 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)
-ComputeResources_Ec2KeyPair <String>
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 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, and shouldn't be specified.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_ImageId <String>
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the 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)
-ComputeResources_InstanceRole <String>
The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, 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)
-ComputeResources_InstanceType <String[]>
The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, 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)
AliasesComputeResources_InstanceTypes
-ComputeResources_MaxvCpu <Int32>
The maximum number of Amazon EC2 vCPUs that an environment can reach.With both 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)
AliasesComputeResources_MaxvCpus
-ComputeResources_MinvCpu <Int32>
The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is 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)
AliasesComputeResources_MinvCpus
-ComputeResources_PlacementGroup <String>
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, and shouldn't be specified.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComputeResources_SecurityGroupId <String[]>
The Amazon EC2 security groups 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 EC2 compute resources, providing an empty list removes the security groups from the compute resource.When updating a compute environment, changing the EC2 security groups 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)
AliasesComputeResources_SecurityGroupIds
-ComputeResources_Subnet <String[]>
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 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_Subnets
-ComputeResources_Tag <Hashtable>
Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch, these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value−for example, { "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)
AliasesComputeResources_Tags
-ComputeResources_Type <CRType>
The type of compute environment: 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)
-ComputeResources_UpdateToLatestImageVersion <Boolean>
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 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)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LaunchTemplate_LaunchTemplateId <String>
The ID of the launch template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_LaunchTemplate_LaunchTemplateId
-LaunchTemplate_LaunchTemplateName <String>
The name of the launch template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_LaunchTemplate_LaunchTemplateName
-LaunchTemplate_Version <String>
The version number of the launch template, $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.If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the 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: $Default.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesComputeResources_LaunchTemplate_Version
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ComputeEnvironment parameter. The -PassThru parameter is deprecated, use -Select '^ComputeEnvironment' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Batch.Model.UpdateComputeEnvironmentResponse). Specifying the name of a property of type Amazon.Batch.Model.UpdateComputeEnvironmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServiceRole <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-State <CEState>
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. However, they scale in to minvCpus value after instances become idle.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UnmanagedvCpu <Int32>
The maximum number of vCPUs expected to be used for an unmanaged compute environment. Do not 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 is not provided for a fair share job queue, no vCPU capacity will be reserved.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUnmanagedvCpus
-UpdatePolicy_JobExecutionTimeoutMinute <Int64>
Specifies the job timeout, in minutes, when the compute environment infrastructure is updated. The default value is 30.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUpdatePolicy_JobExecutionTimeoutMinutes
-UpdatePolicy_TerminateJobsOnUpdate <Boolean>
Specifies whether jobs are automatically terminated when the computer environment infrastructure is updated. The default value is false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Batch.Model.UpdateComputeEnvironmentResponse
This cmdlet returns an Amazon.Batch.Model.UpdateComputeEnvironmentResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z