Skip to content

Commit 3a1837a

Browse files
chore: updates container-definition user jsdoc (#26231)
Update JSDOC for `user` to clarify that this is a `user string` and not restricted to a user name. Reason for this change: When viewing the documentation from an IDE it is unclear that something other than a user name can be used for example 100:101 ie UID and GID. I have not fully read the following: [CONTRIBUTING GUIDE]: https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md [DESIGN GUIDELINES]: https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md This commit/pull request only changes JSDoc. Closes #26230 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 45e2157 commit 3a1837a

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

packages/aws-cdk-lib/aws-ecs/lib/container-definition.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -294,8 +294,9 @@ export interface ContainerDefinitionOptions {
294294
readonly readonlyRootFilesystem?: boolean;
295295

296296
/**
297-
* The user name to use inside the container.
297+
* The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
298298
*
299+
* @see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#ContainerDefinition-user
299300
* @default root
300301
*/
301302
readonly user?: string;

0 commit comments

Comments
 (0)