aws_sagemaker_image_version - add support for alias fixes #35931

Author: psantus

.changelog/42610.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+resource/aws_sagemaker_image_version: Add `aliases` argument
+```

internal/service/sagemaker/image_version.go

@@ -54,6 +54,13 @@ func resourceImageVersion() *schema.Resource {
 				Type:     schema.TypeString,
 				Computed: true,
 			},
+			"aliases": {
+				Type:     schema.TypeSet,
+				Optional: true,
+				Elem: &schema.Schema{
+					Type: schema.TypeString,
+				},
+			},
 			"base_image": {
 				Type:     schema.TypeString,
 				Required: true,
@@ -119,7 +126,7 @@ func resourceImageVersionCreate(ctx context.Context, d *schema.ResourceData, met
 	conn := meta.(*conns.AWSClient).SageMakerClient(ctx)
 
 	name := d.Get("image_name").(string)
-	input := sagemaker.CreateImageVersionInput{
+	input := &sagemaker.CreateImageVersionInput{
 		ImageName:   aws.String(name),
 		BaseImage:   aws.String(d.Get("base_image").(string)),
 		ClientToken: aws.String(id.UniqueId()),
@@ -153,7 +160,15 @@ func resourceImageVersionCreate(ctx context.Context, d *schema.ResourceData, met
 		input.ProgrammingLang = aws.String(v.(string))
 	}
 
-	if _, err := conn.CreateImageVersion(ctx, &input); err != nil {
+	if v, ok := d.GetOk("aliases"); ok {
+		aliases := v.(*schema.Set).List()
+		input.Aliases = make([]string, len(aliases))
+		for i, alias := range aliases {
+			input.Aliases[i] = alias.(string)
+		}
+	}
+
+	if _, err := conn.CreateImageVersion(ctx, input); err != nil {
 		return sdkdiag.AppendErrorf(diags, "creating SageMaker AI Image Version %s: %s", name, err)
 	}
 
@@ -208,6 +223,34 @@ func resourceImageVersionRead(ctx context.Context, d *schema.ResourceData, meta
 	d.Set("ml_framework", image.MLFramework)
 	d.Set("programming_lang", image.ProgrammingLang)
 
+	// The AWS SDK doesn't have an Aliases field in DescribeImageVersionOutput
+	// We need to fetch aliases separately using ListAliases API
+	idParts, err := flex.ExpandResourceId(d.Id(), imageVersionResourcePartCount, false)
+	if err != nil {
+		return sdkdiag.AppendErrorf(diags, "invalid resource ID format: %s", d.Id())
+	}
+	
+	imageName := idParts[0]
+	versionStr := idParts[1]
+	versionNum, err := strconv.Atoi(versionStr)
+	if err != nil {
+		return sdkdiag.AppendErrorf(diags, "invalid version number in resource ID: %s", d.Id())
+	}
+
+	aliasesInput := &sagemaker.ListAliasesInput{
+		ImageName: aws.String(imageName),
+		Version:   aws.Int32(int32(versionNum)),
+	}
+
+	aliasesOutput, err := conn.ListAliases(ctx, aliasesInput)
+	if err != nil {
+		return sdkdiag.AppendErrorf(diags, "listing aliases for SageMaker AI Image Version (%s): %s", d.Id(), err)
+	}
+
+	if err := d.Set("aliases", aliasesOutput.SageMakerImageVersionAliases); err != nil {
+		return sdkdiag.AppendErrorf(diags, "setting aliases: %s", err)
+	}
+
 	return diags
 }
 
@@ -218,7 +261,7 @@ func resourceImageVersionUpdate(ctx context.Context, d *schema.ResourceData, met
 	name := d.Get("image_name").(string)
 	version := d.Get(names.AttrVersion).(int)
 
-	input := sagemaker.UpdateImageVersionInput{
+	input := &sagemaker.UpdateImageVersionInput{
 		ImageName: aws.String(name),
 		Version:   aws.Int32(int32(version)),
 	}
@@ -251,7 +294,53 @@ func resourceImageVersionUpdate(ctx context.Context, d *schema.ResourceData, met
 		input.ProgrammingLang = aws.String(d.Get("programming_lang").(string))
 	}
 
-	if _, err := conn.UpdateImageVersion(ctx, &input); err != nil {
+	if d.HasChange("aliases") {
+		// For UpdateImageVersion, we need to use AliasesToAdd and AliasesToDelete
+		// instead of Aliases directly
+		oldAliasesSet, newAliasesSet := d.GetChange("aliases")
+		oldAliases := oldAliasesSet.(*schema.Set).List()
+		newAliases := newAliasesSet.(*schema.Set).List()
+
+		// Find aliases to add (in new but not in old)
+		var aliasesToAdd []string
+		for _, newAlias := range newAliases {
+			found := false
+			for _, oldAlias := range oldAliases {
+				if newAlias.(string) == oldAlias.(string) {
+					found = true
+					break
+				}
+			}
+			if !found {
+				aliasesToAdd = append(aliasesToAdd, newAlias.(string))
+			}
+		}
+
+		// Find aliases to delete (in old but not in new)
+		var aliasesToDelete []string
+		for _, oldAlias := range oldAliases {
+			found := false
+			for _, newAlias := range newAliases {
+				if oldAlias.(string) == newAlias.(string) {
+					found = true
+					break
+				}
+			}
+			if !found {
+				aliasesToDelete = append(aliasesToDelete, oldAlias.(string))
+			}
+		}
+
+		if len(aliasesToAdd) > 0 {
+			input.AliasesToAdd = aliasesToAdd
+		}
+
+		if len(aliasesToDelete) > 0 {
+			input.AliasesToDelete = aliasesToDelete
+		}
+	}
+
+	if _, err := conn.UpdateImageVersion(ctx, input); err != nil {
 		return sdkdiag.AppendErrorf(diags, "updating SageMaker AI Image Version (%s): %s", d.Id(), err)
 	}
 
@@ -353,7 +442,7 @@ func expandImageVersionResourceID(id string) (string, int, error) {
 	name := parts[0]
 	version, err := strconv.Atoi(parts[1])
 	if err != nil {
-		return name, version, err
+		return name, 0, err
 	}
 
 	return name, version, nil

internal/service/sagemaker/image_version_test.go

@@ -97,6 +97,9 @@ func TestAccSageMakerImageVersion_update(t *testing.T) {
 					resource.TestCheckResourceAttr(resourceName, "job_type", "TRAINING"),
 					resource.TestCheckResourceAttr(resourceName, "ml_framework", "TensorFlow 1.1"),
 					resource.TestCheckResourceAttr(resourceName, "programming_lang", "Python 3.8"),
+					resource.TestCheckResourceAttr(resourceName, "aliases.#", "2"),
+					resource.TestCheckTypeSetElemAttr(resourceName, "aliases.*", "latest"),
+					resource.TestCheckTypeSetElemAttr(resourceName, "aliases.*", "stable"),
 				),
 			},
 			{
@@ -121,6 +124,9 @@ func TestAccSageMakerImageVersion_update(t *testing.T) {
 					resource.TestCheckResourceAttr(resourceName, "job_type", "TRAINING"),
 					resource.TestCheckResourceAttr(resourceName, "ml_framework", "TensorFlow 1.1"),
 					resource.TestCheckResourceAttr(resourceName, "programming_lang", "Python 3.8"),
+					resource.TestCheckResourceAttr(resourceName, "aliases.#", "2"),
+					resource.TestCheckTypeSetElemAttr(resourceName, "aliases.*", "latest"),
+					resource.TestCheckTypeSetElemAttr(resourceName, "aliases.*", "stable"),
 				),
 				ConfigPlanChecks: resource.ConfigPlanChecks{
 					PreApply: []plancheck.PlanCheck{
@@ -404,6 +410,7 @@ resource "aws_sagemaker_image_version" "test" {
   vendor_guidance  = "STABLE"
   ml_framework     = "TensorFlow 1.1"
   programming_lang = "Python 3.8"
+  aliases          = ["latest", "stable"]
 }
 `, baseImage, notes))
 }

website/docs/cdktf/python/r/sagemaker_image_version.html.markdown

@@ -34,12 +34,34 @@ class MyConvertedCode(TerraformStack):
         )
 ```
 
+### With aliases
+
+```python
+# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
+from constructs import Construct
+from cdktf import Token, TerraformStack
+#
+# Provider bindings are generated by running `cdktf get`.
+# See https://cdk.tf/provider-generation for more details.
+#
+from imports.aws.sagemaker_image_version import SagemakerImageVersion
+class MyConvertedCode(TerraformStack):
+    def __init__(self, scope, name):
+        super().__init__(scope, name)
+        SagemakerImageVersion(self, "test",
+            aliases=["latest", "stable"],
+            base_image="012345678912.dkr.ecr.us-west-2.amazonaws.com/image:latest",
+            image_name=Token.as_string(aws_sagemaker_image_test.id)
+        )
+```
+
 ## Argument Reference
 
 This resource supports the following arguments:
 
 * `image_name` - (Required) The name of the image. Must be unique to your account.
 * `base_image` - (Required) The registry path of the container image on which this image version is based.
+* `aliases` - (Optional) A list of aliases for the image version.
 * `horovod` - (Optional) Indicates Horovod compatibility.
 * `job_type` - (Optional) Indicates SageMaker AI job type compatibility. Valid values are: `TRAINING`, `INFERENCE`, and `NOTEBOOK_KERNEL`.
 * `ml_framework` - (Optional) The machine learning framework vended in the image version.

website/docs/cdktf/typescript/r/sagemaker_image_version.html.markdown

@@ -34,7 +34,29 @@ class MyConvertedCode extends TerraformStack {
     });
   }
 }
+```
+
+### With aliases
 
+```typescript
+// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
+import { Construct } from "constructs";
+import { Token, TerraformStack } from "cdktf";
+/*
+ * Provider bindings are generated by running `cdktf get`.
+ * See https://cdk.tf/provider-generation for more details.
+ */
+import { SagemakerImageVersion } from "./.gen/providers/aws/sagemaker-image-version";
+class MyConvertedCode extends TerraformStack {
+  constructor(scope: Construct, name: string) {
+    super(scope, name);
+    new SagemakerImageVersion(this, "test", {
+      aliases: ["latest", "stable"],
+      baseImage: "012345678912.dkr.ecr.us-west-2.amazonaws.com/image:latest",
+      imageName: Token.asString(awsSagemakerImageTest.id),
+    });
+  }
+}
 ```
 
 ## Argument Reference
@@ -43,6 +65,7 @@ This resource supports the following arguments:
 
 * `imageName` - (Required) The name of the image. Must be unique to your account.
 * `baseImage` - (Required) The registry path of the container image on which this image version is based.
+* `aliases` - (Optional) A list of aliases for the image version.
 * `horovod` - (Optional) Indicates Horovod compatibility.
 * `jobType` - (Optional) Indicates SageMaker AI job type compatibility. Valid values are: `TRAINING`, `INFERENCE`, and `NOTEBOOK_KERNEL`.
 * `ml_framework` - (Optional) The machine learning framework vended in the image version.
@@ -83,7 +106,6 @@ class MyConvertedCode extends TerraformStack {
     );
   }
 }
-
 ```
 
 Using `terraform import`, import SageMaker AI Image Versions using the `name`. For example:

website/docs/r/sagemaker_image_version.html.markdown

@@ -21,12 +21,23 @@ resource "aws_sagemaker_image_version" "example" {
 }
 ```
 
+### With aliases
+
+```terraform
+resource "aws_sagemaker_image_version" "test" {
+  image_name = aws_sagemaker_image.test.id
+  base_image = "012345678912.dkr.ecr.us-west-2.amazonaws.com/image:latest"
+  aliases    = ["latest", "stable"]
+}
+```
+
 ## Argument Reference
 
 This resource supports the following arguments:
 
 * `image_name` - (Required) The name of the image. Must be unique to your account.
 * `base_image` - (Required) The registry path of the container image on which this image version is based.
+* `aliases` - (Optional) A list of aliases for the image version.
 * `horovod` - (Optional) Indicates Horovod compatibility.
 * `job_type` - (Optional) Indicates SageMaker AI job type compatibility. Valid values are: `TRAINING`, `INFERENCE`, and `NOTEBOOK_KERNEL`.
 * `ml_framework` - (Optional) The machine learning framework vended in the image version.