feat: Add workspace_name field in stream_processor resource and datasource (#3793)

Author: kpatel71716

.changelog/3793.txt

@@ -0,0 +1,11 @@
+```release-note:note
+resource/mongodbatlas_stream_processor: Deprecates the `instance_name` attribute, use `workspace_name` instead
+
+```
+```release-note:note
+data-source/mongodbatlas_stream_processor: Deprecates the `instance_name` attribute, use `workspace_name` instead
+```
+
+```release-note:note
+data-source/mongodbatlas_stream_processors: Deprecates the `instance_name` attribute, use `workspace_name` instead
+```

docs/data-sources/stream_connection.md

@@ -29,9 +29,9 @@ data "mongodbatlas_stream_connection" "example" {
 ## Argument Reference
 
 * `project_id` - (Required) Unique 24-hexadecimal digit string that identifies your project.
-* `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.
+* `instance_name` - (Deprecated) Label that identifies the stream processing workspace. Attribute is deprecated and will be removed in following major versions in favor of `workspace_name`.
+* `workspace_name` - (Optional) Label that identifies the stream processing workspace. Conflicts with `instance_name`.
+* `connection_name` - (Required) 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`.
 

docs/data-sources/stream_connections.md

@@ -18,8 +18,8 @@ data "mongodbatlas_stream_connections" "test" {
 ## Argument Reference
 
 * `project_id` - (Required) Unique 24-hexadecimal digit string that identifies your project.
-* `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`.
+* `instance_name` - (Deprecated) Label that identifies the stream processing workspace. Attribute is deprecated and will be removed in following major versions in favor of `workspace_name`.
+* `workspace_name` - (Optional) Label that identifies the stream processing workspace. 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`.
 
@@ -37,8 +37,8 @@ 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.
-* `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.
+* `workspace_name` - Label that identifies the stream processing workspace.
+* `connection_name` - 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`.
 
 If `type` is of value `Cluster` the following additional attributes are defined:

docs/data-sources/stream_processor.md

@@ -19,14 +19,14 @@ resource "mongodbatlas_stream_instance" "example" {
 
 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-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
@@ -38,7 +38,7 @@ resource "mongodbatlas_stream_connection" "example-cluster" {
 
 resource "mongodbatlas_stream_connection" "example-kafka" {
   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 = {
@@ -57,7 +57,7 @@ resource "mongodbatlas_stream_connection" "example-kafka" {
 
 resource "mongodbatlas_stream_processor" "stream-processor-sample-example" {
   project_id     = var.project_id
-  instance_name  = mongodbatlas_stream_instance.example.instance_name
+  workspace_name = mongodbatlas_stream_instance.example.instance_name
   processor_name = "sampleProcessorName"
   pipeline = jsonencode([
     { "$source" = { "connectionName" = resource.mongodbatlas_stream_connection.example-sample.connection_name } },
@@ -68,7 +68,7 @@ resource "mongodbatlas_stream_processor" "stream-processor-sample-example" {
 
 resource "mongodbatlas_stream_processor" "stream-processor-cluster-to-kafka-example" {
   project_id     = var.project_id
-  instance_name  = mongodbatlas_stream_instance.example.instance_name
+  workspace_name = mongodbatlas_stream_instance.example.instance_name
   processor_name = "clusterProcessorName"
   pipeline = jsonencode([
     { "$source" = { "connectionName" = resource.mongodbatlas_stream_connection.example-cluster.connection_name } },
@@ -79,7 +79,7 @@ resource "mongodbatlas_stream_processor" "stream-processor-cluster-to-kafka-exam
 
 resource "mongodbatlas_stream_processor" "stream-processor-kafka-to-cluster-example" {
   project_id     = var.project_id
-  instance_name  = mongodbatlas_stream_instance.example.instance_name
+  workspace_name = mongodbatlas_stream_instance.example.instance_name
   processor_name = "kafkaProcessorName"
   pipeline = jsonencode([
     { "$source" = { "connectionName" = resource.mongodbatlas_stream_connection.example-kafka.connection_name, "topic" : "topic_source" } },
@@ -96,13 +96,13 @@ resource "mongodbatlas_stream_processor" "stream-processor-kafka-to-cluster-exam
 }
 
 data "mongodbatlas_stream_processors" "example-stream-processors" {
-  project_id    = var.project_id
-  instance_name = mongodbatlas_stream_instance.example.instance_name
+  project_id     = var.project_id
+  workspace_name = mongodbatlas_stream_instance.example.instance_name
 }
 
 data "mongodbatlas_stream_processor" "example-stream-processor" {
   project_id     = var.project_id
-  instance_name  = mongodbatlas_stream_instance.example.instance_name
+  workspace_name = mongodbatlas_stream_instance.example.instance_name
   processor_name = mongodbatlas_stream_processor.stream-processor-sample-example.processor_name
 }
 
@@ -121,12 +121,16 @@ output "stream_processors_results" {
 
 ### Required
 
-- `instance_name` (String) Human-readable label that identifies the stream instance.
-- `processor_name` (String) Human-readable label that identifies the stream processor.
+- `processor_name` (String) Label that identifies the stream processor.
 - `project_id` (String) Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
 
 **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
 
+### Optional
+
+- `instance_name` (String, Deprecated) Label that identifies the stream processing workspace.
+- `workspace_name` (String) Label that identifies the stream processing workspace. Conflicts with `instance_name`.
+
 ### Read-Only
 
 - `id` (String) Unique 24-hexadecimal character string that identifies the stream processor.

docs/data-sources/stream_processors.md

@@ -19,14 +19,14 @@ resource "mongodbatlas_stream_instance" "example" {
 
 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-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
@@ -38,7 +38,7 @@ resource "mongodbatlas_stream_connection" "example-cluster" {
 
 resource "mongodbatlas_stream_connection" "example-kafka" {
   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 = {
@@ -57,7 +57,7 @@ resource "mongodbatlas_stream_connection" "example-kafka" {
 
 resource "mongodbatlas_stream_processor" "stream-processor-sample-example" {
   project_id     = var.project_id
-  instance_name  = mongodbatlas_stream_instance.example.instance_name
+  workspace_name = mongodbatlas_stream_instance.example.instance_name
   processor_name = "sampleProcessorName"
   pipeline = jsonencode([
     { "$source" = { "connectionName" = resource.mongodbatlas_stream_connection.example-sample.connection_name } },
@@ -68,7 +68,7 @@ resource "mongodbatlas_stream_processor" "stream-processor-sample-example" {
 
 resource "mongodbatlas_stream_processor" "stream-processor-cluster-to-kafka-example" {
   project_id     = var.project_id
-  instance_name  = mongodbatlas_stream_instance.example.instance_name
+  workspace_name = mongodbatlas_stream_instance.example.instance_name
   processor_name = "clusterProcessorName"
   pipeline = jsonencode([
     { "$source" = { "connectionName" = resource.mongodbatlas_stream_connection.example-cluster.connection_name } },
@@ -79,7 +79,7 @@ resource "mongodbatlas_stream_processor" "stream-processor-cluster-to-kafka-exam
 
 resource "mongodbatlas_stream_processor" "stream-processor-kafka-to-cluster-example" {
   project_id     = var.project_id
-  instance_name  = mongodbatlas_stream_instance.example.instance_name
+  workspace_name = mongodbatlas_stream_instance.example.instance_name
   processor_name = "kafkaProcessorName"
   pipeline = jsonencode([
     { "$source" = { "connectionName" = resource.mongodbatlas_stream_connection.example-kafka.connection_name, "topic" : "topic_source" } },
@@ -96,13 +96,13 @@ resource "mongodbatlas_stream_processor" "stream-processor-kafka-to-cluster-exam
 }
 
 data "mongodbatlas_stream_processors" "example-stream-processors" {
-  project_id    = var.project_id
-  instance_name = mongodbatlas_stream_instance.example.instance_name
+  project_id     = var.project_id
+  workspace_name = mongodbatlas_stream_instance.example.instance_name
 }
 
 data "mongodbatlas_stream_processor" "example-stream-processor" {
   project_id     = var.project_id
-  instance_name  = mongodbatlas_stream_instance.example.instance_name
+  workspace_name = mongodbatlas_stream_instance.example.instance_name
   processor_name = mongodbatlas_stream_processor.stream-processor-sample-example.processor_name
 }
 
@@ -121,11 +121,15 @@ output "stream_processors_results" {
 
 ### Required
 
-- `instance_name` (String) Human-readable label that identifies the stream instance.
 - `project_id` (String) Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
 
 **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
 
+### Optional
+
+- `instance_name` (String, Deprecated) Label that identifies the stream processing workspace.
+- `workspace_name` (String) Label that identifies the stream processing workspace. Conflicts with `instance_name`.
+
 ### Read-Only
 
 - `results` (Attributes List) Returns all Stream Processors within the specified stream instance.
@@ -140,17 +144,18 @@ role or Project Stream Processing Owner role. (see [below for nested schema](#ne
 Read-Only:
 
 - `id` (String) Unique 24-hexadecimal character string that identifies the stream processor.
-- `instance_name` (String) Human-readable label that identifies the stream instance.
+- `instance_name` (String, Deprecated) Label that identifies the stream processing workspace.
 - `options` (Attributes) Optional configuration for the stream processor. (see [below for nested schema](#nestedatt--results--options))
 - `pipeline` (String) Stream aggregation pipeline you want to apply to your streaming data. [MongoDB Atlas Docs](https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation) contain more information. Using [jsonencode](https://developer.hashicorp.com/terraform/language/functions/jsonencode) is recommended when setting this attribute. For more details see the [Aggregation Pipelines Documentation](https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/)
-- `processor_name` (String) Human-readable label that identifies the stream processor.
+- `processor_name` (String) Label that identifies the stream processor.
 - `project_id` (String) Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
 
 **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
 - `state` (String) The state of the stream processor. Commonly occurring states are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'. Used to start or stop the Stream Processor. Valid values are `CREATED`, `STARTED` or `STOPPED`. When a Stream Processor is created without specifying the state, it will default to `CREATED` state. When a Stream Processor is updated without specifying the state, it will default to the Previous state. 
 
 **NOTE** When a Stream Processor is updated without specifying the state, it is stopped and then restored to previous state upon update completion.
 - `stats` (String) The stats associated with the stream processor. Refer to the [MongoDB Atlas Docs](https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor) for more information.
+- `workspace_name` (String) Label that identifies the stream processing workspace.
 
 <a id="nestedatt--results--options"></a>
 ### Nested Schema for `results.options`

docs/resources/stream_connection.md

@@ -152,9 +152,9 @@ resource "mongodbatlas_stream_connection" "example-https" {
 ## Argument Reference
 
 * `project_id` - (Required) Unique 24-hexadecimal digit string that identifies your project.
-* `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.
+* `instance_name` - (Deprecated) Label that identifies the stream processing workspace. Attribute is deprecated and will be removed in following major versions in favor of `workspace_name`.
+* `workspace_name` - (Optional) Label that identifies the stream processing workspace. Conflicts with `instance_name`.
+* `connection_name` - (Required) 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`.