Skip to content

Commit fd3b907

Browse files
author
awstools
committed
docs(client-batch): Starting in JAN 2026, AWS Batch will change the default AMI for new Amazon ECS compute environments from Amazon Linux 2 to Amazon Linux 2023. We recommend migrating AWS Batch Amazon ECS compute environments to Amazon Linux 2023 to maintain optimal performance and security.
1 parent 9e3a3e0 commit fd3b907

File tree

3 files changed

+32
-92
lines changed

3 files changed

+32
-92
lines changed

clients/client-batch/src/commands/CreateComputeEnvironmentCommand.ts

Lines changed: 1 addition & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,6 @@ export interface CreateComputeEnvironmentCommandOutput extends CreateComputeEnvi
4040
* your managed compute environment. You can optionally set a maximum price so that Spot
4141
* Instances only launch when the Spot Instance price is less than a specified percentage of the
4242
* On-Demand price.</p>
43-
* <note>
44-
* <p>Multi-node parallel jobs aren't supported on Spot Instances.</p>
45-
* </note>
4643
* <p>In an unmanaged compute environment, you can manage your own EC2 compute resources and
4744
* have flexibility with how you configure your compute resources. For example, you can use
4845
* custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance
@@ -53,75 +50,8 @@ export interface CreateComputeEnvironmentCommandOutput extends CreateComputeEnvi
5350
* cluster. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html">Launching an Amazon ECS container
5451
* instance</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
5552
* <note>
56-
* <p>To create a compute environment that uses EKS resources, the caller must have
57-
* permissions to call <code>eks:DescribeCluster</code>.</p>
58-
* </note>
59-
* <note>
6053
* <p>Batch doesn't automatically upgrade the AMIs in a compute environment after it's
61-
* created. For example, it also doesn't update the AMIs in your compute environment when a
62-
* newer version of the Amazon ECS optimized AMI is available. You're responsible for the management
63-
* of the guest operating system. This includes any updates and security patches. You're also
64-
* responsible for any additional application software or utilities that you install on the
65-
* compute resources. There are two ways to use a new AMI for your Batch jobs. The original
66-
* method is to complete these steps:</p>
67-
* <ol>
68-
* <li>
69-
* <p>Create a new compute environment with the new AMI.</p>
70-
* </li>
71-
* <li>
72-
* <p>Add the compute environment to an existing job queue.</p>
73-
* </li>
74-
* <li>
75-
* <p>Remove the earlier compute environment from your job queue.</p>
76-
* </li>
77-
* <li>
78-
* <p>Delete the earlier compute environment.</p>
79-
* </li>
80-
* </ol>
81-
* <p>In April 2022, Batch added enhanced support for updating compute environments. For
82-
* more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a>.
83-
* To use the enhanced updating of compute environments to update AMIs, follow these
84-
* rules:</p>
85-
* <ul>
86-
* <li>
87-
* <p>Either don't set the service role (<code>serviceRole</code>) parameter or set it to
88-
* the <b>AWSBatchServiceRole</b> service-linked role.</p>
89-
* </li>
90-
* <li>
91-
* <p>Set the allocation strategy (<code>allocationStrategy</code>) parameter to
92-
* <code>BEST_FIT_PROGRESSIVE</code>, <code>SPOT_CAPACITY_OPTIMIZED</code>, or
93-
* <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>.</p>
94-
* </li>
95-
* <li>
96-
* <p>Set the update to latest image version (<code>updateToLatestImageVersion</code>)
97-
* parameter to <code>true</code>. The <code>updateToLatestImageVersion</code> parameter
98-
* is used when you update a compute environment. This parameter is ignored when you create
99-
* a compute environment.</p>
100-
* </li>
101-
* <li>
102-
* <p>Don't specify an AMI ID in <code>imageId</code>, <code>imageIdOverride</code> (in
103-
* <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_Ec2Configuration.html">
104-
* <code>ec2Configuration</code>
105-
* </a>), or in the launch template
106-
* (<code>launchTemplate</code>). In that case, Batch selects the latest Amazon ECS
107-
* optimized AMI that's supported by Batch at the time the infrastructure update is
108-
* initiated. Alternatively, you can specify the AMI ID in the <code>imageId</code> or
109-
* <code>imageIdOverride</code> parameters, or the launch template identified by the
110-
* <code>LaunchTemplate</code> properties. Changing any of these properties starts an
111-
* infrastructure update. If the AMI ID is specified in the launch template, it can't be
112-
* replaced by specifying an AMI ID in either the <code>imageId</code> or
113-
* <code>imageIdOverride</code> parameters. It can only be replaced by specifying a
114-
* different launch template, or if the launch template version is set to
115-
* <code>$Default</code> or <code>$Latest</code>, by setting either a new default version
116-
* for the launch template (if <code>$Default</code>) or by adding a new version to the
117-
* launch template (if <code>$Latest</code>).</p>
118-
* </li>
119-
* </ul>
120-
* <p>If these rules are followed, any update that starts an infrastructure update causes the
121-
* AMI ID to be re-selected. If the <code>version</code> setting in the launch template
122-
* (<code>launchTemplate</code>) is set to <code>$Latest</code> or <code>$Default</code>, the
123-
* latest or default version of the launch template is evaluated up at the time of the
124-
* infrastructure update, even if the <code>launchTemplate</code> wasn't updated.</p>
54+
* created. For more information on how to update a compute environment's AMI, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the <i>Batch User Guide</i>.</p>
12555
* </note>
12656
* @example
12757
* Use a bare-bones client and the command you need to make an API call.

clients/client-batch/src/models/models_0.ts

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -367,6 +367,13 @@ export interface Ec2Configuration {
367367
* specified in an update, but neither an <code>imageId</code> nor a <code>imageIdOverride</code>
368368
* parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's
369369
* supported by Batch is used.</p>
370+
* <important>
371+
* <p>Amazon Web Services will end support for Amazon ECS optimized AL2-optimized and AL2-accelerated AMIs. Starting in January 2026, Batch will change
372+
* the default AMI for new Amazon ECS compute environments from Amazon Linux 2 to Amazon Linux 2023.
373+
* We recommend migrating Batch Amazon ECS compute environments to Amazon Linux 2023 to maintain
374+
* optimal performance and security. For more information on upgrading from AL2 to AL2023, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/ecs-migration-2023.html">How to migrate
375+
* from ECS AL2 to ECS AL2023</a> in the <i>Batch User Guide</i>.</p>
376+
* </important>
370377
* <dl>
371378
* <dt>ECS_AL2</dt>
372379
* <dd>
@@ -399,12 +406,6 @@ export interface Ec2Configuration {
399406
* <p>ECS_AL2023_NVIDIA doesn't support <code>p3</code> and <code>g3</code> instance types.</p>
400407
* </note>
401408
* </dd>
402-
* <dt>ECS_AL1</dt>
403-
* <dd>
404-
* <p>
405-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami">Amazon Linux</a>. Amazon Linux has
406-
* reached the end-of-life of standard support. For more information, see <a href="http://aws.amazon.com/amazon-linux-ami/">Amazon Linux AMI</a>.</p>
407-
* </dd>
408409
* </dl>
409410
* </dd>
410411
* <dt>EKS</dt>
@@ -423,7 +424,7 @@ export interface Ec2Configuration {
423424
* using Batch-provided Amazon EKS optimized Amazon Linux 2 AMIs on your Amazon EKS compute
424425
* environments beyond the 11/26/25 end-of-support date, these compute environments will no
425426
* longer receive any new software updates, security patches, or bug fixes from
426-
* Amazon Web Services. For more information on upgrading from AL2 to AL2023, see <a href="">How to upgrade from EKS AL2 to EKS AL2023</a> in the <i>Batch User Guide</i>.</p>
427+
* Amazon Web Services. For more information on upgrading from AL2 to AL2023, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/eks-migration-2023.html">How to upgrade from EKS AL2 to EKS AL2023</a> in the <i>Batch User Guide</i>.</p>
427428
* </important>
428429
* <dl>
429430
* <dt>EKS_AL2</dt>
@@ -692,6 +693,9 @@ export interface ComputeResource {
692693
* <p> If you choose <code>SPOT</code>, you must also specify an Amazon EC2 Spot Fleet role with the
693694
* <code>spotIamFleetRole</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html">Amazon EC2 spot fleet role</a> in the
694695
* <i>Batch User Guide</i>.</p>
696+
* <note>
697+
* <p>Multi-node parallel jobs aren't supported on Spot Instances.</p>
698+
* </note>
695699
* @public
696700
*/
697701
type: CRType | undefined;
@@ -1168,6 +1172,10 @@ export interface CreateComputeEnvironmentRequest {
11681172

11691173
/**
11701174
* <p>The details for the Amazon EKS cluster that supports the compute environment.</p>
1175+
* <note>
1176+
* <p>To create a compute environment that uses EKS resources, the caller must have
1177+
* permissions to call <code>eks:DescribeCluster</code>.</p>
1178+
* </note>
11711179
* @public
11721180
*/
11731181
eksConfiguration?: EksConfiguration | undefined;
@@ -2554,7 +2562,7 @@ export interface LogConfiguration {
25542562
/**
25552563
* <p>The log driver to use for the container. The valid values that are listed for this parameter
25562564
* are log drivers that the Amazon ECS container agent can communicate with by default.</p>
2557-
* <p>The supported log drivers are <code>awslogs</code>, <code>fluentd</code>, <code>gelf</code>,
2565+
* <p>The supported log drivers are <code>awsfirelens</code>, <code>awslogs</code>, <code>fluentd</code>, <code>gelf</code>,
25582566
* <code>json-file</code>, <code>journald</code>, <code>logentries</code>, <code>syslog</code>, and
25592567
* <code>splunk</code>.</p>
25602568
* <note>
@@ -5708,7 +5716,8 @@ export interface EcsTaskDetails {
57085716
platformVersion?: string | undefined;
57095717

57105718
/**
5711-
* <p>The IPC resource namespace to use for the containers in the task.</p>
5719+
* <p>The IPC resource namespace to use for the containers in the task. The valid values are
5720+
* <code>host</code>, <code>task</code>, or <code>none</code>. For more information see <code>ipcMode</code> in <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_EcsTaskProperties.html">EcsTaskProperties</a>.</p>
57125721
* @public
57135722
*/
57145723
ipcMode?: string | undefined;
@@ -5725,7 +5734,8 @@ export interface EcsTaskDetails {
57255734
taskRoleArn?: string | undefined;
57265735

57275736
/**
5728-
* <p>The process namespace to use for the containers in the task.</p>
5737+
* <p>The process namespace to use for the containers in the task. The valid values are
5738+
* <code>host</code>, or <code>task</code>. For more information see <code>pidMode</code> in <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_EcsTaskProperties.html">EcsTaskProperties</a>.</p>
57295739
* @public
57305740
*/
57315741
pidMode?: string | undefined;
@@ -8487,9 +8497,9 @@ export interface SubmitServiceJobRequest {
84878497
serviceJobType: ServiceJobType | undefined;
84888498

84898499
/**
8490-
* <p>The share identifier for the service job. Don't specify this parameter if the job queue doesn't have a fair-
8491-
* share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter
8492-
* must be specified.</p>
8500+
* <p>The share identifier for the service job. Don't specify this parameter if the job
8501+
* queue doesn't have a fair-share scheduling policy. If the job queue has a fair-share
8502+
* scheduling policy, then this parameter must be specified.</p>
84938503
* @public
84948504
*/
84958505
shareIdentifier?: string | undefined;

0 commit comments

Comments
 (0)