feat: Add StreamWorkspace CloudFormation resource (#1517)

Co-authored-by: sivaram-mongodb <sivaram@mongodb.com>
Co-authored-by: ParthasarathyV <parthasarathy.varadhan@mongodb.com>
Co-authored-by: Rakhul S Prakash <rakhul.s.prakash@peerislands.io>
Co-authored-by: ParthasarathyV <114770988+ParthasarathyV@users.noreply.github.com>

Author: 4 people

.github/workflows/contract-testing.yaml

@@ -30,6 +30,7 @@ jobs:
      search-deployment: ${{ steps.filter.outputs.search-deployment }}
      stream-connection: ${{ steps.filter.outputs.stream-connection }}
      stream-instance: ${{ steps.filter.outputs.stream-instance }}
+     stream-workspace: ${{ steps.filter.outputs.stream-workspace }}
    steps:
    - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
      if: ${{ github.event_name == 'push' }}
@@ -75,6 +76,8 @@ jobs:
           - 'cfn-resources/stream-connection/**'
         stream-instance:
           - 'cfn-resources/stream-instance/**'
+        stream-workspace:
+          - 'cfn-resources/stream-workspace/**'
   access-list-api-key:
     needs: change-detection
     if: ${{ needs.change-detection.outputs.access-list-api-key == 'true' }}
@@ -854,3 +857,44 @@ jobs:
           cat inputs/inputs_1_create.json
           make run-contract-testing
           make delete-test-resources
+  stream-workspace:
+    needs: change-detection
+    if: ${{ needs.change-detection.outputs.stream-workspace == 'true' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+      - uses: actions/setup-go@4dc6199c7b1a012772edbd06daecab0f50c9053c
+        with:
+          go-version-file: 'cfn-resources/go.mod'
+      - name: setup Atlas CLI
+        uses: mongodb/atlas-github-action@e3c9e0204659bafbb3b65e1eb1ee745cca0e9f3b
+      - uses: aws-actions/setup-sam@c2a20b1822cc4a6bc594ff7f1dbb658758e383c3
+        with:
+          use-installer: true
+      - uses: aws-actions/configure-aws-credentials@61815dcd50bd041e203e49132bacad1fd04d2708
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID_TEST_ENV }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY_TEST_ENV }}
+          aws-region: eu-west-1
+      - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548
+        with:
+          python-version: '3.9'
+          cache: 'pip' # caching pip dependencies
+      - run: pip install cloudformation-cli cloudformation-cli-go-plugin
+      - name: Run the Contract test
+        shell: bash
+        env:
+          MONGODB_ATLAS_PUBLIC_API_KEY: ${{ secrets.CLOUD_DEV_PUBLIC_KEY }}
+          MONGODB_ATLAS_PRIVATE_API_KEY: ${{ secrets.CLOUD_DEV_PRIVATE_KEY }}
+          MONGODB_ATLAS_ORG_ID: ${{ secrets.CLOUD_DEV_ORG_ID }}
+          MONGODB_ATLAS_OPS_MANAGER_URL: ${{ vars.MONGODB_ATLAS_BASE_URL }}
+          MONGODB_ATLAS_PROFILE: cfn-cloud-dev-github-action
+        run: |
+          cd cfn-resources/stream-workspace
+          make create-test-resources
+
+          cat inputs/inputs_1_create.json
+          cat inputs/inputs_1_update.json
+
+          make run-contract-testing
+          make delete-test-resources

cfn-resources/stream-workspace/.rpdk-config

@@ -0,0 +1,22 @@
+{
+    "artifact_type": "RESOURCE",
+    "typeName": "MongoDB::Atlas::StreamWorkspace",
+    "language": "go",
+    "runtime": "provided.al2",
+    "entrypoint": "bootstrap",
+    "testEntrypoint": "bootstrap",
+    "settings": {
+        "version": false,
+        "subparser_name": null,
+        "verbose": 0,
+        "force": false,
+        "type_name": "MongoDB::Atlas::StreamWorkspace",
+        "artifact_type": null,
+        "endpoint_url": null,
+        "region": null,
+        "target_schemas": [],
+        "profile": null,
+        "import_path": "github.com/mongodb/mongodbatlas-cloudformation-resources/stream-workspace",
+        "protocolVersion": "2.0.0"
+    }
+}

cfn-resources/stream-workspace/Makefile

@@ -0,0 +1,33 @@
+.PHONY: build test clean
+tags=logging callback metrics scheduler
+cgo=0
+goos=linux
+goarch=amd64
+CFNREP_GIT_SHA?=$(shell git rev-parse HEAD)
+ldXflags=-s -w -X github.com/mongodb/mongodbatlas-cloudformation-resources/util.defaultLogLevel=info -X github.com/mongodb/mongodbatlas-cloudformation-resources/version.Version=${CFNREP_GIT_SHA}
+ldXflagsD=-X github.com/mongodb/mongodbatlas-cloudformation-resources/util.defaultLogLevel=debug -X github.com/mongodb/mongodbatlas-cloudformation-resources/version.Version=${CFNREP_GIT_SHA}
+
+build:
+	cfn generate
+	env GOOS=$(goos) CGO_ENABLED=$(cgo) GOARCH=$(goarch) go build -ldflags="$(ldXflags)" -tags="$(tags)" -o bin/bootstrap cmd/main.go
+
+debug:
+	cfn generate
+	env GOOS=$(goos) CGO_ENABLED=$(cgo) GOARCH=$(goarch) go build -ldflags="$(ldXflagsD)" -tags="$(tags)" -o bin/bootstrap cmd/main.go
+
+clean:
+	rm -rf bin
+
+create-test-resources:
+	@echo "==> Creating test files for contract testing"
+	./test/contract-testing/cfn-test-create-inputs.sh
+
+delete-test-resources:
+	@echo "==> Delete test resources used for contract testing"
+	./test/cfn-test-delete-inputs.sh
+
+run-contract-testing:
+	@echo "==> Run contract testing"
+	make build
+	sam local start-lambda &
+	cfn test --function-name TestEntrypoint --verbose

cfn-resources/stream-workspace/README.md

@@ -0,0 +1,18 @@
+# MongoDB::Atlas::StreamWorkspace
+
+## Description
+
+Resource for managing [Stream Workspaces](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/group/endpoint-streams).
+
+## Requirements
+
+Set up an AWS profile to securely give CloudFormation access to your Atlas credentials.
+For instructions on setting up a profile, [see here](/README.md#mongodb-atlas-api-keys-credential-management).
+
+## Attributes and Parameters
+
+See the [resource docs](docs/README.md). Also refer [AWS security best practices for CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/security-best-practices.html#creds) to manage credentials.
+
+## CloudFormation Examples
+
+See the examples [CFN Template](/examples/stream-workspace/stream-workspace.json) for example resource.

cfn-resources/stream-workspace/cmd/main.go

@@ -0,0 +1,98 @@
+// Copyright 2026 MongoDB Inc
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package resource
+
+import "go.mongodb.org/atlas-sdk/v20250312012/admin"
+
+func NewStreamWorkspaceCreateReq(model *Model) *admin.StreamsTenant {
+	if model == nil {
+		return nil
+	}
+	dataProcessRegion := *model.DataProcessRegion
+	streamTenant := &admin.StreamsTenant{
+		Name:    model.WorkspaceName,
+		GroupId: model.ProjectId,
+		DataProcessRegion: &admin.StreamsDataProcessRegion{
+			CloudProvider: *dataProcessRegion.CloudProvider,
+			Region:        *dataProcessRegion.Region,
+		},
+	}
+	if streamConfig := model.StreamConfig; streamConfig != nil {
+		streamTenant.StreamConfig = &admin.StreamConfig{}
+		if tier := streamConfig.Tier; tier != nil {
+			streamTenant.StreamConfig.Tier = tier
+		}
+		if maxTierSize := streamConfig.MaxTierSize; maxTierSize != nil {
+			streamTenant.StreamConfig.MaxTierSize = maxTierSize
+		}
+	}
+	return streamTenant
+}
+
+func NewStreamWorkspaceUpdateReq(model *Model) *admin.StreamsTenantUpdateRequest {
+	if model == nil || model.DataProcessRegion == nil {
+		return nil
+	}
+	dataProcessRegion := *model.DataProcessRegion
+	if dataProcessRegion.Region == nil {
+		return nil
+	}
+	// CloudFormation is AWS-only, so CloudProvider is always AWS
+	cloudProvider := CloudProvider
+	return &admin.StreamsTenantUpdateRequest{
+		CloudProvider: &cloudProvider,
+		Region:        dataProcessRegion.Region,
+	}
+}
+
+func newModelDataRegion(dataProcessRegion *admin.StreamsDataProcessRegion) *StreamsDataProcessRegion {
+	return &StreamsDataProcessRegion{
+		CloudProvider: &dataProcessRegion.CloudProvider,
+		Region:        &dataProcessRegion.Region,
+	}
+}
+
+func newModelStreamConfig(streamConfig *admin.StreamConfig) *StreamConfig {
+	if streamConfig == nil {
+		return nil
+	}
+	modelConfig := &StreamConfig{}
+	if streamConfig.Tier != nil {
+		modelConfig.Tier = streamConfig.Tier
+	}
+	if streamConfig.MaxTierSize != nil {
+		modelConfig.MaxTierSize = streamConfig.MaxTierSize
+	}
+	return modelConfig
+}
+
+func GetStreamWorkspaceModel(streamTenant *admin.StreamsTenant, currentModel *Model) *Model {
+	model := new(Model)
+
+	if currentModel != nil {
+		model = currentModel
+	}
+
+	if streamTenant != nil {
+		model.WorkspaceName = streamTenant.Name
+		model.DataProcessRegion = newModelDataRegion(streamTenant.DataProcessRegion)
+		model.StreamConfig = newModelStreamConfig(streamTenant.StreamConfig)
+		model.ProjectId = streamTenant.GroupId
+		model.Id = streamTenant.Id
+		model.Hostnames = streamTenant.GetHostnames()
+	}
+
+	return model
+}