Skip to content

Commit

Permalink
chore: updates container-definition user jsdoc (#26231)
Browse files Browse the repository at this point in the history
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*
  • Loading branch information
MichaelLeeHobbs authored Jul 5, 2023
1 parent 45e2157 commit 3a1837a
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion packages/aws-cdk-lib/aws-ecs/lib/container-definition.ts
Original file line number Diff line number Diff line change
Expand Up @@ -294,8 +294,9 @@ export interface ContainerDefinitionOptions {
readonly readonlyRootFilesystem?: boolean;

/**
* The user name to use inside the container.
* 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.
*
* @see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#ContainerDefinition-user
* @default root
*/
readonly user?: string;
Expand Down

0 comments on commit 3a1837a

Please sign in to comment.