feat: Add workspace_name field in stream_connection resource and datasource

.changelog/3610.txt

@@ -0,0 +1,11 @@
+```release-note:note
+resource/mongodbatlas_stream_connection: Deprecates the `instance_name` attribute. All configurations using `instance_name` should be updated to use the new `workspace_name` attribute instead
+
+```
+```release-note:note
+data-source/mongodbatlas_stream_connection: Deprecates the `instance_name` attribute. All configurations using `instance_name` should be updated to use the new `workspace_name` attribute instead
+```
+
+```release-note:note
+data-source/mongodbatlas_stream_connections: Deprecates the `instance_name` attribute. All configurations using `instance_name` should be updated to use the new `workspace_name` attribute instead
+```

docs/data-sources/stream_connection.md

@@ -11,17 +11,30 @@ subcategory: "Streams"
 ```terraform
 data "mongodbatlas_stream_connection" "example" {
     project_id = "<PROJECT_ID>"
-    instance_name = "<INSTANCE_NAME>"
+    workspace_name = "<WORKSPACE_NAME>"
+    connection_name = "<CONNECTION_NAME>"
+}
+```
+
+### Example using workspace_name
+
+```terraform
+data "mongodbatlas_stream_connection" "example" {
+    project_id = "<PROJECT_ID>"
+    workspace_name = "<WORKSPACE_NAME>"
     connection_name = "<CONNECTION_NAME>"
 }
 ```
 
 ## Argument Reference
 
 * `project_id` - (Required) Unique 24-hexadecimal digit string that identifies your project.
-* `instance_name` - (Required) Human-readable label that identifies the stream instance.
+* `instance_name` - (Deprecated) Human-readable label that identifies the stream instance. Attribute is deprecated and will be removed in following major versions in favor of `workspace_name`.
+* `workspace_name` - (Optional) Human-readable label that identifies the stream instance. Conflicts with `workspace_name`.
 * `connection_name` - (Required) Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
 
+~> **NOTE:** Either `workspace_name` or `instance_name` must be provided, but not both. These fields are functionally identical and `workspace_name` is an alias for `instance_name`. `workspace_name` should be used instead of `instance_name`.
+
 ## Attributes Reference
 
 * `type` - Type of connection. Can be `AWSLambda`, `Cluster`, `Https`, `Kafka` or `Sample`.

docs/data-sources/stream_connections.md

@@ -11,14 +11,17 @@ subcategory: "Streams"
 ```terraform
 data "mongodbatlas_stream_connections" "test" {
     project_id = "<PROJECT_ID>"
-    instance_name = "<INSTANCE_NAME>"
+    workspace_name = "<WORKSPACE_NAME>"
 }
 ```
 
 ## Argument Reference
 
 * `project_id` - (Required) Unique 24-hexadecimal digit string that identifies your project.
-* `instance_name` - (Required) Human-readable label that identifies the stream instance.
+* `instance_name` - (Deprecated) Human-readable label that identifies the stream instance. Attribute is deprecated and will be removed in following major versions in favor of `workspace_name`.
+* `workspace_name` - (Optional) Human-readable label that identifies the stream instance. Conflicts with `instance_name`.
+
+~> **NOTE:** Either `workspace_name` or `instance_name` must be provided, but not both. These fields are functionally identical and `workspace_name` is an alias for `instance_name`. `workspace_name` should be used instead of `instance_name`.
 
 * `page_num` - (Optional) Number of the page that displays the current set of the total objects that the response returns. Defaults to `1`.
 * `items_per_page` - (Optional) Number of items that the response returns per page, up to a maximum of `500`. Defaults to `100`.
@@ -34,7 +37,7 @@ In addition to all arguments above, it also exports the following attributes:
 ### Stream Connection
 
 * `project_id` - Unique 24-hexadecimal digit string that identifies your project.
-* `instance_name` - Human-readable label that identifies the stream instance.
+* `workspace_name` - Human-readable label that identifies the stream instance.
 * `connection_name` - Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
 * `type` - Type of connection. `AWSLambda`, `Cluster`, `Https`, `Kafka` or `Sample`.
 

docs/resources/stream_connection.md

@@ -16,7 +16,7 @@ subcategory: "Streams"
 ```terraform
 resource "mongodbatlas_stream_connection" "test" {
     project_id = var.project_id
-    instance_name = "InstanceName"
+    workspace_name = "WorkspaceName"
     connection_name = "ConnectionName"
     type = "Cluster"
     cluster_name = "Cluster0"
@@ -31,7 +31,7 @@ resource "mongodbatlas_stream_connection" "test" {
 ```terraform
 resource "mongodbatlas_stream_connection" "test" {
     project_id         = var.project_id
-    instance_name      = "InstanceName"
+    workspace_name      = "WorskpaceName"
     connection_name    = "ConnectionName"
     type               = "Cluster"
     cluster_name       = "OtherCluster"
@@ -44,7 +44,7 @@ resource "mongodbatlas_stream_connection" "test" {
 ```terraform
 resource "mongodbatlas_stream_connection" "test" {
     project_id = var.project_id
-    instance_name = "NewInstance"
+    workspace_name = "NewWorkspace"
     connection_name = "KafkaConnection"
     type = "Kafka"
     authentication = {
@@ -67,7 +67,7 @@ resource "mongodbatlas_stream_connection" "test" {
 ```terraform
 resource "mongodbatlas_stream_connection" "test" {
     project_id = var.project_id
-    instance_name = "NewInstance"
+    workspace_name = "NewWorkspace"
     connection_name = "KafkaConnection"
     type = "Kafka"
     authentication = {
@@ -91,7 +91,7 @@ resource "mongodbatlas_stream_connection" "test" {
 ```terraform
 resource "mongodbatlas_stream_connection" "test" {
     project_id      = var.project_id
-    instance_name   = "NewInstance"
+    workspace_name   = "NewWorkspace"
     connection_name = "AWSLambdaConnection"
     type            = "AWSLambda"
     aws             = {
@@ -106,7 +106,7 @@ resource "mongodbatlas_stream_connection" "test" {
 ```terraform
 resource "mongodbatlas_stream_connection" "example-https" {
   project_id      = var.project_id
-  instance_name   = mongodbatlas_stream_instance.example.instance_name
+  workspace_name   = mongodbatlas_stream_instance.example.instance_name
   connection_name = "https_connection_tf_new"
   type            = "Https"
   url             = "https://example.com"
@@ -120,10 +120,13 @@ resource "mongodbatlas_stream_connection" "example-https" {
 ## Argument Reference
 
 * `project_id` - (Required) Unique 24-hexadecimal digit string that identifies your project.
-* `instance_name` - (Required) Human-readable label that identifies the stream instance.
+* `instance_name` - (Deprecated) Human-readable label that identifies the stream instance. Attribute is deprecated and will be removed in following major versions in favor of `workspace_name`.
+* `workspace_name` - (Optional) Human-readable label that identifies the stream instance. Conflicts with `instance_name`.
 * `connection_name` - (Required) Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
 * `type` - (Required) Type of connection. Can be `AWSLambda`, `Cluster`, `Https`, `Kafka` or `Sample`.
 
+~> **NOTE:** Either `workspace_name` or `instance_name` must be provided, but not both. These fields are functionally identical and `workspace_name` is an alias for `instance_name`. `workspace_name` should be used instead of `instance_name`.
+
 If `type` is of value `Cluster` the following additional arguments are defined:
 * `cluster_name` - Name of the cluster configured for this connection.
 * `db_role_to_execute` - The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See [DBRoleToExecute](#DBRoleToExecute).
@@ -171,7 +174,7 @@ If `type` is of value `Https` the following additional attributes are defined:
 
 ## Import
 
-You can import a stream connection resource using the instance name, project ID, and connection name. The format must be `INSTANCE_NAME-PROJECT_ID-CONNECTION_NAME`. For example:
+You can import a stream connection resource using the workspace name, project ID, and connection name. The format must be `WORKSPACE_NAME-PROJECT_ID-CONNECTION_NAME`. For example:
 
 ```
 $ terraform import mongodbatlas_stream_connection.test "DefaultInstance-12251446ae5f3f6ec7968b13-NewConnection"

examples/mongodbatlas_stream_connection/main.tf

@@ -9,7 +9,7 @@ resource "mongodbatlas_stream_instance" "example" {
 
 resource "mongodbatlas_stream_connection" "example-cluster" {
   project_id      = var.project_id
-  instance_name   = mongodbatlas_stream_instance.example.instance_name
+  workspace_name  = mongodbatlas_stream_instance.example.instance_name
   connection_name = "ClusterConnection"
   type            = "Cluster"
   cluster_name    = var.cluster_name
@@ -21,7 +21,7 @@ resource "mongodbatlas_stream_connection" "example-cluster" {
 
 resource "mongodbatlas_stream_connection" "example-cross-project-cluster" {
   project_id         = var.project_id
-  instance_name      = mongodbatlas_stream_instance.example.instance_name
+  workspace_name     = mongodbatlas_stream_instance.example.instance_name
   connection_name    = "ClusterCrossProjectConnection"
   type               = "Cluster"
   cluster_name       = var.other_cluster
@@ -34,7 +34,7 @@ resource "mongodbatlas_stream_connection" "example-cross-project-cluster" {
 
 resource "mongodbatlas_stream_connection" "example-kafka-plaintext" {
   project_id      = var.project_id
-  instance_name   = mongodbatlas_stream_instance.example.instance_name
+  workspace_name  = mongodbatlas_stream_instance.example.instance_name
   connection_name = "KafkaPlaintextConnection"
   type            = "Kafka"
   authentication = {
@@ -58,7 +58,7 @@ resource "mongodbatlas_stream_connection" "example-kafka-plaintext" {
 
 resource "mongodbatlas_stream_connection" "example-kafka-ssl" {
   project_id      = var.project_id
-  instance_name   = mongodbatlas_stream_instance.example.instance_name
+  workspace_name  = mongodbatlas_stream_instance.example.instance_name
   connection_name = "KafkaSSLConnection"
   type            = "Kafka"
   authentication = {
@@ -78,14 +78,14 @@ resource "mongodbatlas_stream_connection" "example-kafka-ssl" {
 
 resource "mongodbatlas_stream_connection" "example-sample" {
   project_id      = var.project_id
-  instance_name   = mongodbatlas_stream_instance.example.instance_name
+  workspace_name  = mongodbatlas_stream_instance.example.instance_name
   connection_name = "sample_stream_solar"
   type            = "Sample"
 }
 
 resource "mongodbatlas_stream_connection" "example-aws-lambda" {
   project_id      = var.project_id
-  instance_name   = mongodbatlas_stream_instance.example.instance_name
+  workspace_name  = mongodbatlas_stream_instance.example.instance_name
   connection_name = "AWSLambdaConnection"
   type            = "AWSLambda"
   aws = {
@@ -107,7 +107,7 @@ resource "mongodbatlas_stream_connection" "example-https" {
 
 data "mongodbatlas_stream_connection" "example-kafka-ssl" {
   project_id      = var.project_id
-  instance_name   = mongodbatlas_stream_instance.example.instance_name
+  workspace_name  = mongodbatlas_stream_instance.example.instance_name
   connection_name = mongodbatlas_stream_connection.example-kafka-ssl.connection_name
 }
 

internal/service/streamconnection/data_source_stream_connection.go

@@ -2,8 +2,14 @@ package streamconnection
 
 import (
 	"context"
+	"fmt"
 
+	"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
+	dsschema "github.com/hashicorp/terraform-plugin-framework/datasource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/path"
+	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
+	"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/constant"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/conversion"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/config"
 )
@@ -25,7 +31,24 @@ type streamConnectionDS struct {
 
 func (d *streamConnectionDS) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {
 	resp.Schema = conversion.DataSourceSchemaFromResource(ResourceSchema(ctx), &conversion.DataSourceSchemaRequest{
-		RequiredFields: []string{"project_id", "instance_name", "connection_name"},
+		RequiredFields: []string{"project_id", "connection_name"},
+		OverridenFields: map[string]dsschema.Attribute{
+			"instance_name": dsschema.StringAttribute{
+				Optional:            true,
+				MarkdownDescription: "Human-readable label that identifies the stream instance. Conflicts with `workspace_name`.",
+				DeprecationMessage:  fmt.Sprintf(constant.DeprecationParamWithReplacement, "workspace_name"),
+				Validators: []validator.String{
+					stringvalidator.ConflictsWith(path.MatchRoot("workspace_name")),
+				},
+			},
+			"workspace_name": dsschema.StringAttribute{
+				Optional:            true,
+				MarkdownDescription: "Human-readable label that identifies the stream instance. This is an alias for `instance_name`. Conflicts with `instance_name`.",
+				Validators: []validator.String{
+					stringvalidator.ConflictsWith(path.MatchRoot("instance_name")),
+				},
+			},
+		},
 	})
 }
 
@@ -38,15 +61,21 @@ func (d *streamConnectionDS) Read(ctx context.Context, req datasource.ReadReques
 
 	connV2 := d.Client.AtlasV2
 	projectID := streamConnectionConfig.ProjectID.ValueString()
-	instanceName := streamConnectionConfig.InstanceName.ValueString()
+	workspaceOrInstanceName := getWorkspaceOrInstanceName(&streamConnectionConfig)
+	if workspaceOrInstanceName == "" {
+		resp.Diagnostics.AddError("validation error", "workspace_name must be provided")
+		return
+	}
 	connectionName := streamConnectionConfig.ConnectionName.ValueString()
-	apiResp, _, err := connV2.StreamsApi.GetStreamConnection(ctx, projectID, instanceName, connectionName).Execute()
+	apiResp, _, err := connV2.StreamsApi.GetStreamConnection(ctx, projectID, workspaceOrInstanceName, connectionName).Execute()
 	if err != nil {
 		resp.Diagnostics.AddError("error fetching resource", err.Error())
 		return
 	}
 
-	newStreamConnectionModel, diags := NewTFStreamConnection(ctx, projectID, instanceName, nil, apiResp)
+	instanceName := streamConnectionConfig.InstanceName.ValueString()
+	workspaceName := streamConnectionConfig.WorkspaceName.ValueString()
+	newStreamConnectionModel, diags := NewTFStreamConnection(ctx, projectID, instanceName, workspaceName, nil, apiResp)
 	if diags.HasError() {
 		resp.Diagnostics.Append(diags...)
 		return

internal/service/streamconnection/data_source_stream_connections.go

@@ -4,8 +4,13 @@ import (
 	"context"
 	"fmt"
 
+	"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
+	dsschema "github.com/hashicorp/terraform-plugin-framework/datasource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/path"
+	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/constant"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/conversion"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/config"
 	"go.mongodb.org/atlas-sdk/v20250312007/admin"
@@ -28,11 +33,39 @@ type streamConnectionsDS struct {
 
 func (d *streamConnectionsDS) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {
 	resp.Schema = conversion.PluralDataSourceSchemaFromResource(ResourceSchema(ctx), &conversion.PluralDataSourceSchemaRequest{
-		RequiredFields:  []string{"project_id", "instance_name"},
+		RequiredFields:  []string{"project_id"},
 		HasLegacyFields: true,
+		OverridenRootFields: map[string]dsschema.Attribute{
+			"instance_name": dsschema.StringAttribute{
+				Optional:            true,
+				MarkdownDescription: "Human-readable label that identifies the stream instance. Conflicts with `workspace_name`.",
+				DeprecationMessage:  fmt.Sprintf(constant.DeprecationParamWithReplacement, "workspace_name"),
+				Validators: []validator.String{
+					stringvalidator.ConflictsWith(path.MatchRoot("workspace_name")),
+				},
+			},
+			"workspace_name": dsschema.StringAttribute{
+				Optional:            true,
+				MarkdownDescription: "Human-readable label that identifies the stream instance. This is an alias for `instance_name`. Conflicts with `instance_name`.",
+				Validators: []validator.String{
+					stringvalidator.ConflictsWith(path.MatchRoot("instance_name")),
+				},
+			},
+		},
 	})
 }
 
+// getWorkspaceOrInstanceNameForDS returns the workspace name from either instance_name or workspace_name field for datasource model
+func getWorkspaceOrInstanceNameForDS(model *TFStreamConnectionsDSModel) string {
+	if !model.WorkspaceName.IsNull() && !model.WorkspaceName.IsUnknown() {
+		return model.WorkspaceName.ValueString()
+	}
+	if !model.InstanceName.IsNull() && !model.InstanceName.IsUnknown() {
+		return model.InstanceName.ValueString()
+	}
+	return ""
+}
+
 func (d *streamConnectionsDS) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
 	var streamConnectionsConfig TFStreamConnectionsDSModel
 	resp.Diagnostics.Append(req.Config.Get(ctx, &streamConnectionsConfig)...)
@@ -42,13 +75,17 @@ func (d *streamConnectionsDS) Read(ctx context.Context, req datasource.ReadReque
 
 	connV2 := d.Client.AtlasV2
 	projectID := streamConnectionsConfig.ProjectID.ValueString()
-	instanceName := streamConnectionsConfig.InstanceName.ValueString()
+	workspaceOrInstanceName := getWorkspaceOrInstanceNameForDS(&streamConnectionsConfig)
+	if workspaceOrInstanceName == "" {
+		resp.Diagnostics.AddError("validation error", "workspace_name must be provided")
+		return
+	}
 	itemsPerPage := streamConnectionsConfig.ItemsPerPage.ValueInt64Pointer()
 	pageNum := streamConnectionsConfig.PageNum.ValueInt64Pointer()
 
 	apiResp, _, err := connV2.StreamsApi.ListStreamConnectionsWithParams(ctx, &admin.ListStreamConnectionsApiParams{
 		GroupId:      projectID,
-		TenantName:   instanceName,
+		TenantName:   workspaceOrInstanceName,
 		ItemsPerPage: conversion.Int64PtrToIntPtr(itemsPerPage),
 		PageNum:      conversion.Int64PtrToIntPtr(pageNum),
 	}).Execute()
@@ -67,11 +104,12 @@ func (d *streamConnectionsDS) Read(ctx context.Context, req datasource.ReadReque
 }
 
 type TFStreamConnectionsDSModel struct {
-	ID           types.String              `tfsdk:"id"`
-	ProjectID    types.String              `tfsdk:"project_id"`
-	InstanceName types.String              `tfsdk:"instance_name"`
-	Results      []TFStreamConnectionModel `tfsdk:"results"`
-	PageNum      types.Int64               `tfsdk:"page_num"`
-	ItemsPerPage types.Int64               `tfsdk:"items_per_page"`
-	TotalCount   types.Int64               `tfsdk:"total_count"`
+	ID            types.String              `tfsdk:"id"`
+	ProjectID     types.String              `tfsdk:"project_id"`
+	InstanceName  types.String              `tfsdk:"instance_name"`
+	WorkspaceName types.String              `tfsdk:"workspace_name"`
+	Results       []TFStreamConnectionModel `tfsdk:"results"`
+	PageNum       types.Int64               `tfsdk:"page_num"`
+	ItemsPerPage  types.Int64               `tfsdk:"items_per_page"`
+	TotalCount    types.Int64               `tfsdk:"total_count"`
 }