feat: Add workspace_name field in stream_connection resource and datasource

kpatel71716 · kpatel71716 · commit 6777bf6385dd · 2025-08-21T14:57:49.000-05:00
Signed-off-by: Kush Patel &lt;kush.patel@mongodb.com&gt;
diff --git a/docs/data-sources/stream_connection.md b/docs/data-sources/stream_connection.md
@@ -12,12 +12,25 @@ data "mongodbatlas_stream_connection" "example" {
 }
 ```
 
+### 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` - (Optional) Human-readable label that identifies the stream instance. Conflicts with `workspace_name`.
+* `workspace_name` - (Optional) Human-readable label that identifies the stream instance. This is an alias for `instance_name`. 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.
 
+~> **NOTE:** Either `instance_name` or `workspace_name` must be provided, but not both. These fields are functionally identical and `workspace_name` is provided as an alias for `instance_name`.
+
 ## Attributes Reference
 
 * `type` - Type of connection. Can be `AWSLambda`, `Cluster`, `Https`, `Kafka` or `Sample`.
diff --git a/docs/data-sources/stream_connections.md b/docs/data-sources/stream_connections.md
@@ -14,7 +14,10 @@ data "mongodbatlas_stream_connections" "test" {
 ## 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` - (Optional) Human-readable label that identifies the stream instance. Conflicts with `workspace_name`.
+* `workspace_name` - (Optional) Human-readable label that identifies the stream instance. This is an alias for `instance_name`. Conflicts with `instance_name`.
+
+~> **NOTE:** Either `instance_name` or `workspace_name` must be provided, but not both. These fields are functionally identical and `workspace_name` is provided as an alias for `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`.
diff --git a/docs/resources/stream_connection.md b/docs/resources/stream_connection.md
@@ -19,6 +19,18 @@ resource "mongodbatlas_stream_connection" "test" {
 }
 ```
 
+### Example Cluster Connection using workspace_name
+
+```terraform
+resource "mongodbatlas_stream_connection" "test" {
+    project_id = var.project_id
+    workspace_name = "WorkspaceName"
+    connection_name = "ConnectionName"
+    type = "Cluster"
+    cluster_name = "Cluster0"
+}
+```
+
 ### Example Cross Project Cluster Connection
 
 ```terraform
@@ -113,10 +125,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` - (Optional) Human-readable label that identifies the stream instance. Conflicts with `workspace_name`.
+* `workspace_name` - (Optional) Human-readable label that identifies the stream instance. This is an alias for `instance_name`. 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 `instance_name` or `workspace_name` must be provided, but not both. These fields are functionally identical and `workspace_name` is provided as an alias for `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).
diff --git a/internal/service/streamconnection/data_source_stream_connection.go b/internal/service/streamconnection/data_source_stream_connection.go
@@ -25,7 +25,7 @@ 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"},
 	})
 }
 
@@ -38,15 +38,19 @@ func (d *streamConnectionDS) Read(ctx context.Context, req datasource.ReadReques
 
 	connV2 := d.Client.AtlasV2
 	projectID := streamConnectionConfig.ProjectID.ValueString()
-	instanceName := streamConnectionConfig.InstanceName.ValueString()
+	instanceName := getEffectiveInstanceName(&streamConnectionConfig)
+	if instanceName == "" {
+		resp.Diagnostics.AddError("validation error", "either instance_name or workspace_name must be provided")
+		return
+	}
 	connectionName := streamConnectionConfig.ConnectionName.ValueString()
 	apiResp, _, err := connV2.StreamsApi.GetStreamConnection(ctx, projectID, instanceName, connectionName).Execute()
 	if err != nil {
 		resp.Diagnostics.AddError("error fetching resource", err.Error())
 		return
 	}
 
-	newStreamConnectionModel, diags := NewTFStreamConnection(ctx, projectID, instanceName, nil, apiResp)
+	newStreamConnectionModel, diags := NewTFStreamConnectionWithOriginal(ctx, projectID, instanceName, nil, apiResp, &streamConnectionConfig)
 	if diags.HasError() {
 		resp.Diagnostics.Append(diags...)
 		return
diff --git a/internal/service/streamconnection/data_source_stream_connections.go b/internal/service/streamconnection/data_source_stream_connections.go
@@ -28,11 +28,22 @@ 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,
 	})
 }
 
+// getEffectiveInstanceNameForDS returns the instance name from either instance_name or workspace_name field for datasource model
+func getEffectiveInstanceNameForDS(model *TFStreamConnectionsDSModel) string {
+	if !model.InstanceName.IsNull() && !model.InstanceName.IsUnknown() {
+		return model.InstanceName.ValueString()
+	}
+	if !model.WorkspaceName.IsNull() && !model.WorkspaceName.IsUnknown() {
+		return model.WorkspaceName.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,7 +53,11 @@ func (d *streamConnectionsDS) Read(ctx context.Context, req datasource.ReadReque
 
 	connV2 := d.Client.AtlasV2
 	projectID := streamConnectionsConfig.ProjectID.ValueString()
-	instanceName := streamConnectionsConfig.InstanceName.ValueString()
+	instanceName := getEffectiveInstanceNameForDS(&streamConnectionsConfig)
+	if instanceName == "" {
+		resp.Diagnostics.AddError("validation error", "either instance_name or workspace_name must be provided")
+		return
+	}
 	itemsPerPage := streamConnectionsConfig.ItemsPerPage.ValueInt64Pointer()
 	pageNum := streamConnectionsConfig.PageNum.ValueInt64Pointer()
 
@@ -58,7 +73,7 @@ func (d *streamConnectionsDS) Read(ctx context.Context, req datasource.ReadReque
 		return
 	}
 
-	newStreamConnectionsModel, diags := NewTFStreamConnections(ctx, &streamConnectionsConfig, apiResp)
+	newStreamConnectionsModel, diags := NewTFStreamConnectionsWithOriginal(ctx, &streamConnectionsConfig, apiResp)
 	if diags.HasError() {
 		resp.Diagnostics.Append(diags...)
 		return
@@ -67,11 +82,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"`
 }
diff --git a/internal/service/streamconnection/model_stream_connection.go b/internal/service/streamconnection/model_stream_connection.go
@@ -118,11 +118,14 @@ func NewStreamConnectionUpdateReq(ctx context.Context, plan *TFStreamConnectionM
 }
 
 func NewTFStreamConnection(ctx context.Context, projID, instanceName string, currAuthConfig *types.Object, apiResp *admin.StreamsConnection) (*TFStreamConnectionModel, diag.Diagnostics) {
+	return NewTFStreamConnectionWithOriginal(ctx, projID, instanceName, currAuthConfig, apiResp, nil)
+}
+
+func NewTFStreamConnectionWithOriginal(ctx context.Context, projID, instanceName string, currAuthConfig *types.Object, apiResp *admin.StreamsConnection, originalModel *TFStreamConnectionModel) (*TFStreamConnectionModel, diag.Diagnostics) {
 	rID := fmt.Sprintf("%s-%s-%s", instanceName, projID, conversion.SafeString(apiResp.Name))
 	connectionModel := TFStreamConnectionModel{
 		ID:               types.StringValue(rID),
 		ProjectID:        types.StringValue(projID),
-		InstanceName:     types.StringValue(instanceName),
 		ConnectionName:   types.StringPointerValue(apiResp.Name),
 		Type:             types.StringPointerValue(apiResp.Type),
 		ClusterName:      types.StringPointerValue(apiResp.ClusterName),
@@ -131,6 +134,21 @@ func NewTFStreamConnection(ctx context.Context, projID, instanceName string, cur
 		URL:              types.StringPointerValue(apiResp.Url),
 	}
 
+	// Set the appropriate field based on the original model
+	if originalModel != nil {
+		if !originalModel.WorkspaceName.IsNull() && !originalModel.WorkspaceName.IsUnknown() {
+			connectionModel.WorkspaceName = types.StringValue(instanceName)
+			connectionModel.InstanceName = types.StringNull()
+		} else {
+			connectionModel.InstanceName = types.StringValue(instanceName)
+			connectionModel.WorkspaceName = types.StringNull()
+		}
+	} else {
+		// Default to instance_name for backward compatibility
+		connectionModel.InstanceName = types.StringValue(instanceName)
+		connectionModel.WorkspaceName = types.StringNull()
+	}
+
 	authModel, diags := newTFConnectionAuthenticationModel(ctx, currAuthConfig, apiResp.Authentication)
 	if diags.HasError() {
 		return nil, diags
@@ -238,26 +256,42 @@ func newTFConnectionAuthenticationModel(ctx context.Context, currAuthConfig *typ
 }
 
 func NewTFStreamConnections(ctx context.Context,
+	streamConnectionsConfig *TFStreamConnectionsDSModel,
+	paginatedResult *admin.PaginatedApiStreamsConnection) (*TFStreamConnectionsDSModel, diag.Diagnostics) {
+	return NewTFStreamConnectionsWithOriginal(ctx, streamConnectionsConfig, paginatedResult)
+}
+
+func NewTFStreamConnectionsWithOriginal(ctx context.Context,
 	streamConnectionsConfig *TFStreamConnectionsDSModel,
 	paginatedResult *admin.PaginatedApiStreamsConnection) (*TFStreamConnectionsDSModel, diag.Diagnostics) {
 	input := paginatedResult.GetResults()
 	results := make([]TFStreamConnectionModel, len(input))
+
+	// Determine the effective instance name
+	var instanceName string
+	if !streamConnectionsConfig.InstanceName.IsNull() && !streamConnectionsConfig.InstanceName.IsUnknown() {
+		instanceName = streamConnectionsConfig.InstanceName.ValueString()
+	} else if !streamConnectionsConfig.WorkspaceName.IsNull() && !streamConnectionsConfig.WorkspaceName.IsUnknown() {
+		instanceName = streamConnectionsConfig.WorkspaceName.ValueString()
+	}
+
 	for i := range input {
 		projectID := streamConnectionsConfig.ProjectID.ValueString()
-		instanceName := streamConnectionsConfig.InstanceName.ValueString()
 		connectionModel, diags := NewTFStreamConnection(ctx, projectID, instanceName, nil, &input[i])
 		if diags.HasError() {
 			return nil, diags
 		}
 		results[i] = *connectionModel
 	}
+
 	return &TFStreamConnectionsDSModel{
-		ID:           types.StringValue(id.UniqueId()),
-		ProjectID:    streamConnectionsConfig.ProjectID,
-		InstanceName: streamConnectionsConfig.InstanceName,
-		Results:      results,
-		PageNum:      streamConnectionsConfig.PageNum,
-		ItemsPerPage: streamConnectionsConfig.ItemsPerPage,
-		TotalCount:   types.Int64PointerValue(conversion.IntPtrToInt64Ptr(paginatedResult.TotalCount)),
+		ID:            types.StringValue(id.UniqueId()),
+		ProjectID:     streamConnectionsConfig.ProjectID,
+		InstanceName:  streamConnectionsConfig.InstanceName,
+		WorkspaceName: streamConnectionsConfig.WorkspaceName,
+		Results:       results,
+		PageNum:       streamConnectionsConfig.PageNum,
+		ItemsPerPage:  streamConnectionsConfig.ItemsPerPage,
+		TotalCount:    types.Int64PointerValue(conversion.IntPtrToInt64Ptr(paginatedResult.TotalCount)),
 	}, nil
 }
diff --git a/internal/service/streamconnection/resource_schema.go b/internal/service/streamconnection/resource_schema.go
@@ -4,6 +4,7 @@ import (
 	"context"
 
 	"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
+	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/objectplanmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
@@ -28,10 +29,26 @@ func ResourceSchema(ctx context.Context) schema.Schema {
 				},
 			},
 			"instance_name": schema.StringAttribute{
-				Required: true,
+				Optional: true,
 				PlanModifiers: []planmodifier.String{
 					stringplanmodifier.RequiresReplace(),
 				},
+				Validators: []validator.String{
+					stringvalidator.ConflictsWith(path.Expressions{
+						path.MatchRelative().AtParent().AtName("workspace_name"),
+					}...),
+				},
+			},
+			"workspace_name": schema.StringAttribute{
+				Optional: true,
+				PlanModifiers: []planmodifier.String{
+					stringplanmodifier.RequiresReplace(),
+				},
+				Validators: []validator.String{
+					stringvalidator.ConflictsWith(path.Expressions{
+						path.MatchRelative().AtParent().AtName("instance_name"),
+					}...),
+				},
 			},
 			"connection_name": schema.StringAttribute{
 				Required: true,
diff --git a/internal/service/streamconnection/resource_stream_connection.go b/internal/service/streamconnection/resource_stream_connection.go
@@ -37,6 +37,7 @@ type TFStreamConnectionModel struct {
 	ID               types.String `tfsdk:"id"`
 	ProjectID        types.String `tfsdk:"project_id"`
 	InstanceName     types.String `tfsdk:"instance_name"`
+	WorkspaceName    types.String `tfsdk:"workspace_name"`
 	ConnectionName   types.String `tfsdk:"connection_name"`
 	Type             types.String `tfsdk:"type"`
 	ClusterName      types.String `tfsdk:"cluster_name"`
@@ -116,6 +117,17 @@ func (r *streamConnectionRS) Schema(ctx context.Context, req resource.SchemaRequ
 	conversion.UpdateSchemaDescription(&resp.Schema)
 }
 
+// getEffectiveInstanceName returns the instance name from either instance_name or workspace_name field
+func getEffectiveInstanceName(model *TFStreamConnectionModel) string {
+	if !model.InstanceName.IsNull() && !model.InstanceName.IsUnknown() {
+		return model.InstanceName.ValueString()
+	}
+	if !model.WorkspaceName.IsNull() && !model.WorkspaceName.IsUnknown() {
+		return model.WorkspaceName.ValueString()
+	}
+	return ""
+}
+
 func (r *streamConnectionRS) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
 	var streamConnectionPlan TFStreamConnectionModel
 	resp.Diagnostics.Append(req.Plan.Get(ctx, &streamConnectionPlan)...)
@@ -125,7 +137,11 @@ func (r *streamConnectionRS) Create(ctx context.Context, req resource.CreateRequ
 
 	connV2 := r.Client.AtlasV2
 	projectID := streamConnectionPlan.ProjectID.ValueString()
-	instanceName := streamConnectionPlan.InstanceName.ValueString()
+	instanceName := getEffectiveInstanceName(&streamConnectionPlan)
+	if instanceName == "" {
+		resp.Diagnostics.AddError("validation error", "either instance_name or workspace_name must be provided")
+		return
+	}
 	streamConnectionReq, diags := NewStreamConnectionReq(ctx, &streamConnectionPlan)
 	if diags.HasError() {
 		resp.Diagnostics.Append(diags...)
@@ -137,7 +153,7 @@ func (r *streamConnectionRS) Create(ctx context.Context, req resource.CreateRequ
 		return
 	}
 
-	newStreamConnectionModel, diags := NewTFStreamConnection(ctx, projectID, instanceName, &streamConnectionPlan.Authentication, apiResp)
+	newStreamConnectionModel, diags := NewTFStreamConnectionWithOriginal(ctx, projectID, instanceName, &streamConnectionPlan.Authentication, apiResp, &streamConnectionPlan)
 	if diags.HasError() {
 		resp.Diagnostics.Append(diags...)
 		return
@@ -154,7 +170,11 @@ func (r *streamConnectionRS) Read(ctx context.Context, req resource.ReadRequest,
 
 	connV2 := r.Client.AtlasV2
 	projectID := streamConnectionState.ProjectID.ValueString()
-	instanceName := streamConnectionState.InstanceName.ValueString()
+	instanceName := getEffectiveInstanceName(&streamConnectionState)
+	if instanceName == "" {
+		resp.Diagnostics.AddError("validation error", "either instance_name or workspace_name must be provided")
+		return
+	}
 	connectionName := streamConnectionState.ConnectionName.ValueString()
 	apiResp, getResp, err := connV2.StreamsApi.GetStreamConnection(ctx, projectID, instanceName, connectionName).Execute()
 	if err != nil {
@@ -166,7 +186,7 @@ func (r *streamConnectionRS) Read(ctx context.Context, req resource.ReadRequest,
 		return
 	}
 
-	newStreamConnectionModel, diags := NewTFStreamConnection(ctx, projectID, instanceName, &streamConnectionState.Authentication, apiResp)
+	newStreamConnectionModel, diags := NewTFStreamConnectionWithOriginal(ctx, projectID, instanceName, &streamConnectionState.Authentication, apiResp, &streamConnectionState)
 	if diags.HasError() {
 		resp.Diagnostics.Append(diags...)
 		return
@@ -183,7 +203,11 @@ func (r *streamConnectionRS) Update(ctx context.Context, req resource.UpdateRequ
 
 	connV2 := r.Client.AtlasV2
 	projectID := streamConnectionPlan.ProjectID.ValueString()
-	instanceName := streamConnectionPlan.InstanceName.ValueString()
+	instanceName := getEffectiveInstanceName(&streamConnectionPlan)
+	if instanceName == "" {
+		resp.Diagnostics.AddError("validation error", "either instance_name or workspace_name must be provided")
+		return
+	}
 	connectionName := streamConnectionPlan.ConnectionName.ValueString()
 	streamConnectionReq, diags := NewStreamConnectionUpdateReq(ctx, &streamConnectionPlan)
 	if diags.HasError() {
@@ -196,7 +220,7 @@ func (r *streamConnectionRS) Update(ctx context.Context, req resource.UpdateRequ
 		return
 	}
 
-	newStreamConnectionModel, diags := NewTFStreamConnection(ctx, projectID, instanceName, &streamConnectionPlan.Authentication, apiResp)
+	newStreamConnectionModel, diags := NewTFStreamConnectionWithOriginal(ctx, projectID, instanceName, &streamConnectionPlan.Authentication, apiResp, &streamConnectionPlan)
 	if diags.HasError() {
 		resp.Diagnostics.Append(diags...)
 		return
@@ -213,7 +237,11 @@ func (r *streamConnectionRS) Delete(ctx context.Context, req resource.DeleteRequ
 
 	connV2 := r.Client.AtlasV2
 	projectID := streamConnectionState.ProjectID.ValueString()
-	instanceName := streamConnectionState.InstanceName.ValueString()
+	instanceName := getEffectiveInstanceName(streamConnectionState)
+	if instanceName == "" {
+		resp.Diagnostics.AddError("validation error", "either instance_name or workspace_name must be provided")
+		return
+	}
 	connectionName := streamConnectionState.ConnectionName.ValueString()
 	if err := DeleteStreamConnection(ctx, connV2.StreamsApi, projectID, instanceName, connectionName, 10*time.Minute); err != nil {
 		resp.Diagnostics.AddError("error deleting resource", err.Error())
diff --git a/internal/service/streamconnection/resource_stream_connection_test.go b/internal/service/streamconnection/resource_stream_connection_test.go
