AWS Cloud Control v1.9.0, Nov 18 24

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.batch.getComputeEnvironment

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

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:

ComputeEnvironmentArn string: Returns the compute environment ARN, such as batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName* .

ComputeEnvironmentArn string: Returns the compute environment ARN, such as batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName* .

computeEnvironmentArn String: Returns the compute environment ARN, such as batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName* .

computeEnvironmentArn string: Returns the compute environment ARN, such as batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName* .

compute_environment_arn str: Returns the compute environment ARN, such as batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName* .

computeEnvironmentArn String: Returns the compute environment ARN, such as batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName* .

getComputeEnvironment Result

The following output properties are available:

ComputeEnvironmentArn string

Returns the compute environment ARN, such as batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName* .

ComputeResources Pulumi.AwsNative.Batch.Outputs.ComputeEnvironmentComputeResources

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 ** .

Context string

Reserved.

ServiceRole 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 name bar 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 the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

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 a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED 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 a c5.8xlarge instance with a minvCpus value of 4 and a desiredvCpus value of 36 . This instance doesn't scale down to a c5.large instance.

UnmanagedvCpus 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 to UNMANAGED .

ComputeEnvironmentArn string

Returns the compute environment ARN, such as batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName* .

ComputeResources ComputeEnvironmentComputeResources

Context string

Reserved.

ServiceRole string

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.

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 the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

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.

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 .

UnmanagedvCpus int

This parameter is only supported when the type parameter is set to UNMANAGED .

computeEnvironmentArn String

Returns the compute environment ARN, such as batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName* .

computeResources ComputeEnvironmentComputeResources

context String

Reserved.

serviceRole String

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.

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 the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

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.

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 .

unmanagedvCpus Integer

This parameter is only supported when the type parameter is set to UNMANAGED .

computeEnvironmentArn string

Returns the compute environment ARN, such as batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName* .

computeResources ComputeEnvironmentComputeResources

context string

Reserved.

serviceRole string

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.

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 the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

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.

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 .

unmanagedvCpus number

This parameter is only supported when the type parameter is set to UNMANAGED .

compute_environment_arn str

Returns the compute environment ARN, such as batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName* .

compute_resources ComputeEnvironmentComputeResources

context str

Reserved.

service_role str

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.

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 the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

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.

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 .

unmanagedv_cpus int

This parameter is only supported when the type parameter is set to UNMANAGED .

computeEnvironmentArn String

Returns the compute environment ARN, such as batch: *us-east-1* : *111122223333* :compute-environment/ *ComputeEnvironmentName* .

computeResources Property Map

context String

Reserved.

serviceRole String

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.

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 the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

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.

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 .

unmanagedvCpus Number

This parameter is only supported when the type parameter is set to UNMANAGED .

Supporting Types

ComputeEnvironmentComputeResources

MaxvCpus int

The maximum number of Amazon EC2 vCPUs that an environment can reach.

With BEST_FIT_PROGRESSIVE , SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, AWS Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds maxvCpus 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 , or FARGATE_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 the spotIamFleetRole 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 and SPOT or between FARGATE and FARGATE_SPOT will initiate an infrastructure update, but if you switch between EC2 and FARGATE , AWS CloudFormation will create a new compute environment.

AllocationStrategy 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 than SPOT_CAPACITY_OPTIMIZED in most instances.

With BEST_FIT_PROGRESSIVE , SPOT_CAPACITY_OPTIMIZED , and SPOT_PRICE_CAPACITY_OPTIMIZED allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, AWS Batch might need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds maxvCpus by more than a single instance.

BidPercentage 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.

DesiredvCpus 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 the minvCpus and maxvCpus values.
Additionally, the updated desiredvCpus value must be greater than or equal to the current desiredvCpus value. For more information, see Troubleshooting AWS Batch in the AWS Batch User Guide .

Ec2Configuration List<Pulumi.AwsNative.Batch.Inputs.ComputeEnvironmentEc2ConfigurationObject>

Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2 .

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the 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.

Ec2KeyPair string

The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this value to an empty string.

When updating a compute environment, changing the 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.

ImageId string

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure. To remove the custom AMI ID and use the default AMI ID, set this value to an empty string.

When updating a compute environment, changing the AMI ID requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the 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 .

InstanceRole 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* or arn:aws:iam:: *<aws_account_id>* :instance-profile/ *ecsInstanceRole* . For more information, see Amazon ECS instance role in the AWS Batch User Guide .

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

InstanceTypes 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 or p3 ), or you can specify specific sizes within a family (such as c5.8xlarge ). You can also choose optimal to select instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.

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.

LaunchTemplate Pulumi.AwsNative.Batch.Inputs.ComputeEnvironmentLaunchTemplateSpecification

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 to true .

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.

MinvCpus 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.

PlacementGroup string

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances .

When updating a compute environment, changing the placement group requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the AWS Batch User Guide .

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

SecurityGroupIds List<string>

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 .

SpotIamFleetRole string

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 to BEST_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 .

Tags Dictionary<string, string>

A key-value pair to associate with a resource.

UpdateToLatestImageVersion bool

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 or imageIdOverride parameters or be determined by the launch template that's specified in the launchTemplate 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 .

MaxvCpus int

The maximum number of Amazon EC2 vCPUs that an environment can reach.

With BEST_FIT_PROGRESSIVE , SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, AWS Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds maxvCpus by more than a single instance.

Subnets []string

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 , or FARGATE_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 the spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the AWS Batch User Guide .

AllocationStrategy string

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 than SPOT_CAPACITY_OPTIMIZED in most instances.

BidPercentage int

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

DesiredvCpus 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 the minvCpus and maxvCpus values.
Additionally, the updated desiredvCpus value must be greater than or equal to the current desiredvCpus value. For more information, see Troubleshooting AWS Batch in the AWS Batch User Guide .

Ec2Configuration []ComputeEnvironmentEc2ConfigurationObject

Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2 .

One or two values can be provided.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

Ec2KeyPair string

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

ImageId string

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. > The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide .

InstanceRole string

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

InstanceTypes []string

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.

LaunchTemplate ComputeEnvironmentLaunchTemplateSpecification

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.

MinvCpus 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.

PlacementGroup string

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

SecurityGroupIds []string

SpotIamFleetRole string

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 .

Tags map[string]string

A key-value pair to associate with a resource.

UpdateToLatestImageVersion bool

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 or imageIdOverride parameters or be determined by the launch template that's specified in the launchTemplate 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 .

maxvCpus Integer

The maximum number of Amazon EC2 vCPUs that an environment can reach.

With BEST_FIT_PROGRESSIVE , SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, AWS Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds maxvCpus by more than a single instance.

subnets List<String>

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 , or FARGATE_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 the spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the AWS Batch User Guide .

allocationStrategy String

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 than SPOT_CAPACITY_OPTIMIZED in most instances.

bidPercentage Integer

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

desiredvCpus 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 the minvCpus and maxvCpus values.
Additionally, the updated desiredvCpus value must be greater than or equal to the current desiredvCpus value. For more information, see Troubleshooting AWS Batch in the AWS Batch User Guide .

ec2Configuration List<ComputeEnvironmentEc2ConfigurationObject>

Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2 .

One or two values can be provided.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

ec2KeyPair String

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

imageId String

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. > The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide .

instanceRole String

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

instanceTypes List<String>

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.

launchTemplate ComputeEnvironmentLaunchTemplateSpecification

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.

minvCpus 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.

placementGroup String

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

securityGroupIds List<String>

spotIamFleetRole String

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 .

tags Map<String,String>

A key-value pair to associate with a resource.

updateToLatestImageVersion Boolean

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 or imageIdOverride parameters or be determined by the launch template that's specified in the launchTemplate 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 .

maxvCpus number

The maximum number of Amazon EC2 vCPUs that an environment can reach.

With BEST_FIT_PROGRESSIVE , SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, AWS Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds maxvCpus by more than a single instance.

subnets string[]

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 , or FARGATE_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 the spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the AWS Batch User Guide .

allocationStrategy string

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 than SPOT_CAPACITY_OPTIMIZED in most instances.

bidPercentage number

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

desiredvCpus 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 the minvCpus and maxvCpus values.
Additionally, the updated desiredvCpus value must be greater than or equal to the current desiredvCpus value. For more information, see Troubleshooting AWS Batch in the AWS Batch User Guide .

ec2Configuration ComputeEnvironmentEc2ConfigurationObject[]

Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2 .

One or two values can be provided.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

ec2KeyPair string

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

imageId string

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. > The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide .

instanceRole string

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

instanceTypes string[]

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.

launchTemplate ComputeEnvironmentLaunchTemplateSpecification

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.

minvCpus 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.

placementGroup string

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

securityGroupIds string[]

spotIamFleetRole string

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 .

tags {[key: string]: string}

A key-value pair to associate with a resource.

updateToLatestImageVersion boolean

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 or imageIdOverride parameters or be determined by the launch template that's specified in the launchTemplate 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 .

maxv_cpus int

The maximum number of Amazon EC2 vCPUs that an environment can reach.

With BEST_FIT_PROGRESSIVE , SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, AWS Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds maxvCpus by more than a single instance.

subnets Sequence[str]

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 , or FARGATE_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 the spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the AWS Batch User Guide .

allocation_strategy str

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 than SPOT_CAPACITY_OPTIMIZED in most instances.

bid_percentage int

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 the minvCpus and maxvCpus values.
Additionally, the updated desiredvCpus value must be greater than or equal to the current desiredvCpus value. For more information, see Troubleshooting AWS Batch in the AWS Batch User Guide .

ec2_configuration Sequence[ComputeEnvironmentEc2ConfigurationObject]

Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2 .

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_pair str

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

image_id str

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

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

instance_types Sequence[str]

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 ComputeEnvironmentLaunchTemplateSpecification

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

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

security_group_ids Sequence[str]

spot_iam_fleet_role str

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 .

tags Mapping[str, str]

A key-value pair to associate with a resource.

update_to_latest_image_version bool

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 or imageIdOverride parameters or be determined by the launch template that's specified in the launchTemplate 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 .

maxvCpus Number

The maximum number of Amazon EC2 vCPUs that an environment can reach.

With BEST_FIT_PROGRESSIVE , SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, AWS Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds maxvCpus by more than a single instance.

subnets List<String>

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 , or FARGATE_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 the spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the AWS Batch User Guide .

allocationStrategy String

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 than SPOT_CAPACITY_OPTIMIZED in most instances.

bidPercentage Number

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

desiredvCpus 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 the minvCpus and maxvCpus values.
Additionally, the updated desiredvCpus value must be greater than or equal to the current desiredvCpus 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 is ECS_AL2 .

One or two values can be provided.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

ec2KeyPair String

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

imageId String

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. > The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide .

instanceRole String

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

instanceTypes List<String>

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.

launchTemplate Property Map

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.

minvCpus 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.

placementGroup String

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

securityGroupIds List<String>

spotIamFleetRole String

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 .

tags Map<String>

A key-value pair to associate with a resource.

updateToLatestImageVersion Boolean

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 or imageIdOverride parameters or be determined by the launch template that's specified in the launchTemplate 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 .

ComputeEnvironmentEc2ConfigurationObject

ImageType string

The image type to match with the instance type to select an AMI. The supported values are different for ECS and EKS 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 an imageId nor a imageIdOverride 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 and G4 ) 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 an imageId nor a imageIdOverride 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 and G4 ) and can be used for all non AWS Graviton-based instance types.

ImageIdOverride string

The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the imageId set in the computeResource 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 .

ImageKubernetesVersion string

The Kubernetes version for the compute environment. If you don't specify a value, the latest version that AWS Batch supports is used.

ImageType string

The image type to match with the instance type to select an AMI. The supported values are different for ECS and EKS 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 an imageId nor a imageIdOverride 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 and G4 ) 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 an imageId nor a imageIdOverride 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 and G4 ) and can be used for all non AWS Graviton-based instance types.

ImageIdOverride string

The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the imageId set in the computeResource 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 .

ImageKubernetesVersion string

The Kubernetes version for the compute environment. If you don't specify a value, the latest version that AWS Batch supports is used.

imageType String

The image type to match with the instance type to select an AMI. The supported values are different for ECS and EKS 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 an imageId nor a imageIdOverride 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 and G4 ) 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 an imageId nor a imageIdOverride 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 and G4 ) and can be used for all non AWS Graviton-based instance types.

imageIdOverride String

The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the imageId set in the computeResource 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 .

imageKubernetesVersion String

The Kubernetes version for the compute environment. If you don't specify a value, the latest version that AWS Batch supports is used.

imageType string

The image type to match with the instance type to select an AMI. The supported values are different for ECS and EKS 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 an imageId nor a imageIdOverride 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 and G4 ) 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 an imageId nor a imageIdOverride 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 and G4 ) and can be used for all non AWS Graviton-based instance types.

imageIdOverride string

The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the imageId set in the computeResource 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 .

imageKubernetesVersion string

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 and EKS 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 an imageId nor a imageIdOverride 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 and G4 ) 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 an imageId nor a imageIdOverride 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 and G4 ) and can be used for all non AWS Graviton-based instance types.

image_id_override str

The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the imageId set in the computeResource 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_version str

The Kubernetes version for the compute environment. If you don't specify a value, the latest version that AWS Batch supports is used.

imageType String

The image type to match with the instance type to select an AMI. The supported values are different for ECS and EKS 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 an imageId nor a imageIdOverride 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 and G4 ) 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 an imageId nor a imageIdOverride 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 and G4 ) and can be used for all non AWS Graviton-based instance types.

imageIdOverride String

The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the imageId set in the computeResource 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 .

imageKubernetesVersion String

The Kubernetes version for the compute environment. If you don't specify a value, the latest version that AWS Batch supports is used.

ComputeEnvironmentLaunchTemplateSpecification

LaunchTemplateId string

The ID of the launch template.

LaunchTemplateName string

The name of the launch template.

Overrides List<Pulumi.AwsNative.Batch.Inputs.ComputeEnvironmentLaunchTemplateSpecificationOverride>

A launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both.

You can specify up to ten (10) launch template overrides that are associated to unique instance types or families for each compute environment.

To unset all override templates for a compute environment, you can pass an empty array to the UpdateComputeEnvironment.overrides parameter, or not include the overrides parameter when submitting the UpdateComputeEnvironment API operation.

Version string

The version number of the launch template, $Default , or $Latest .

If the value is $Default , the default version of the launch template is used. If the value is $Latest , the latest version of the launch template is used.

If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute environment is set to true . During an infrastructure update, if either $Default or $Latest 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

Latest: $Latest

LaunchTemplateId string

The ID of the launch template.

LaunchTemplateName string

The name of the launch template.

Overrides []ComputeEnvironmentLaunchTemplateSpecificationOverride

A launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both.

You can specify up to ten (10) launch template overrides that are associated to unique instance types or families for each compute environment.

To unset all override templates for a compute environment, you can pass an empty array to the UpdateComputeEnvironment.overrides parameter, or not include the overrides parameter when submitting the UpdateComputeEnvironment API operation.

Version string

The version number of the launch template, $Default , or $Latest .

If the value is $Default , the default version of the launch template is used. If the value is $Latest , the latest version of the launch template is used.

If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute environment is set to true . During an infrastructure update, if either $Default or $Latest 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

Latest: $Latest

launchTemplateId String

The ID of the launch template.

launchTemplateName String

The name of the launch template.

overrides List<ComputeEnvironmentLaunchTemplateSpecificationOverride>

A launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both.

You can specify up to ten (10) launch template overrides that are associated to unique instance types or families for each compute environment.

To unset all override templates for a compute environment, you can pass an empty array to the UpdateComputeEnvironment.overrides parameter, or not include the overrides parameter when submitting the UpdateComputeEnvironment API operation.

version String

The version number of the launch template, $Default , or $Latest .

If the value is $Default , the default version of the launch template is used. If the value is $Latest , the latest version of the launch template is used.

If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute environment is set to true . During an infrastructure update, if either $Default or $Latest 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

Latest: $Latest

launchTemplateId string

The ID of the launch template.

launchTemplateName string

The name of the launch template.

overrides ComputeEnvironmentLaunchTemplateSpecificationOverride[]

A launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both.

You can specify up to ten (10) launch template overrides that are associated to unique instance types or families for each compute environment.

To unset all override templates for a compute environment, you can pass an empty array to the UpdateComputeEnvironment.overrides parameter, or not include the overrides parameter when submitting the UpdateComputeEnvironment API operation.

version string

The version number of the launch template, $Default , or $Latest .

If the value is $Default , the default version of the launch template is used. If the value is $Latest , the latest version of the launch template is used.

If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute environment is set to true . During an infrastructure update, if either $Default or $Latest 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

Latest: $Latest

launch_template_id str

The ID of the launch template.

launch_template_name str

The name of the launch template.

overrides Sequence[ComputeEnvironmentLaunchTemplateSpecificationOverride]

A launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both.

You can specify up to ten (10) launch template overrides that are associated to unique instance types or families for each compute environment.

To unset all override templates for a compute environment, you can pass an empty array to the UpdateComputeEnvironment.overrides parameter, or not include the overrides parameter when submitting the UpdateComputeEnvironment API operation.

version str

The version number of the launch template, $Default , or $Latest .

If the value is $Default , the default version of the launch template is used. If the value is $Latest , the latest version of the launch template is used.

If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute environment is set to true . During an infrastructure update, if either $Default or $Latest 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

Latest: $Latest

launchTemplateId String

The ID of the launch template.

launchTemplateName String

The name of the launch template.

overrides List<Property Map>

A launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both.

You can specify up to ten (10) launch template overrides that are associated to unique instance types or families for each compute environment.

To unset all override templates for a compute environment, you can pass an empty array to the UpdateComputeEnvironment.overrides parameter, or not include the overrides parameter when submitting the UpdateComputeEnvironment API operation.

version String

The version number of the launch template, $Default , or $Latest .

If the value is $Default , the default version of the launch template is used. If the value is $Latest , the latest version of the launch template is used.

If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute environment is set to true . During an infrastructure update, if either $Default or $Latest 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

Latest: $Latest

ComputeEnvironmentLaunchTemplateSpecificationOverride

LaunchTemplateId string

The ID of the launch template.

Note: If you specify the launchTemplateId you can't specify the launchTemplateName as well.

LaunchTemplateName string

The name of the launch template.

Note: If you specify the launchTemplateName you can't specify the launchTemplateId as well.

TargetInstanceTypes List<string>

The instance type or family that this this override launch template should be applied to.

This parameter is required when defining a launch template override.

Information included in this parameter must meet the following requirements:

Must be a valid Amazon EC2 instance type or family.
optimal isn't allowed.
targetInstanceTypes can target only instance types and families that are included within the ComputeResource.instanceTypes set. targetInstanceTypes doesn't need to include all of the instances from the instanceType set, but at least a subset. For example, if ComputeResource.instanceTypes includes [m5, g5] , targetInstanceTypes can include [m5.2xlarge] and [m5.large] but not [c5.large] .
targetInstanceTypes included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.

Version string

The version number of the launch template, $Default , or $Latest .

If the value is $Default , the default version of the launch template is used. If the value is $Latest , the latest version of the launch template is used.

If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute environment is set to true . During an infrastructure update, if either $Default or $Latest 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

Latest: $Latest

LaunchTemplateId string

The ID of the launch template.

Note: If you specify the launchTemplateId you can't specify the launchTemplateName as well.

LaunchTemplateName string

The name of the launch template.

Note: If you specify the launchTemplateName you can't specify the launchTemplateId as well.

TargetInstanceTypes []string

The instance type or family that this this override launch template should be applied to.

This parameter is required when defining a launch template override.

Information included in this parameter must meet the following requirements:

Must be a valid Amazon EC2 instance type or family.
optimal isn't allowed.
targetInstanceTypes can target only instance types and families that are included within the ComputeResource.instanceTypes set. targetInstanceTypes doesn't need to include all of the instances from the instanceType set, but at least a subset. For example, if ComputeResource.instanceTypes includes [m5, g5] , targetInstanceTypes can include [m5.2xlarge] and [m5.large] but not [c5.large] .
targetInstanceTypes included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.

Version string

The version number of the launch template, $Default , or $Latest .

If the value is $Default , the default version of the launch template is used. If the value is $Latest , the latest version of the launch template is used.

If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute environment is set to true . During an infrastructure update, if either $Default or $Latest 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

Latest: $Latest

launchTemplateId String

The ID of the launch template.

Note: If you specify the launchTemplateId you can't specify the launchTemplateName as well.

launchTemplateName String

The name of the launch template.

Note: If you specify the launchTemplateName you can't specify the launchTemplateId as well.

targetInstanceTypes List<String>

The instance type or family that this this override launch template should be applied to.

This parameter is required when defining a launch template override.

Information included in this parameter must meet the following requirements:

Must be a valid Amazon EC2 instance type or family.
optimal isn't allowed.
targetInstanceTypes can target only instance types and families that are included within the ComputeResource.instanceTypes set. targetInstanceTypes doesn't need to include all of the instances from the instanceType set, but at least a subset. For example, if ComputeResource.instanceTypes includes [m5, g5] , targetInstanceTypes can include [m5.2xlarge] and [m5.large] but not [c5.large] .
targetInstanceTypes included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.

version String

The version number of the launch template, $Default , or $Latest .

If the value is $Default , the default version of the launch template is used. If the value is $Latest , the latest version of the launch template is used.

If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute environment is set to true . During an infrastructure update, if either $Default or $Latest 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

Latest: $Latest

launchTemplateId string

The ID of the launch template.

Note: If you specify the launchTemplateId you can't specify the launchTemplateName as well.

launchTemplateName string

The name of the launch template.

Note: If you specify the launchTemplateName you can't specify the launchTemplateId as well.

targetInstanceTypes string[]

The instance type or family that this this override launch template should be applied to.

This parameter is required when defining a launch template override.

Information included in this parameter must meet the following requirements:

Must be a valid Amazon EC2 instance type or family.
optimal isn't allowed.
targetInstanceTypes can target only instance types and families that are included within the ComputeResource.instanceTypes set. targetInstanceTypes doesn't need to include all of the instances from the instanceType set, but at least a subset. For example, if ComputeResource.instanceTypes includes [m5, g5] , targetInstanceTypes can include [m5.2xlarge] and [m5.large] but not [c5.large] .
targetInstanceTypes included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.

version string

The version number of the launch template, $Default , or $Latest .

If the value is $Default , the default version of the launch template is used. If the value is $Latest , the latest version of the launch template is used.

If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute environment is set to true . During an infrastructure update, if either $Default or $Latest 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

Latest: $Latest

launch_template_id str

The ID of the launch template.

Note: If you specify the launchTemplateId you can't specify the launchTemplateName as well.

launch_template_name str

The name of the launch template.

Note: If you specify the launchTemplateName you can't specify the launchTemplateId as well.

target_instance_types Sequence[str]

The instance type or family that this this override launch template should be applied to.

This parameter is required when defining a launch template override.

Information included in this parameter must meet the following requirements:

Must be a valid Amazon EC2 instance type or family.
optimal isn't allowed.
targetInstanceTypes can target only instance types and families that are included within the ComputeResource.instanceTypes set. targetInstanceTypes doesn't need to include all of the instances from the instanceType set, but at least a subset. For example, if ComputeResource.instanceTypes includes [m5, g5] , targetInstanceTypes can include [m5.2xlarge] and [m5.large] but not [c5.large] .
targetInstanceTypes included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.

version str

The version number of the launch template, $Default , or $Latest .

If the value is $Default , the default version of the launch template is used. If the value is $Latest , the latest version of the launch template is used.

If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute environment is set to true . During an infrastructure update, if either $Default or $Latest 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

Latest: $Latest

launchTemplateId String

The ID of the launch template.

Note: If you specify the launchTemplateId you can't specify the launchTemplateName as well.

launchTemplateName String

The name of the launch template.

Note: If you specify the launchTemplateName you can't specify the launchTemplateId as well.

targetInstanceTypes List<String>

The instance type or family that this this override launch template should be applied to.

This parameter is required when defining a launch template override.

Information included in this parameter must meet the following requirements:

Must be a valid Amazon EC2 instance type or family.
optimal isn't allowed.
targetInstanceTypes can target only instance types and families that are included within the ComputeResource.instanceTypes set. targetInstanceTypes doesn't need to include all of the instances from the instanceType set, but at least a subset. For example, if ComputeResource.instanceTypes includes [m5, g5] , targetInstanceTypes can include [m5.2xlarge] and [m5.large] but not [c5.large] .
targetInstanceTypes included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.

version String

The version number of the launch template, $Default , or $Latest .

If the value is $Default , the default version of the launch template is used. If the value is $Latest , the latest version of the launch template is used.

If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute environment is set to true . During an infrastructure update, if either $Default or $Latest 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

Latest: $Latest

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.batch.getComputeEnvironment

On this page

On this page

Using getComputeEnvironment

getComputeEnvironment Result

Supporting Types

ComputeEnvironmentComputeResources

ComputeEnvironmentEc2ConfigurationObject

ComputeEnvironmentLaunchTemplateSpecification

ComputeEnvironmentLaunchTemplateSpecificationOverride

Package Details

On this page

On this page