AWS Native is in preview. AWS Classic is fully supported.
aws-native.batch.getComputeEnvironment
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Resource Type definition for AWS::Batch::ComputeEnvironment
Using getComputeEnvironment
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getComputeEnvironment(args: GetComputeEnvironmentArgs, opts?: InvokeOptions): Promise<GetComputeEnvironmentResult>
function getComputeEnvironmentOutput(args: GetComputeEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetComputeEnvironmentResult>
def get_compute_environment(compute_environment_arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetComputeEnvironmentResult
def get_compute_environment_output(compute_environment_arn: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetComputeEnvironmentResult]
func LookupComputeEnvironment(ctx *Context, args *LookupComputeEnvironmentArgs, opts ...InvokeOption) (*LookupComputeEnvironmentResult, error)
func LookupComputeEnvironmentOutput(ctx *Context, args *LookupComputeEnvironmentOutputArgs, opts ...InvokeOption) LookupComputeEnvironmentResultOutput
> Note: This function is named LookupComputeEnvironment
in the Go SDK.
public static class GetComputeEnvironment
{
public static Task<GetComputeEnvironmentResult> InvokeAsync(GetComputeEnvironmentArgs args, InvokeOptions? opts = null)
public static Output<GetComputeEnvironmentResult> Invoke(GetComputeEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetComputeEnvironmentResult> getComputeEnvironment(GetComputeEnvironmentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:batch:getComputeEnvironment
arguments:
# arguments dictionary
The following arguments are supported:
- Compute
Environment stringArn - Returns the compute environment ARN, such as
batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName*
.
- Compute
Environment stringArn - Returns the compute environment ARN, such as
batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName*
.
- compute
Environment StringArn - Returns the compute environment ARN, such as
batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName*
.
- compute
Environment stringArn - Returns the compute environment ARN, such as
batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName*
.
- compute_
environment_ strarn - Returns the compute environment ARN, such as
batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName*
.
- compute
Environment StringArn - Returns the compute environment ARN, such as
batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName*
.
getComputeEnvironment Result
The following output properties are available:
- Compute
Environment stringArn - Returns the compute environment ARN, such as
batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName*
. - Compute
Resources Pulumi.Aws Native. Batch. Outputs. Compute Environment Compute Resources - The ComputeResources property type specifies details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the ** .
- Service
Role string The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide .
If your account already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the AWS Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the AWS Batch service-linked role in your account.
If your specified role has a path other than
/
, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the namebar
has a path of/foo/
, specify/foo/bar
as the role name. For more information, see Friendly names and paths in the IAM User Guide .Depending on how you created your AWS Batch service role, its ARN might contain the
service-role
path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use theservice-role
path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.- State string
The state of the compute environment. If the state is
ENABLED
, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.If the state is
ENABLED
, then the AWS 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 AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in aSTARTING
orRUNNING
state continue to progress normally. Managed compute environments in theDISABLED
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 AWS 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 ac5.8xlarge
instance with aminvCpus
value of4
and adesiredvCpus
value of36
. This instance doesn't scale down to ac5.large
instance.- Unmanagedv
Cpus int The maximum number of vCPUs for an unmanaged 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.
This parameter is only supported when the
type
parameter is set toUNMANAGED
.
- Compute
Environment stringArn - Returns the compute environment ARN, such as
batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName*
. - Compute
Resources ComputeEnvironment Compute Resources - The ComputeResources property type specifies details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the ** .
- Service
Role string The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide .
If your account already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the AWS Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the AWS Batch service-linked role in your account.
If your specified role has a path other than
/
, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the namebar
has a path of/foo/
, specify/foo/bar
as the role name. For more information, see Friendly names and paths in the IAM User Guide .Depending on how you created your AWS Batch service role, its ARN might contain the
service-role
path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use theservice-role
path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.- State string
The state of the compute environment. If the state is
ENABLED
, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.If the state is
ENABLED
, then the AWS 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 AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in aSTARTING
orRUNNING
state continue to progress normally. Managed compute environments in theDISABLED
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 AWS 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 ac5.8xlarge
instance with aminvCpus
value of4
and adesiredvCpus
value of36
. This instance doesn't scale down to ac5.large
instance.- Unmanagedv
Cpus int The maximum number of vCPUs for an unmanaged 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.
This parameter is only supported when the
type
parameter is set toUNMANAGED
.
- compute
Environment StringArn - Returns the compute environment ARN, such as
batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName*
. - compute
Resources ComputeEnvironment Compute Resources - The ComputeResources property type specifies details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the ** .
- service
Role String The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide .
If your account already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the AWS Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the AWS Batch service-linked role in your account.
If your specified role has a path other than
/
, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the namebar
has a path of/foo/
, specify/foo/bar
as the role name. For more information, see Friendly names and paths in the IAM User Guide .Depending on how you created your AWS Batch service role, its ARN might contain the
service-role
path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use theservice-role
path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.- state String
The state of the compute environment. If the state is
ENABLED
, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.If the state is
ENABLED
, then the AWS 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 AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in aSTARTING
orRUNNING
state continue to progress normally. Managed compute environments in theDISABLED
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 AWS 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 ac5.8xlarge
instance with aminvCpus
value of4
and adesiredvCpus
value of36
. This instance doesn't scale down to ac5.large
instance.- unmanagedv
Cpus Integer The maximum number of vCPUs for an unmanaged 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.
This parameter is only supported when the
type
parameter is set toUNMANAGED
.
- compute
Environment stringArn - Returns the compute environment ARN, such as
batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName*
. - compute
Resources ComputeEnvironment Compute Resources - The ComputeResources property type specifies details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the ** .
- service
Role string The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide .
If your account already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the AWS Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the AWS Batch service-linked role in your account.
If your specified role has a path other than
/
, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the namebar
has a path of/foo/
, specify/foo/bar
as the role name. For more information, see Friendly names and paths in the IAM User Guide .Depending on how you created your AWS Batch service role, its ARN might contain the
service-role
path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use theservice-role
path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.- state string
The state of the compute environment. If the state is
ENABLED
, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.If the state is
ENABLED
, then the AWS 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 AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in aSTARTING
orRUNNING
state continue to progress normally. Managed compute environments in theDISABLED
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 AWS 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 ac5.8xlarge
instance with aminvCpus
value of4
and adesiredvCpus
value of36
. This instance doesn't scale down to ac5.large
instance.- unmanagedv
Cpus number The maximum number of vCPUs for an unmanaged 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.
This parameter is only supported when the
type
parameter is set toUNMANAGED
.
- compute_
environment_ strarn - Returns the compute environment ARN, such as
batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName*
. - compute_
resources ComputeEnvironment Compute Resources - The ComputeResources property type specifies details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the ** .
- service_
role str The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide .
If your account already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the AWS Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the AWS Batch service-linked role in your account.
If your specified role has a path other than
/
, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the namebar
has a path of/foo/
, specify/foo/bar
as the role name. For more information, see Friendly names and paths in the IAM User Guide .Depending on how you created your AWS Batch service role, its ARN might contain the
service-role
path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use theservice-role
path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.- state str
The state of the compute environment. If the state is
ENABLED
, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.If the state is
ENABLED
, then the AWS 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 AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in aSTARTING
orRUNNING
state continue to progress normally. Managed compute environments in theDISABLED
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 AWS 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 ac5.8xlarge
instance with aminvCpus
value of4
and adesiredvCpus
value of36
. This instance doesn't scale down to ac5.large
instance.- unmanagedv_
cpus int The maximum number of vCPUs for an unmanaged 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.
This parameter is only supported when the
type
parameter is set toUNMANAGED
.
- compute
Environment StringArn - Returns the compute environment ARN, such as
batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName*
. - compute
Resources Property Map - The ComputeResources property type specifies details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the ** .
- service
Role String The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide .
If your account already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the AWS Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the AWS Batch service-linked role in your account.
If your specified role has a path other than
/
, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the namebar
has a path of/foo/
, specify/foo/bar
as the role name. For more information, see Friendly names and paths in the IAM User Guide .Depending on how you created your AWS Batch service role, its ARN might contain the
service-role
path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use theservice-role
path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.- state String
The state of the compute environment. If the state is
ENABLED
, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.If the state is
ENABLED
, then the AWS 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 AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in aSTARTING
orRUNNING
state continue to progress normally. Managed compute environments in theDISABLED
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 AWS 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 ac5.8xlarge
instance with aminvCpus
value of4
and adesiredvCpus
value of36
. This instance doesn't scale down to ac5.large
instance.- unmanagedv
Cpus Number The maximum number of vCPUs for an unmanaged 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.
This parameter is only supported when the
type
parameter is set toUNMANAGED
.
Supporting Types
ComputeEnvironmentComputeResources
- Maxv
Cpus int The maximum number of Amazon EC2 vCPUs that an environment can reach.
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, AWS Batch might need to exceedmaxvCpus
to meet your capacity requirements. In this event, AWS Batch never exceedsmaxvCpus
by more than a single instance.- Subnets List<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 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 AWS Batch User Guide .
AWS Batch on Amazon EC2 and AWS 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 AWS Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and AWS Outposts in the Amazon ECS Developer Guide .
AWS Batch on Fargate doesn't currently support Local Zones.
- Type string
The type of compute environment:
EC2
,SPOT
,FARGATE
, orFARGATE_SPOT
. For more information, see Compute environments in the AWS 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 AWS 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 AWS 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
, AWS CloudFormation will create a new compute environment.- Allocation
Strategy string 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 AWS 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 AWS Batch User Guide .
BEST_FIT
is not 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 (default) - AWS 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, AWS 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 - AWS 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, AWS Batch will select new instance types.
- SPOT_CAPACITY_OPTIMIZED - AWS 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.
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, AWS Batch might need to go abovemaxvCpus
to meet your capacity requirements. In this event, AWS Batch never exceedsmaxvCpus
by more than a single instance.- BEST_FIT (default) - AWS 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, AWS 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
- Bid
Percentage int 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Desiredv
Cpus int The desired number of vCPUS in the compute environment. AWS 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. > AWS 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
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 AWS Batch in the AWS Batch User Guide .- Ec2Configuration
List<Pulumi.
Aws Native. Batch. Inputs. Compute Environment Ec2Configuration Object> 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 AWS 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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Ec2Key
Pair 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 Amazon EC2 key pair requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Image
Id string 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 AWS 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 .
- Instance
Role string 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 AWS 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Instance
Types List<string> 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 AWS 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,
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.- Launch
Template Pulumi.Aws Native. Batch. Inputs. Compute Environment Launch Template Specification 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 ** . 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 ** .
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
- Minv
Cpus int The minimum number of 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. Don't specify it.
- Placement
Group 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Security
Group List<string>Ids 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 AWS Batch User Guide .
- Spot
Iam stringFleet Role 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 AWS Batch User Guide .This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. > 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 AWS Batch User Guide .
- Dictionary<string, string>
- A key-value pair to associate with a resource.
- Update
To boolLatest Image Version Specifies whether the AMI ID is updated to the latest one that's supported by AWS Batch when the compute environment has an infrastructure update. The default value is
false
.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 AWS 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 AWS Batch User Guide .
- Maxv
Cpus int The maximum number of Amazon EC2 vCPUs that an environment can reach.
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, AWS Batch might need to exceedmaxvCpus
to meet your capacity requirements. In this event, AWS Batch never exceedsmaxvCpus
by more than a single instance.- Subnets []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 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 AWS Batch User Guide .
AWS Batch on Amazon EC2 and AWS 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 AWS Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and AWS Outposts in the Amazon ECS Developer Guide .
AWS Batch on Fargate doesn't currently support Local Zones.
- Type string
The type of compute environment:
EC2
,SPOT
,FARGATE
, orFARGATE_SPOT
. For more information, see Compute environments in the AWS 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 AWS 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 AWS 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
, AWS CloudFormation will create a new compute environment.- Allocation
Strategy string 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 AWS 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 AWS Batch User Guide .
BEST_FIT
is not 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 (default) - AWS 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, AWS 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 - AWS 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, AWS Batch will select new instance types.
- SPOT_CAPACITY_OPTIMIZED - AWS 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.
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, AWS Batch might need to go abovemaxvCpus
to meet your capacity requirements. In this event, AWS Batch never exceedsmaxvCpus
by more than a single instance.- BEST_FIT (default) - AWS 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, AWS 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
- Bid
Percentage int 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Desiredv
Cpus int The desired number of vCPUS in the compute environment. AWS 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. > AWS 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
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 AWS Batch in the AWS Batch User Guide .- Ec2Configuration
[]Compute
Environment Ec2Configuration Object 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 AWS 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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Ec2Key
Pair 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 Amazon EC2 key pair requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Image
Id string 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 AWS 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 .
- Instance
Role string 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 AWS 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Instance
Types []string 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 AWS 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,
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.- Launch
Template ComputeEnvironment Launch Template Specification 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 ** . 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 ** .
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
- Minv
Cpus int The minimum number of 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. Don't specify it.
- Placement
Group 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- Security
Group []stringIds 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 AWS Batch User Guide .
- Spot
Iam stringFleet Role 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 AWS Batch User Guide .This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. > 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 AWS Batch User Guide .
- map[string]string
- A key-value pair to associate with a resource.
- Update
To boolLatest Image Version Specifies whether the AMI ID is updated to the latest one that's supported by AWS Batch when the compute environment has an infrastructure update. The default value is
false
.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 AWS 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 AWS Batch User Guide .
- maxv
Cpus Integer The maximum number of Amazon EC2 vCPUs that an environment can reach.
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, AWS Batch might need to exceedmaxvCpus
to meet your capacity requirements. In this event, AWS Batch never exceedsmaxvCpus
by more than a single instance.- subnets List<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 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 AWS Batch User Guide .
AWS Batch on Amazon EC2 and AWS 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 AWS Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and AWS Outposts in the Amazon ECS Developer Guide .
AWS Batch on Fargate doesn't currently support Local Zones.
- type String
The type of compute environment:
EC2
,SPOT
,FARGATE
, orFARGATE_SPOT
. For more information, see Compute environments in the AWS 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 AWS 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 AWS 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
, AWS CloudFormation will create a new compute environment.- allocation
Strategy String 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 AWS 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 AWS Batch User Guide .
BEST_FIT
is not 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 (default) - AWS 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, AWS 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 - AWS 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, AWS Batch will select new instance types.
- SPOT_CAPACITY_OPTIMIZED - AWS 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.
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, AWS Batch might need to go abovemaxvCpus
to meet your capacity requirements. In this event, AWS Batch never exceedsmaxvCpus
by more than a single instance.- BEST_FIT (default) - AWS 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, AWS 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
- bid
Percentage Integer 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- desiredv
Cpus Integer The desired number of vCPUS in the compute environment. AWS 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. > AWS 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
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 AWS Batch in the AWS Batch User Guide .- ec2Configuration
List<Compute
Environment Ec2Configuration Object> 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 AWS 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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- ec2Key
Pair 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 Amazon EC2 key pair requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- image
Id String 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 AWS 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 .
- instance
Role String 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 AWS 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- instance
Types List<String> 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 AWS 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,
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.- launch
Template ComputeEnvironment Launch Template Specification 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 ** . 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 ** .
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
- minv
Cpus Integer The minimum number of 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. Don't specify it.
- placement
Group 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- security
Group List<String>Ids 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 AWS Batch User Guide .
- spot
Iam StringFleet Role 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 AWS Batch User Guide .This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. > 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 AWS Batch User Guide .
- Map<String,String>
- A key-value pair to associate with a resource.
- update
To BooleanLatest Image Version Specifies whether the AMI ID is updated to the latest one that's supported by AWS Batch when the compute environment has an infrastructure update. The default value is
false
.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 AWS 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 AWS Batch User Guide .
- maxv
Cpus number The maximum number of Amazon EC2 vCPUs that an environment can reach.
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, AWS Batch might need to exceedmaxvCpus
to meet your capacity requirements. In this event, AWS Batch never exceedsmaxvCpus
by more than a single instance.- subnets 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 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 AWS Batch User Guide .
AWS Batch on Amazon EC2 and AWS 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 AWS Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and AWS Outposts in the Amazon ECS Developer Guide .
AWS Batch on Fargate doesn't currently support Local Zones.
- type string
The type of compute environment:
EC2
,SPOT
,FARGATE
, orFARGATE_SPOT
. For more information, see Compute environments in the AWS 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 AWS 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 AWS 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
, AWS CloudFormation will create a new compute environment.- allocation
Strategy string 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 AWS 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 AWS Batch User Guide .
BEST_FIT
is not 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 (default) - AWS 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, AWS 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 - AWS 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, AWS Batch will select new instance types.
- SPOT_CAPACITY_OPTIMIZED - AWS 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.
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, AWS Batch might need to go abovemaxvCpus
to meet your capacity requirements. In this event, AWS Batch never exceedsmaxvCpus
by more than a single instance.- BEST_FIT (default) - AWS 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, AWS 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
- bid
Percentage number 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- desiredv
Cpus number The desired number of vCPUS in the compute environment. AWS 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. > AWS 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
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 AWS Batch in the AWS Batch User Guide .- ec2Configuration
Compute
Environment Ec2Configuration Object[] 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 AWS 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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- ec2Key
Pair 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 Amazon EC2 key pair requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- image
Id string 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 AWS 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 .
- instance
Role string 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 AWS 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- instance
Types string[] 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 AWS 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,
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.- launch
Template ComputeEnvironment Launch Template Specification 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 ** . 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 ** .
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
- minv
Cpus number The minimum number of 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. Don't specify it.
- placement
Group 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- security
Group string[]Ids 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 AWS Batch User Guide .
- spot
Iam stringFleet Role 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 AWS Batch User Guide .This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. > 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 AWS Batch User Guide .
- {[key: string]: string}
- A key-value pair to associate with a resource.
- update
To booleanLatest Image Version Specifies whether the AMI ID is updated to the latest one that's supported by AWS Batch when the compute environment has an infrastructure update. The default value is
false
.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 AWS 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 AWS Batch User Guide .
- maxv_
cpus int The maximum number of Amazon EC2 vCPUs that an environment can reach.
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, AWS Batch might need to exceedmaxvCpus
to meet your capacity requirements. In this event, AWS Batch never exceedsmaxvCpus
by more than a single instance.- subnets Sequence[str]
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 AWS Batch User Guide .
AWS Batch on Amazon EC2 and AWS 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 AWS Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and AWS Outposts in the Amazon ECS Developer Guide .
AWS Batch on Fargate doesn't currently support Local Zones.
- type str
The type of compute environment:
EC2
,SPOT
,FARGATE
, orFARGATE_SPOT
. For more information, see Compute environments in the AWS 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 AWS 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 AWS 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
, AWS CloudFormation will create a new compute environment.- allocation_
strategy str 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 AWS 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 AWS Batch User Guide .
BEST_FIT
is not 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 (default) - AWS 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, AWS 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 - AWS 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, AWS Batch will select new instance types.
- SPOT_CAPACITY_OPTIMIZED - AWS 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.
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, AWS Batch might need to go abovemaxvCpus
to meet your capacity requirements. In this event, AWS Batch never exceedsmaxvCpus
by more than a single instance.- BEST_FIT (default) - AWS 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, AWS 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
- bid_
percentage int 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- desiredv_
cpus int The desired number of vCPUS in the compute environment. AWS 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. > AWS 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
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 AWS Batch in the AWS Batch User Guide .- ec2_
configuration Sequence[ComputeEnvironment Ec2Configuration Object] 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 AWS 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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- ec2_
key_ strpair 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- image_
id str 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 AWS 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 .
- instance_
role str 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 AWS 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- instance_
types Sequence[str] 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 AWS 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,
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.- launch_
template ComputeEnvironment Launch Template Specification 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 ** . 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 ** .
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
- minv_
cpus int The minimum number of 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. Don't specify it.
- placement_
group str 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- security_
group_ Sequence[str]ids 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 AWS Batch User Guide .
- spot_
iam_ strfleet_ role 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 AWS Batch User Guide .This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. > 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 AWS Batch User Guide .
- Mapping[str, str]
- A key-value pair to associate with a resource.
- update_
to_ boollatest_ image_ version Specifies whether the AMI ID is updated to the latest one that's supported by AWS Batch when the compute environment has an infrastructure update. The default value is
false
.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 AWS 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 AWS Batch User Guide .
- maxv
Cpus Number The maximum number of Amazon EC2 vCPUs that an environment can reach.
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, AWS Batch might need to exceedmaxvCpus
to meet your capacity requirements. In this event, AWS Batch never exceedsmaxvCpus
by more than a single instance.- subnets List<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 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 AWS Batch User Guide .
AWS Batch on Amazon EC2 and AWS 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 AWS Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and AWS Outposts in the Amazon ECS Developer Guide .
AWS Batch on Fargate doesn't currently support Local Zones.
- type String
The type of compute environment:
EC2
,SPOT
,FARGATE
, orFARGATE_SPOT
. For more information, see Compute environments in the AWS 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 AWS 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 AWS 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
, AWS CloudFormation will create a new compute environment.- allocation
Strategy String 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 AWS 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 AWS Batch User Guide .
BEST_FIT
is not 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 (default) - AWS 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, AWS 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 - AWS 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, AWS Batch will select new instance types.
- SPOT_CAPACITY_OPTIMIZED - AWS 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.
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, AWS Batch might need to go abovemaxvCpus
to meet your capacity requirements. In this event, AWS Batch never exceedsmaxvCpus
by more than a single instance.- BEST_FIT (default) - AWS 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, AWS 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
- bid
Percentage Number 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- desiredv
Cpus Number The desired number of vCPUS in the compute environment. AWS 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. > AWS 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
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 AWS Batch in the AWS Batch User Guide .- ec2Configuration List<Property Map>
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 AWS 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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- ec2Key
Pair 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 Amazon EC2 key pair requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- image
Id String 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 AWS 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 .
- instance
Role String 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 AWS 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- instance
Types List<String> 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 AWS 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,
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.- launch
Template Property Map 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 ** . 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 ** .
This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
- minv
Cpus Number The minimum number of 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. Don't specify it.
- placement
Group 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 AWS Batch User Guide .
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
- security
Group List<String>Ids 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 AWS Batch User Guide .
- spot
Iam StringFleet Role 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 AWS Batch User Guide .This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. > 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 AWS Batch User Guide .
- Map<String>
- A key-value pair to associate with a resource.
- update
To BooleanLatest Image Version Specifies whether the AMI ID is updated to the latest one that's supported by AWS Batch when the compute environment has an infrastructure update. The default value is
false
.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 AWS 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 AWS Batch User Guide .
ComputeEnvironmentEc2ConfigurationObject
- Image
Type string The image type to match with the instance type to select an AMI. The supported values are different for
ECS
andEKS
resources.ECS - If the
imageIdOverride
parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI (ECS_AL2
) is used. If a new image type is specified in an update, but neither animageId
nor aimageIdOverride
parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's supported by AWS Batch is used.ECS_AL2 - Amazon Linux 2 : Default for all non-GPU instance families.
ECS_AL2_NVIDIA - Amazon Linux 2 (GPU) : Default for all GPU instance families (for example
P4
andG4
) and can be used for all non AWS Graviton-based instance types.ECS_AL2023 - Amazon Linux 2023 : AWS Batch supports Amazon Linux 2023.
Amazon Linux 2023 does not support
A1
instances.ECS_AL1 - Amazon Linux . Amazon Linux has reached the end-of-life of standard support. For more information, see Amazon Linux AMI .
EKS - If the
imageIdOverride
parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux AMI (EKS_AL2
) is used. If a new image type is specified in an update, but neither animageId
nor aimageIdOverride
parameter is specified, then the latest Amazon EKS optimized AMI for that image type that AWS Batch supports is used.EKS_AL2 - Amazon Linux 2 : Default for all non-GPU instance families.
EKS_AL2_NVIDIA - Amazon Linux 2 (accelerated) : Default for all GPU instance families (for example,
P4
andG4
) and can be used for all non AWS Graviton-based instance types.
- Image
Id stringOverride The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the
imageId
set in thecomputeResource
object.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 .
- Image
Kubernetes stringVersion - The Kubernetes version for the compute environment. If you don't specify a value, the latest version that AWS Batch supports is used.
- Image
Type string The image type to match with the instance type to select an AMI. The supported values are different for
ECS
andEKS
resources.ECS - If the
imageIdOverride
parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI (ECS_AL2
) is used. If a new image type is specified in an update, but neither animageId
nor aimageIdOverride
parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's supported by AWS Batch is used.ECS_AL2 - Amazon Linux 2 : Default for all non-GPU instance families.
ECS_AL2_NVIDIA - Amazon Linux 2 (GPU) : Default for all GPU instance families (for example
P4
andG4
) and can be used for all non AWS Graviton-based instance types.ECS_AL2023 - Amazon Linux 2023 : AWS Batch supports Amazon Linux 2023.
Amazon Linux 2023 does not support
A1
instances.ECS_AL1 - Amazon Linux . Amazon Linux has reached the end-of-life of standard support. For more information, see Amazon Linux AMI .
EKS - If the
imageIdOverride
parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux AMI (EKS_AL2
) is used. If a new image type is specified in an update, but neither animageId
nor aimageIdOverride
parameter is specified, then the latest Amazon EKS optimized AMI for that image type that AWS Batch supports is used.EKS_AL2 - Amazon Linux 2 : Default for all non-GPU instance families.
EKS_AL2_NVIDIA - Amazon Linux 2 (accelerated) : Default for all GPU instance families (for example,
P4
andG4
) and can be used for all non AWS Graviton-based instance types.
- Image
Id stringOverride The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the
imageId
set in thecomputeResource
object.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 .
- Image
Kubernetes stringVersion - The Kubernetes version for the compute environment. If you don't specify a value, the latest version that AWS Batch supports is used.
- image
Type String The image type to match with the instance type to select an AMI. The supported values are different for
ECS
andEKS
resources.ECS - If the
imageIdOverride
parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI (ECS_AL2
) is used. If a new image type is specified in an update, but neither animageId
nor aimageIdOverride
parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's supported by AWS Batch is used.ECS_AL2 - Amazon Linux 2 : Default for all non-GPU instance families.
ECS_AL2_NVIDIA - Amazon Linux 2 (GPU) : Default for all GPU instance families (for example
P4
andG4
) and can be used for all non AWS Graviton-based instance types.ECS_AL2023 - Amazon Linux 2023 : AWS Batch supports Amazon Linux 2023.
Amazon Linux 2023 does not support
A1
instances.ECS_AL1 - Amazon Linux . Amazon Linux has reached the end-of-life of standard support. For more information, see Amazon Linux AMI .
EKS - If the
imageIdOverride
parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux AMI (EKS_AL2
) is used. If a new image type is specified in an update, but neither animageId
nor aimageIdOverride
parameter is specified, then the latest Amazon EKS optimized AMI for that image type that AWS Batch supports is used.EKS_AL2 - Amazon Linux 2 : Default for all non-GPU instance families.
EKS_AL2_NVIDIA - Amazon Linux 2 (accelerated) : Default for all GPU instance families (for example,
P4
andG4
) and can be used for all non AWS Graviton-based instance types.
- image
Id StringOverride The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the
imageId
set in thecomputeResource
object.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 .
- image
Kubernetes StringVersion - The Kubernetes version for the compute environment. If you don't specify a value, the latest version that AWS Batch supports is used.
- image
Type string The image type to match with the instance type to select an AMI. The supported values are different for
ECS
andEKS
resources.ECS - If the
imageIdOverride
parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI (ECS_AL2
) is used. If a new image type is specified in an update, but neither animageId
nor aimageIdOverride
parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's supported by AWS Batch is used.ECS_AL2 - Amazon Linux 2 : Default for all non-GPU instance families.
ECS_AL2_NVIDIA - Amazon Linux 2 (GPU) : Default for all GPU instance families (for example
P4
andG4
) and can be used for all non AWS Graviton-based instance types.ECS_AL2023 - Amazon Linux 2023 : AWS Batch supports Amazon Linux 2023.
Amazon Linux 2023 does not support
A1
instances.ECS_AL1 - Amazon Linux . Amazon Linux has reached the end-of-life of standard support. For more information, see Amazon Linux AMI .
EKS - If the
imageIdOverride
parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux AMI (EKS_AL2
) is used. If a new image type is specified in an update, but neither animageId
nor aimageIdOverride
parameter is specified, then the latest Amazon EKS optimized AMI for that image type that AWS Batch supports is used.EKS_AL2 - Amazon Linux 2 : Default for all non-GPU instance families.
EKS_AL2_NVIDIA - Amazon Linux 2 (accelerated) : Default for all GPU instance families (for example,
P4
andG4
) and can be used for all non AWS Graviton-based instance types.
- image
Id stringOverride The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the
imageId
set in thecomputeResource
object.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 .
- image
Kubernetes stringVersion - The Kubernetes version for the compute environment. If you don't specify a value, the latest version that AWS Batch supports is used.
- image_
type str The image type to match with the instance type to select an AMI. The supported values are different for
ECS
andEKS
resources.ECS - If the
imageIdOverride
parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI (ECS_AL2
) is used. If a new image type is specified in an update, but neither animageId
nor aimageIdOverride
parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's supported by AWS Batch is used.ECS_AL2 - Amazon Linux 2 : Default for all non-GPU instance families.
ECS_AL2_NVIDIA - Amazon Linux 2 (GPU) : Default for all GPU instance families (for example
P4
andG4
) and can be used for all non AWS Graviton-based instance types.ECS_AL2023 - Amazon Linux 2023 : AWS Batch supports Amazon Linux 2023.
Amazon Linux 2023 does not support
A1
instances.ECS_AL1 - Amazon Linux . Amazon Linux has reached the end-of-life of standard support. For more information, see Amazon Linux AMI .
EKS - If the
imageIdOverride
parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux AMI (EKS_AL2
) is used. If a new image type is specified in an update, but neither animageId
nor aimageIdOverride
parameter is specified, then the latest Amazon EKS optimized AMI for that image type that AWS Batch supports is used.EKS_AL2 - Amazon Linux 2 : Default for all non-GPU instance families.
EKS_AL2_NVIDIA - Amazon Linux 2 (accelerated) : Default for all GPU instance families (for example,
P4
andG4
) and can be used for all non AWS Graviton-based instance types.
- image_
id_ stroverride The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the
imageId
set in thecomputeResource
object.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 .
- image_
kubernetes_ strversion - The Kubernetes version for the compute environment. If you don't specify a value, the latest version that AWS Batch supports is used.
- image
Type String The image type to match with the instance type to select an AMI. The supported values are different for
ECS
andEKS
resources.ECS - If the
imageIdOverride
parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI (ECS_AL2
) is used. If a new image type is specified in an update, but neither animageId
nor aimageIdOverride
parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's supported by AWS Batch is used.ECS_AL2 - Amazon Linux 2 : Default for all non-GPU instance families.
ECS_AL2_NVIDIA - Amazon Linux 2 (GPU) : Default for all GPU instance families (for example
P4
andG4
) and can be used for all non AWS Graviton-based instance types.ECS_AL2023 - Amazon Linux 2023 : AWS Batch supports Amazon Linux 2023.
Amazon Linux 2023 does not support
A1
instances.ECS_AL1 - Amazon Linux . Amazon Linux has reached the end-of-life of standard support. For more information, see Amazon Linux AMI .
EKS - If the
imageIdOverride
parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux AMI (EKS_AL2
) is used. If a new image type is specified in an update, but neither animageId
nor aimageIdOverride
parameter is specified, then the latest Amazon EKS optimized AMI for that image type that AWS Batch supports is used.EKS_AL2 - Amazon Linux 2 : Default for all non-GPU instance families.
EKS_AL2_NVIDIA - Amazon Linux 2 (accelerated) : Default for all GPU instance families (for example,
P4
andG4
) and can be used for all non AWS Graviton-based instance types.
- image
Id StringOverride The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the
imageId
set in thecomputeResource
object.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 .
- image
Kubernetes StringVersion - The Kubernetes version for the compute environment. If you don't specify a value, the latest version that AWS Batch supports is used.
ComputeEnvironmentLaunchTemplateSpecification
- Launch
Template stringId - The ID of the launch template.
- Launch
Template stringName - The name of the launch template.
- 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 totrue
. During an infrastructure update, if either$Latest
or$Default
is specified, AWS 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 AWS Batch User Guide .Default:
$Default
.
- Launch
Template stringId - The ID of the launch template.
- Launch
Template stringName - The name of the launch template.
- 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 totrue
. During an infrastructure update, if either$Latest
or$Default
is specified, AWS 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 AWS Batch User Guide .Default:
$Default
.
- launch
Template StringId - The ID of the launch template.
- launch
Template StringName - The name of the launch template.
- 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 totrue
. During an infrastructure update, if either$Latest
or$Default
is specified, AWS 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 AWS Batch User Guide .Default:
$Default
.
- launch
Template stringId - The ID of the launch template.
- launch
Template stringName - The name of the launch template.
- 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 totrue
. During an infrastructure update, if either$Latest
or$Default
is specified, AWS 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 AWS Batch User Guide .Default:
$Default
.
- launch_
template_ strid - The ID of the launch template.
- launch_
template_ strname - The name of the launch template.
- version str
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 totrue
. During an infrastructure update, if either$Latest
or$Default
is specified, AWS 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 AWS Batch User Guide .Default:
$Default
.
- launch
Template StringId - The ID of the launch template.
- launch
Template StringName - The name of the launch template.
- 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 totrue
. During an infrastructure update, if either$Latest
or$Default
is specified, AWS 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 AWS Batch User Guide .Default:
$Default
.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.