Skip to content

Commit 528e5df

Browse files
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*
1 parent e220bc8 commit 528e5df

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

packages/aws-cdk-lib/aws-batch/lib/managed-compute-environment.ts

+6-1
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,12 @@ export interface ManagedComputeEnvironmentProps extends ComputeEnvironmentProps
194194
*
195195
* If you specify a specific AMI, this property will be ignored.
196196
*
197-
* @default true
197+
* Note: the CDK will never set this value by default, `false` will set by CFN.
198+
* This is to avoid a deployment failure that occurs when this value is set.
199+
*
200+
* @see https://github.com/aws/aws-cdk/issues/27054
201+
*
202+
* @default false
198203
*/
199204
readonly updateToLatestImageVersion?: boolean;
200205
}

0 commit comments

Comments
 (0)