chore(ecs): clarify it's possible to use image digest on fromEcrRepos…

…itory (#27115) It is not clear whether we can use image digest on `ContainerImage.fromEcrRepository`. Change the property name from `tag` to `tagOrDigest` to clarify the ability to use image digest. Also add document about the parameter format. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
aws · Sep 12, 2023 · 9f07911 · 9f07911
1 parent c5e0836
commit 9f07911
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/packages/@aws-cdk/aws-sagemaker-alpha/lib/container-image.ts b/packages/@aws-cdk/aws-sagemaker-alpha/lib/container-image.ts
@@ -26,9 +26,12 @@ export interface ContainerImageConfig {
 export abstract class ContainerImage {
   /**
    * Reference an image in an ECR repository
+   *
+   * @param repository ECR repository
+   * @param tagOrDigest Optional image tag or digest (digests must start with `sha256:`)
    */
-  public static fromEcrRepository(repository: ecr.IRepository, tag: string = 'latest'): ContainerImage {
-    return new EcrImage(repository, tag);
+  public static fromEcrRepository(repository: ecr.IRepository, tagOrDigest: string = 'latest'): ContainerImage {
+    return new EcrImage(repository, tagOrDigest);
   }
 
   /**

diff --git a/packages/aws-cdk-lib/aws-ecs/lib/container-image.ts b/packages/aws-cdk-lib/aws-ecs/lib/container-image.ts
@@ -18,9 +18,12 @@ export abstract class ContainerImage {
 
   /**
    * Reference an image in an ECR repository
+   *
+   * @param repository ECR repository
+   * @param tagOrDigest Optional image tag or digest (digests must start with `sha256:`)
    */
-  public static fromEcrRepository(repository: ecr.IRepository, tag: string = 'latest') {
-    return new EcrImage(repository, tag);
+  public static fromEcrRepository(repository: ecr.IRepository, tagOrDigest: string = 'latest') {
+    return new EcrImage(repository, tagOrDigest);
   }
 
   /**