aws_sagemaker_image_version - use version, not just name, in resource id fixes #42605

Author: psantus

.changelog/42606.txt

@@ -0,0 +1,3 @@
+```release-note:bug
+resource/aws_sagemaker_image_version: Use version as part of resource id, avoiding mix up between similar resources
+```

internal/service/sagemaker/image_version.go

@@ -5,7 +5,10 @@ package sagemaker
 
 import (
 	"context"
+	"fmt"
 	"log"
+	"strconv"
+	"strings"
 
 	"github.com/YakDriver/regexache"
 	"github.com/aws/aws-sdk-go-v2/aws"
@@ -144,10 +147,22 @@ func resourceImageVersionCreate(ctx context.Context, d *schema.ResourceData, met
 		return sdkdiag.AppendErrorf(diags, "creating SageMaker AI Image Version %s: %s", name, err)
 	}
 
-	d.SetId(name)
+	// Get the version from the API response
+	output, err := conn.DescribeImageVersion(ctx, &sagemaker.DescribeImageVersionInput{
+		ImageName: aws.String(name),
+	})
+	if err != nil {
+		return sdkdiag.AppendErrorf(diags, "describing SageMaker AI Image Version %s after creation: %s", name, err)
+	}
+
+	// Set the ID to be a combination of name and version
+	versionNumber := aws.ToInt32(output.Version)
+	id := fmt.Sprintf("%s:%d", name, versionNumber)
+	d.SetId(id)
 
-	if _, err := waitImageVersionCreated(ctx, conn, d.Id()); err != nil {
-		return sdkdiag.AppendErrorf(diags, "waiting for SageMaker AI Image Version (%s) to be created: %s", d.Id(), err)
+	// Wait for the image version to be created
+	if _, err := waitImageVersionCreated(ctx, conn, id); err != nil {
+		return sdkdiag.AppendErrorf(diags, "waiting for SageMaker AI Image Version (%s) to be created: %s", id, err)
 	}
 
 	return append(diags, resourceImageVersionRead(ctx, d, meta)...)
@@ -157,24 +172,46 @@ func resourceImageVersionRead(ctx context.Context, d *schema.ResourceData, meta
 	var diags diag.Diagnostics
 	conn := meta.(*conns.AWSClient).SageMakerClient(ctx)
 
-	image, err := findImageVersionByName(ctx, conn, d.Id())
+	id := d.Id()
+	var image *sagemaker.DescribeImageVersionOutput
+	var err error
+
+	// Check if the ID contains a version (has a colon)
+	if strings.Contains(id, ":") {
+		// New format - use the new function
+		image, err = findImageVersionByNameAndVersion(ctx, conn, id)
+	} else {
+		// Legacy format - just the name
+		image, err = findImageVersionByName(ctx, conn, id)
+
+		// If successful, update the ID to the new format
+		if err == nil && image != nil {
+			newID := fmt.Sprintf("%s:%d", id, aws.ToInt32(image.Version))
+			d.SetId(newID)
+			id = newID
+		}
+	}
 
 	if !d.IsNewResource() && tfresource.NotFound(err) {
 		d.SetId("")
-		log.Printf("[WARN] Unable to find SageMaker AI Image Version (%s); removing from state", d.Id())
+		log.Printf("[WARN] Unable to find SageMaker AI Image Version (%s); removing from state", id)
 		return diags
 	}
 
 	if err != nil {
-		return sdkdiag.AppendErrorf(diags, "reading SageMaker AI Image Version (%s): %s", d.Id(), err)
+		return sdkdiag.AppendErrorf(diags, "reading SageMaker AI Image Version (%s): %s", id, err)
 	}
 
+	// Parse the ID to get the name
+	parts := strings.Split(id, ":")
+	name := parts[0]
+
 	d.Set(names.AttrARN, image.ImageVersionArn)
 	d.Set("base_image", image.BaseImage)
 	d.Set("image_arn", image.ImageArn)
 	d.Set("container_image", image.ContainerImage)
 	d.Set(names.AttrVersion, image.Version)
-	d.Set("image_name", d.Id())
+	d.Set("image_name", name)
 	d.Set("horovod", image.Horovod)
 	d.Set("job_type", image.JobType)
 	d.Set("processor", image.Processor)
@@ -190,9 +227,23 @@ func resourceImageVersionUpdate(ctx context.Context, d *schema.ResourceData, met
 	var diags diag.Diagnostics
 	conn := meta.(*conns.AWSClient).SageMakerClient(ctx)
 
+	// Parse the ID to get name and version
+	parts := strings.Split(d.Id(), ":")
+	if len(parts) != 2 {
+		return sdkdiag.AppendErrorf(diags, "invalid resource ID format: %s", d.Id())
+	}
+
+	name := parts[0]
+	versionStr := parts[1]
+
+	version, err := strconv.Atoi(versionStr)
+	if err != nil {
+		return sdkdiag.AppendErrorf(diags, "invalid version number in resource ID: %s", d.Id())
+	}
+
 	input := &sagemaker.UpdateImageVersionInput{
-		ImageName: aws.String(d.Id()),
-		Version:   aws.Int32(int32(d.Get(names.AttrVersion).(int))),
+		ImageName: aws.String(name),
+		Version:   aws.Int32(int32(version)),
 	}
 
 	if d.HasChange("horovod") {
@@ -234,9 +285,23 @@ func resourceImageVersionDelete(ctx context.Context, d *schema.ResourceData, met
 	var diags diag.Diagnostics
 	conn := meta.(*conns.AWSClient).SageMakerClient(ctx)
 
+	// Parse the ID to get name and version
+	parts := strings.Split(d.Id(), ":")
+	if len(parts) != 2 {
+		return sdkdiag.AppendErrorf(diags, "invalid resource ID format: %s", d.Id())
+	}
+
+	name := parts[0]
+	versionStr := parts[1]
+
+	version, err := strconv.Atoi(versionStr)
+	if err != nil {
+		return sdkdiag.AppendErrorf(diags, "invalid version number in resource ID: %s", d.Id())
+	}
+
 	input := &sagemaker.DeleteImageVersionInput{
-		ImageName: aws.String(d.Id()),
-		Version:   aws.Int32(int32(d.Get(names.AttrVersion).(int))),
+		ImageName: aws.String(name),
+		Version:   aws.Int32(int32(version)),
 	}
 
 	if _, err := conn.DeleteImageVersion(ctx, input); err != nil {
@@ -253,6 +318,47 @@ func resourceImageVersionDelete(ctx context.Context, d *schema.ResourceData, met
 	return diags
 }
 
+func findImageVersionByNameAndVersion(ctx context.Context, conn *sagemaker.Client, id string) (*sagemaker.DescribeImageVersionOutput, error) {
+	// Parse the ID to get name and version
+	parts := strings.Split(id, ":")
+	if len(parts) != 2 {
+		return nil, fmt.Errorf("invalid resource ID format: %s", id)
+	}
+
+	name := parts[0]
+	versionStr := parts[1]
+
+	version, err := strconv.Atoi(versionStr)
+	if err != nil {
+		return nil, fmt.Errorf("invalid version number in resource ID: %s", id)
+	}
+
+	input := &sagemaker.DescribeImageVersionInput{
+		ImageName: aws.String(name),
+		Version:   aws.Int32(int32(version)),
+	}
+
+	output, err := conn.DescribeImageVersion(ctx, input)
+
+	if errs.IsAErrorMessageContains[*awstypes.ResourceNotFound](err, "does not exist") {
+		return nil, &retry.NotFoundError{
+			LastError:   err,
+			LastRequest: input,
+		}
+	}
+
+	if err != nil {
+		return nil, err
+	}
+
+	if output == nil {
+		return nil, tfresource.NewEmptyResultError(input)
+	}
+
+	return output, nil
+}
+
+// Keep this for backward compatibility
 func findImageVersionByName(ctx context.Context, conn *sagemaker.Client, name string) (*sagemaker.DescribeImageVersionOutput, error) {
 	input := &sagemaker.DescribeImageVersionInput{
 		ImageName: aws.String(name),
@@ -277,3 +383,8 @@ func findImageVersionByName(ctx context.Context, conn *sagemaker.Client, name st
 
 	return output, nil
 }
+
+// FindImageVersionByNameAndVersion finds a SageMaker Image Version by name and version
+func FindImageVersionByNameAndVersion(ctx context.Context, conn *sagemaker.Client, id string) (*sagemaker.DescribeImageVersionOutput, error) {
+	return findImageVersionByNameAndVersion(ctx, conn, id)
+}

internal/service/sagemaker/image_version_test.go

@@ -191,7 +191,7 @@ func testAccCheckImageVersionDestroy(ctx context.Context) resource.TestCheckFunc
 				continue
 			}
 
-			_, err := tfsagemaker.FindImageVersionByName(ctx, conn, rs.Primary.ID)
+			_, err := tfsagemaker.FindImageVersionByNameAndVersion(ctx, conn, rs.Primary.ID)
 
 			if tfresource.NotFound(err) {
 				continue
@@ -220,7 +220,7 @@ func testAccCheckImageVersionExists(ctx context.Context, n string, image *sagema
 		}
 
 		conn := acctest.Provider.Meta().(*conns.AWSClient).SageMakerClient(ctx)
-		resp, err := tfsagemaker.FindImageVersionByName(ctx, conn, rs.Primary.ID)
+		resp, err := tfsagemaker.FindImageVersionByNameAndVersion(ctx, conn, rs.Primary.ID)
 		if err != nil {
 			return err
 		}

internal/service/sagemaker/status.go

@@ -5,6 +5,7 @@ package sagemaker
 
 import (
 	"context"
+	"strings"
 
 	"github.com/aws/aws-sdk-go-v2/service/sagemaker"
 	awstypes "github.com/aws/aws-sdk-go-v2/service/sagemaker/types"
@@ -60,9 +61,19 @@ func statusImage(ctx context.Context, conn *sagemaker.Client, name string) retry
 	}
 }
 
-func statusImageVersion(ctx context.Context, conn *sagemaker.Client, name string) retry.StateRefreshFunc {
+func statusImageVersion(ctx context.Context, conn *sagemaker.Client, id string) retry.StateRefreshFunc {
 	return func() (any, string, error) {
-		output, err := findImageVersionByName(ctx, conn, name)
+		// Check if the ID contains a version (has a colon)
+		var output *sagemaker.DescribeImageVersionOutput
+		var err error
+
+		if strings.Contains(id, ":") {
+			// New format - use the new function
+			output, err = findImageVersionByNameAndVersion(ctx, conn, id)
+		} else {
+			// Legacy format - just the name
+			output, err = findImageVersionByName(ctx, conn, id)
+		}
 
 		if tfresource.NotFound(err) {
 			return nil, "", nil

internal/service/sagemaker/wait.go

@@ -213,11 +213,11 @@ func waitImageDeleted(ctx context.Context, conn *sagemaker.Client, name string)
 	return err
 }
 
-func waitImageVersionCreated(ctx context.Context, conn *sagemaker.Client, name string) (*sagemaker.DescribeImageVersionOutput, error) {
+func waitImageVersionCreated(ctx context.Context, conn *sagemaker.Client, id string) (*sagemaker.DescribeImageVersionOutput, error) {
 	stateConf := &retry.StateChangeConf{
 		Pending: enum.Slice(awstypes.ImageVersionStatusCreating),
 		Target:  enum.Slice(awstypes.ImageVersionStatusCreated),
-		Refresh: statusImageVersion(ctx, conn, name),
+		Refresh: statusImageVersion(ctx, conn, id),
 		Timeout: imageVersionCreatedTimeout,
 	}
 
@@ -234,11 +234,11 @@ func waitImageVersionCreated(ctx context.Context, conn *sagemaker.Client, name s
 	return nil, err
 }
 
-func waitImageVersionDeleted(ctx context.Context, conn *sagemaker.Client, name string) (*sagemaker.DescribeImageVersionOutput, error) {
+func waitImageVersionDeleted(ctx context.Context, conn *sagemaker.Client, id string) (*sagemaker.DescribeImageVersionOutput, error) {
 	stateConf := &retry.StateChangeConf{
 		Pending: enum.Slice(awstypes.ImageVersionStatusDeleting),
 		Target:  []string{},
-		Refresh: statusImageVersion(ctx, conn, name),
+		Refresh: statusImageVersion(ctx, conn, id),
 		Timeout: imageVersionDeletedTimeout,
 	}
 

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

@@ -52,14 +52,14 @@ This resource supports the following arguments:
 
 This resource exports the following attributes in addition to the arguments above:
 
-* `id` - The name of the Image.
+* `id` - The image name and version in the format `name:version`.
 * `arn` - The Amazon Resource Name (ARN) assigned by AWS to this Image Version.
 * `version`- The version of the image. If not specified, the latest version is described.
 * `container_image` - The registry path of the container image that contains this image version.
 
 ## Import
 
-In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SageMaker AI Image Versions using the `name`. For example:
+In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SageMaker AI Image Versions using the `name:version` format. For example:
 
 ```python
 # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
@@ -73,13 +73,15 @@ from imports.aws.sagemaker_image_version import SagemakerImageVersion
 class MyConvertedCode(TerraformStack):
     def __init__(self, scope, name):
         super().__init__(scope, name)
-        SagemakerImageVersion.generate_config_for_import(self, "testImage", "my-code-repo")
+        SagemakerImageVersion.generate_config_for_import(self, "testImage", "my-image:1")
 ```
 
-Using `terraform import`, import SageMaker AI Image Versions using the `name`. For example:
+Using `terraform import`, import SageMaker AI Image Versions using the `name:version` format. For example:
 
 ```console
-% terraform import aws_sagemaker_image_version.test_image my-code-repo
+% terraform import aws_sagemaker_image_version.test_image my-image:1
 ```
 
-<!-- cache-key: cdktf-0.20.8 input-2b65cb576f99597961832b17ffc716ded699a4a561e60f3d09bc1a312c687a14 -->
+For backward compatibility, importing using just the image name is still supported, but the resource ID will be automatically updated to the `name:version` format after import.
+
+<!-- cache-key: cdktf-0.20.8 input-2b65cb576f99597961832b17ffc716ded699a4a561e60f3d09bc1a312c687a14 -->

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

@@ -55,14 +55,14 @@ This resource supports the following arguments:
 
 This resource exports the following attributes in addition to the arguments above:
 
-* `id` - The name of the Image.
+* `id` - The image name and version in the format `name:version`.
 * `arn` - The Amazon Resource Name (ARN) assigned by AWS to this Image Version.
 * `version`- The version of the image. If not specified, the latest version is described.
 * `containerImage` - The registry path of the container image that contains this image version.
 
 ## Import
 
-In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SageMaker AI Image Versions using the `name`. For example:
+In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SageMaker AI Image Versions using the `name:version` format. For example:
 
 ```typescript
 // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
@@ -79,17 +79,19 @@ class MyConvertedCode extends TerraformStack {
     SagemakerImageVersion.generateConfigForImport(
       this,
       "testImage",
-      "my-code-repo"
+      "my-image:1"
     );
   }
 }
 
 ```
 
-Using `terraform import`, import SageMaker AI Image Versions using the `name`. For example:
+Using `terraform import`, import SageMaker AI Image Versions using the `name:version` format. For example:
 
 ```console
-% terraform import aws_sagemaker_image_version.test_image my-code-repo
+% terraform import aws_sagemaker_image_version.test_image my-image:1
 ```
 
-<!-- cache-key: cdktf-0.20.8 input-2b65cb576f99597961832b17ffc716ded699a4a561e60f3d09bc1a312c687a14 -->
+For backward compatibility, importing using just the image name is still supported, but the resource ID will be automatically updated to the `name:version` format after import.
+
+<!-- cache-key: cdktf-0.20.8 input-2b65cb576f99597961832b17ffc716ded699a4a561e60f3d09bc1a312c687a14 -->

website/docs/r/sagemaker_image_version.html.markdown

@@ -39,24 +39,26 @@ This resource supports the following arguments:
 
 This resource exports the following attributes in addition to the arguments above:
 
-* `id` - The name of the Image.
+* `id` - The image name and version in the format `name:version`.
 * `arn` - The Amazon Resource Name (ARN) assigned by AWS to this Image Version.
 * `version`- The version of the image. If not specified, the latest version is described.
 * `container_image` - The registry path of the container image that contains this image version.
 
 ## Import
 
-In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SageMaker AI Image Versions using the `name`. For example:
+In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SageMaker AI Image Versions using the `name:version` format. For example:
 
 ```terraform
 import {
   to = aws_sagemaker_image_version.test_image
-  id = "my-code-repo"
+  id = "my-image:1"
 }
 ```
 
-Using `terraform import`, import SageMaker AI Image Versions using the `name`. For example:
+Using `terraform import`, import SageMaker AI Image Versions using the `name:version` format. For example:
 
 ```console
-% terraform import aws_sagemaker_image_version.test_image my-code-repo
+% terraform import aws_sagemaker_image_version.test_image my-image:1
 ```
+
+For backward compatibility, importing using just the image name is still supported, but the resource ID will be automatically updated to the `name:version` format after import.