From 528e5df8e052be00d63e83db1fbdb46a0b066a91 Mon Sep 17 00:00:00 2001 From: Ashish Dhingra <67916761+ashishdhingra@users.noreply.github.com> Date: Thu, 27 Feb 2025 16:02:52 -0800 Subject: [PATCH] chore(batch): corrected the documentation string for updateToLatestImageVersion in ManagedComputeEnvironmentProps. (#33594) ### Issue # (if applicable) Closes #33582. ### Reason for this change Documentation string for `updateToLatestImageVersion` in `ManagedComputeEnvironmentProps` was incorrect w.r.t. changes introduced in [diff](https://github.com/aws/aws-cdk/pull/27059/files#diff-7ae09067a7ce8a58d494da3c01be13161be021e9cdb96008221d6e16cd0366b3). ### Description of changes Corrected the documentation string for `updateToLatestImageVersion` in `ManagedComputeEnvironmentProps`. (taken from [IManagedComputeEnvironment](https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-batch/lib/managed-compute-environment.ts#L97-L99)) ### Describe any new or updated permissions being added N/A ### Description of how you validated changes N/A (simple documentation fix) ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* --- .../aws-batch/lib/managed-compute-environment.ts | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/packages/aws-cdk-lib/aws-batch/lib/managed-compute-environment.ts b/packages/aws-cdk-lib/aws-batch/lib/managed-compute-environment.ts index 82b81d4fdf5e4..cf3b41b26f5a6 100644 --- a/packages/aws-cdk-lib/aws-batch/lib/managed-compute-environment.ts +++ b/packages/aws-cdk-lib/aws-batch/lib/managed-compute-environment.ts @@ -194,7 +194,12 @@ export interface ManagedComputeEnvironmentProps extends ComputeEnvironmentProps * * If you specify a specific AMI, this property will be ignored. * - * @default true + * Note: the CDK will never set this value by default, `false` will set by CFN. + * This is to avoid a deployment failure that occurs when this value is set. + * + * @see https://github.com/aws/aws-cdk/issues/27054 + * + * @default false */ readonly updateToLatestImageVersion?: boolean; }