Skip to content

Commit

Permalink
chore(batch): corrected the documentation string for updateToLatestIm…
Browse files Browse the repository at this point in the history
…ageVersion in ManagedComputeEnvironmentProps. (aws#33594)

### Issue # (if applicable)

Closes aws#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*
  • Loading branch information
ashishdhingra authored Feb 28, 2025
1 parent e220bc8 commit 528e5df
Showing 1 changed file with 6 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down

0 comments on commit 528e5df

Please sign in to comment.