AWS::Batch::ComputeEnvironment ComputeResources
Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the Amazon Batch User Guide.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "AllocationStrategy" :
String
, "BidPercentage" :Integer
, "DesiredvCpus" :Integer
, "Ec2Configuration" :[ Ec2ConfigurationObject, ... ]
, "Ec2KeyPair" :String
, "ImageId" :String
, "InstanceRole" :String
, "InstanceTypes" :[ String, ... ]
, "LaunchTemplate" :LaunchTemplateSpecification
, "MaxvCpus" :Integer
, "MinvCpus" :Integer
, "PlacementGroup" :String
, "SecurityGroupIds" :[ String, ... ]
, "SpotIamFleetRole" :String
, "Subnets" :[ String, ... ]
, "Tags" :{
, "Type" :Key
:Value
, ...}String
, "UpdateToLatestImageVersion" :Boolean
}
YAML
AllocationStrategy:
String
BidPercentage:Integer
DesiredvCpus:Integer
Ec2Configuration:- Ec2ConfigurationObject
Ec2KeyPair:String
ImageId:String
InstanceRole:String
InstanceTypes:- String
LaunchTemplate:LaunchTemplateSpecification
MaxvCpus:Integer
MinvCpus:Integer
PlacementGroup:String
SecurityGroupIds:- String
SpotIamFleetRole:String
Subnets:- String
Tags:Type:
Key
:Value
String
UpdateToLatestImageVersion:Boolean
Properties
AllocationStrategy
-
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 Amazon 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 Amazon Batch User Guide.
BEST_FIT
is not supported when updating a compute environment.Note
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
- BEST_FIT (default)
-
Amazon Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost instance type. If additional instances of the selected instance type aren't available, Amazon Batch waits for the additional instances to be available. If there aren't enough instances available, or if the user is reaching Amazon EC2 service limits then additional jobs aren't run until the currently running jobs have completed. This allocation strategy keeps costs lower but can limit scaling. If you are using Spot Fleets with
BEST_FIT
then the Spot Fleet IAM role must be specified. - BEST_FIT_PROGRESSIVE
-
Amazon 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, Amazon Batch will select new instance types.
- SPOT_CAPACITY_OPTIMIZED
-
Amazon 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.
- SPOT_PRICE_CAPACITY_OPTIMIZED
-
The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price. This allocation strategy is only available for Spot Instance compute resources.
Note
We recommend that you use
SPOT_PRICE_CAPACITY_OPTIMIZED
rather thanSPOT_CAPACITY_OPTIMIZED
in most instances.
With
BEST_FIT_PROGRESSIVE
,SPOT_CAPACITY_OPTIMIZED
, andSPOT_PRICE_CAPACITY_OPTIMIZED
allocation strategies using On-Demand or Spot Instances, and theBEST_FIT
strategy using Spot Instances, Amazon Batch might need to go abovemaxvCpus
to meet your capacity requirements. In this event, Amazon Batch never exceedsmaxvCpus
by more than a single instance.Required: No
Type: String
Allowed values:
BEST_FIT_PROGRESSIVE | SPOT_CAPACITY_OPTIMIZED | SPOT_PRICE_CAPACITY_OPTIMIZED
Update requires: Some interruptions
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 Amazon Batch User Guide.
Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
Required: No
Type: Integer
Update requires: Some interruptions
DesiredvCpus
-
The desired number of vCPUS in the compute environment. Amazon Batch modifies this value between the minimum and maximum values based on job queue demand.
Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
Note
Amazon 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.
Note
When you update the
desiredvCpus
setting, the value must be between theminvCpus
andmaxvCpus
values.Additionally, the updated
desiredvCpus
value must be greater than or equal to the currentdesiredvCpus
value. For more information, see Troubleshooting Amazon Batch in the Amazon Batch User Guide.Required: No
Type: Integer
Update requires: No interruption
Ec2Configuration
-
Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute environment. If
Ec2Configuration
isn't specified, the default isECS_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 Amazon Batch User Guide. To remove the Amazon EC2 configuration and any custom AMI ID specified in
imageIdOverride
, set this value to an empty string.One or two values can be provided.
Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
Required: No
Type: Array of Ec2ConfigurationObject
Update requires: Some interruptions
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 Amazon Batch User Guide.
Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
Required: No
Type: String
Update requires: Some interruptions
ImageId
-
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the
imageIdOverride
member of theEc2Configuration
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 Amazon Batch User Guide.
Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
Note
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: No
Type: String
Update requires: Some interruptions
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,
ecsInstanceRole
orarn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole
. For more information, see Amazon ECS instance role in the Amazon 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 Amazon Batch User Guide.
Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
Required: No
Type: String
Update requires: Some interruptions
InstanceTypes
-
The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example,
c5
orp3
), or you can specify specific sizes within a family (such asc5.8xlarge
). You can also chooseoptimal
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 Amazon Batch User Guide.
Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
Note
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.
Note
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: No
Type: Array of String
Update requires: Some interruptions
LaunchTemplate
-
The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. 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 Amazon Batch User Guide . Removing the launch template from a compute environment will not remove the AMI specified in the launch template. In order to update the AMI specified in a launch template, the
updateToLatestImageVersion
parameter must be set totrue
.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 Amazon Batch User Guide .
Note
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
Required: No
Type: LaunchTemplateSpecification
Update requires: Some interruptions
MaxvCpus
-
The maximum number of Amazon EC2 vCPUs that an environment can reach.
Note
With
BEST_FIT_PROGRESSIVE
,SPOT_CAPACITY_OPTIMIZED
andSPOT_PRICE_CAPACITY_OPTIMIZED
(recommended) strategies using On-Demand or Spot Instances, and theBEST_FIT
strategy using Spot Instances, Amazon Batch might need to exceedmaxvCpus
to meet your capacity requirements. In this event, Amazon Batch never exceedsmaxvCpus
by more than a single instance.Required: Yes
Type: Integer
Update requires: No interruption
MinvCpus
-
The minimum number of vCPUs that an environment should maintain (even if the compute environment is
DISABLED
).Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
Required: No
Type: Integer
Update requires: No interruption
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 Amazon Batch User Guide.
Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
Required: No
Type: String
Update requires: Some interruptions
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 Amazon Batch User Guide.
Required: No
Type: Array of String
Update requires: Some interruptions
SpotIamFleetRole
-
The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a
SPOT
compute environment. This role is required if the allocation strategy set toBEST_FIT
or if the allocation strategy isn't specified. For more information, see Amazon EC2 spot fleet role in the Amazon Batch User Guide.Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
Important
To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot instances not tagged on creation in the Amazon Batch User Guide.
Required: No
Type: String
Update requires: Replacement
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 Amazon Batch User Guide.
Note
Amazon Batch on Amazon EC2 and Amazon 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 Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Outposts in the Amazon ECS Developer Guide.
Amazon Batch on Fargate doesn't currently support Local Zones.
Required: Yes
Type: Array of String
Update requires: Some interruptions
-
Key-value pair tags to be applied to Amazon EC2 resources that are launched in the compute environment. For Amazon Batch, these take the form of
"String1": "String2"
, whereString1
is the tag key andString2
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 Amazon BatchListTagsForResource
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 Amazon Batch User Guide.
Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
Required: No
Type: Object of String
Pattern:
.*
Update requires: Some interruptions
Type
-
The type of compute environment:
EC2
,SPOT
,FARGATE
, orFARGATE_SPOT
. For more information, see Compute environments in the Amazon Batch User Guide.If you choose
SPOT
, you must also specify an Amazon EC2 Spot Fleet role with thespotIamFleetRole
parameter. For more information, see Amazon EC2 spot fleet role in the Amazon Batch User Guide.When updating 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 Amazon Batch User Guide.
When updating the type of a compute environment, changing between
EC2
andSPOT
or betweenFARGATE
andFARGATE_SPOT
will initiate an infrastructure update, but if you switch betweenEC2
andFARGATE
, Amazon CloudFormation will create a new compute environment.Required: Yes
Type: String
Allowed values:
EC2 | SPOT | FARGATE | FARGATE_SPOT
Update requires: Some interruptions
UpdateToLatestImageVersion
-
Specifies whether the AMI ID is updated to the latest one that's supported by Amazon Batch when the compute environment has an infrastructure update. The default value is
false
.Note
An AMI ID can either be specified in the
imageId
orimageIdOverride
parameters or be determined by the launch template that's specified in thelaunchTemplate
parameter. If an AMI ID is specified any of these ways, this parameter is ignored. For more information about to update AMI IDs during an infrastructure update, see Updating the AMI ID in the Amazon 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 Amazon Batch User Guide.
Required: No
Type: Boolean
Update requires: No interruption
See also
-
Compute Environments in the Amazon Batch User Guide .