Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Mongodbatlas Provider
  4. API Docs
  5. StreamWorkspace
Viewing docs for MongoDB Atlas v4.13.0
published on Thursday, Jul 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

mongodbatlas.StreamWorkspace

mongodbatlas logo
Viewing docs for MongoDB Atlas v4.13.0
published on Thursday, Jul 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

    mongodbatlas.StreamWorkspace provides a Stream Workspace resource. The resource lets you create, edit, and delete stream workspaces in a project.

    NOTE: This resource is an alias for mongodbatlas.StreamInstance. Use this resource for new configurations.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const test = new mongodbatlas.StreamWorkspace("test", {
    projectId: projectId,
    workspaceName: "WorkspaceName",
    dataProcessRegion: {
        region: "VIRGINIA_USA",
        cloudProvider: "AWS",
    },
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.StreamWorkspace("test",
    project_id=project_id,
    workspace_name="WorkspaceName",
    data_process_region={
        "region": "VIRGINIA_USA",
        "cloud_provider": "AWS",
    })

    package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v4/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodbatlas.NewStreamWorkspace(ctx, "test", &mongodbatlas.StreamWorkspaceArgs{
			ProjectId:     pulumi.Any(projectId),
			WorkspaceName: pulumi.String("WorkspaceName"),
			DataProcessRegion: &mongodbatlas.StreamWorkspaceDataProcessRegionArgs{
				Region:        pulumi.String("VIRGINIA_USA"),
				CloudProvider: pulumi.String("AWS"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var test = new Mongodbatlas.StreamWorkspace("test", new()
    {
        ProjectId = projectId,
        WorkspaceName = "WorkspaceName",
        DataProcessRegion = new Mongodbatlas.Inputs.StreamWorkspaceDataProcessRegionArgs
        {
            Region = "VIRGINIA_USA",
            CloudProvider = "AWS",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.StreamWorkspace;
import com.pulumi.mongodbatlas.StreamWorkspaceArgs;
import com.pulumi.mongodbatlas.inputs.StreamWorkspaceDataProcessRegionArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new StreamWorkspace("test", StreamWorkspaceArgs.builder()
            .projectId(projectId)
            .workspaceName("WorkspaceName")
            .dataProcessRegion(StreamWorkspaceDataProcessRegionArgs.builder()
                .region("VIRGINIA_USA")
                .cloudProvider("AWS")
                .build())
            .build());

    }
}

    resources:
  test:
    type: mongodbatlas:StreamWorkspace
    properties:
      projectId: ${projectId}
      workspaceName: WorkspaceName
      dataProcessRegion:
        region: VIRGINIA_USA
        cloudProvider: AWS

    pulumi {
  required_providers {
    mongodbatlas = {
      source = "pulumi/mongodbatlas"
    }
  }
}

resource "mongodbatlas_streamworkspace" "test" {
  project_id     = projectId
  workspace_name = "WorkspaceName"
  data_process_region = {
    region         = "VIRGINIA_USA"
    cloud_provider = "AWS"
  }
}

    With Failover Regions

    import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const test = new mongodbatlas.StreamWorkspace("test", {
    projectId: projectId,
    workspaceName: "WorkspaceName",
    dataProcessRegion: {
        region: "VIRGINIA_USA",
        cloudProvider: "AWS",
    },
    failoverRegions: [{
        cloudProvider: "AWS",
        region: "OREGON_USA",
    }],
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.StreamWorkspace("test",
    project_id=project_id,
    workspace_name="WorkspaceName",
    data_process_region={
        "region": "VIRGINIA_USA",
        "cloud_provider": "AWS",
    },
    failover_regions=[{
        "cloud_provider": "AWS",
        "region": "OREGON_USA",
    }])

    package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v4/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodbatlas.NewStreamWorkspace(ctx, "test", &mongodbatlas.StreamWorkspaceArgs{
			ProjectId:     pulumi.Any(projectId),
			WorkspaceName: pulumi.String("WorkspaceName"),
			DataProcessRegion: &mongodbatlas.StreamWorkspaceDataProcessRegionArgs{
				Region:        pulumi.String("VIRGINIA_USA"),
				CloudProvider: pulumi.String("AWS"),
			},
			FailoverRegions: mongodbatlas.StreamWorkspaceFailoverRegionArray{
				&mongodbatlas.StreamWorkspaceFailoverRegionArgs{
					CloudProvider: pulumi.String("AWS"),
					Region:        pulumi.String("OREGON_USA"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var test = new Mongodbatlas.StreamWorkspace("test", new()
    {
        ProjectId = projectId,
        WorkspaceName = "WorkspaceName",
        DataProcessRegion = new Mongodbatlas.Inputs.StreamWorkspaceDataProcessRegionArgs
        {
            Region = "VIRGINIA_USA",
            CloudProvider = "AWS",
        },
        FailoverRegions = new[]
        {
            new Mongodbatlas.Inputs.StreamWorkspaceFailoverRegionArgs
            {
                CloudProvider = "AWS",
                Region = "OREGON_USA",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.StreamWorkspace;
import com.pulumi.mongodbatlas.StreamWorkspaceArgs;
import com.pulumi.mongodbatlas.inputs.StreamWorkspaceDataProcessRegionArgs;
import com.pulumi.mongodbatlas.inputs.StreamWorkspaceFailoverRegionArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new StreamWorkspace("test", StreamWorkspaceArgs.builder()
            .projectId(projectId)
            .workspaceName("WorkspaceName")
            .dataProcessRegion(StreamWorkspaceDataProcessRegionArgs.builder()
                .region("VIRGINIA_USA")
                .cloudProvider("AWS")
                .build())
            .failoverRegions(StreamWorkspaceFailoverRegionArgs.builder()
                .cloudProvider("AWS")
                .region("OREGON_USA")
                .build())
            .build());

    }
}

    resources:
  test:
    type: mongodbatlas:StreamWorkspace
    properties:
      projectId: ${projectId}
      workspaceName: WorkspaceName
      dataProcessRegion:
        region: VIRGINIA_USA
        cloudProvider: AWS
      failoverRegions:
        - cloudProvider: AWS
          region: OREGON_USA

    pulumi {
  required_providers {
    mongodbatlas = {
      source = "pulumi/mongodbatlas"
    }
  }
}

resource "mongodbatlas_streamworkspace" "test" {
  project_id     = projectId
  workspace_name = "WorkspaceName"
  data_process_region = {
    region         = "VIRGINIA_USA"
    cloud_provider = "AWS"
  }
  failover_regions {
    cloud_provider = "AWS"
    region         = "OREGON_USA"
  }
}

    Further Examples

    • Atlas Stream Workspace

    Migration from streamInstance

    To migrate from mongodbatlas.StreamInstance to mongodbatlas.StreamWorkspace, use the following moved block:

    import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const example = new mongodbatlas.StreamWorkspace("example", {
    projectId: projectId,
    workspaceName: "WorkspaceName",
    dataProcessRegion: {
        region: "VIRGINIA_USA",
        cloudProvider: "AWS",
    },
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

example = mongodbatlas.StreamWorkspace("example",
    project_id=project_id,
    workspace_name="WorkspaceName",
    data_process_region={
        "region": "VIRGINIA_USA",
        "cloud_provider": "AWS",
    })

    package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v4/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodbatlas.NewStreamWorkspace(ctx, "example", &mongodbatlas.StreamWorkspaceArgs{
			ProjectId:     pulumi.Any(projectId),
			WorkspaceName: pulumi.String("WorkspaceName"),
			DataProcessRegion: &mongodbatlas.StreamWorkspaceDataProcessRegionArgs{
				Region:        pulumi.String("VIRGINIA_USA"),
				CloudProvider: pulumi.String("AWS"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var example = new Mongodbatlas.StreamWorkspace("example", new()
    {
        ProjectId = projectId,
        WorkspaceName = "WorkspaceName",
        DataProcessRegion = new Mongodbatlas.Inputs.StreamWorkspaceDataProcessRegionArgs
        {
            Region = "VIRGINIA_USA",
            CloudProvider = "AWS",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.StreamWorkspace;
import com.pulumi.mongodbatlas.StreamWorkspaceArgs;
import com.pulumi.mongodbatlas.inputs.StreamWorkspaceDataProcessRegionArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new StreamWorkspace("example", StreamWorkspaceArgs.builder()
            .projectId(projectId)
            .workspaceName("WorkspaceName")
            .dataProcessRegion(StreamWorkspaceDataProcessRegionArgs.builder()
                .region("VIRGINIA_USA")
                .cloudProvider("AWS")
                .build())
            .build());

    }
}

    resources:
  example:
    type: mongodbatlas:StreamWorkspace
    properties:
      projectId: ${projectId}
      workspaceName: WorkspaceName
      dataProcessRegion:
        region: VIRGINIA_USA
        cloudProvider: AWS

    pulumi {
  required_providers {
    mongodbatlas = {
      source = "pulumi/mongodbatlas"
    }
  }
}

resource "mongodbatlas_streamworkspace" "example" {
  project_id     = projectId
  workspace_name = "WorkspaceName"
  data_process_region = {
    region         = "VIRGINIA_USA"
    cloud_provider = "AWS"
  }
}

    Create StreamWorkspace Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new StreamWorkspace(name: string, args: StreamWorkspaceArgs, opts?: CustomResourceOptions);
    @overload
def StreamWorkspace(resource_name: str,
                    args: StreamWorkspaceArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def StreamWorkspace(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    data_process_region: Optional[StreamWorkspaceDataProcessRegionArgs] = None,
                    project_id: Optional[str] = None,
                    workspace_name: Optional[str] = None,
                    failover_regions: Optional[Sequence[StreamWorkspaceFailoverRegionArgs]] = None,
                    stream_config: Optional[StreamWorkspaceStreamConfigArgs] = None)
    func NewStreamWorkspace(ctx *Context, name string, args StreamWorkspaceArgs, opts ...ResourceOption) (*StreamWorkspace, error)
    public StreamWorkspace(string name, StreamWorkspaceArgs args, CustomResourceOptions? opts = null)
    public StreamWorkspace(String name, StreamWorkspaceArgs args)
public StreamWorkspace(String name, StreamWorkspaceArgs args, CustomResourceOptions options)

    type: mongodbatlas:StreamWorkspace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "mongodbatlas_stream_workspace" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args StreamWorkspaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StreamWorkspaceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StreamWorkspaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StreamWorkspaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StreamWorkspaceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var streamWorkspaceResource = new Mongodbatlas.StreamWorkspace("streamWorkspaceResource", new()
{
    DataProcessRegion = new Mongodbatlas.Inputs.StreamWorkspaceDataProcessRegionArgs
    {
        CloudProvider = "string",
        Region = "string",
    },
    ProjectId = "string",
    WorkspaceName = "string",
    FailoverRegions = new[]
    {
        new Mongodbatlas.Inputs.StreamWorkspaceFailoverRegionArgs
        {
            CloudProvider = "string",
            Region = "string",
        },
    },
    StreamConfig = new Mongodbatlas.Inputs.StreamWorkspaceStreamConfigArgs
    {
        MaxTierSize = "string",
        Tier = "string",
    },
});

    example, err := mongodbatlas.NewStreamWorkspace(ctx, "streamWorkspaceResource", &mongodbatlas.StreamWorkspaceArgs{
	DataProcessRegion: &mongodbatlas.StreamWorkspaceDataProcessRegionArgs{
		CloudProvider: pulumi.String("string"),
		Region:        pulumi.String("string"),
	},
	ProjectId:     pulumi.String("string"),
	WorkspaceName: pulumi.String("string"),
	FailoverRegions: mongodbatlas.StreamWorkspaceFailoverRegionArray{
		&mongodbatlas.StreamWorkspaceFailoverRegionArgs{
			CloudProvider: pulumi.String("string"),
			Region:        pulumi.String("string"),
		},
	},
	StreamConfig: &mongodbatlas.StreamWorkspaceStreamConfigArgs{
		MaxTierSize: pulumi.String("string"),
		Tier:        pulumi.String("string"),
	},
})

    resource "mongodbatlas_stream_workspace" "streamWorkspaceResource" {
  lifecycle {
    create_before_destroy = true
  }
  data_process_region = {
    cloud_provider = "string"
    region         = "string"
  }
  project_id     = "string"
  workspace_name = "string"
  failover_regions {
    cloud_provider = "string"
    region         = "string"
  }
  stream_config = {
    max_tier_size = "string"
    tier          = "string"
  }
}

    var streamWorkspaceResource = new StreamWorkspace("streamWorkspaceResource", StreamWorkspaceArgs.builder()
    .dataProcessRegion(StreamWorkspaceDataProcessRegionArgs.builder()
        .cloudProvider("string")
        .region("string")
        .build())
    .projectId("string")
    .workspaceName("string")
    .failoverRegions(StreamWorkspaceFailoverRegionArgs.builder()
        .cloudProvider("string")
        .region("string")
        .build())
    .streamConfig(StreamWorkspaceStreamConfigArgs.builder()
        .maxTierSize("string")
        .tier("string")
        .build())
    .build());

    stream_workspace_resource = mongodbatlas.StreamWorkspace("streamWorkspaceResource",
    data_process_region={
        "cloud_provider": "string",
        "region": "string",
    },
    project_id="string",
    workspace_name="string",
    failover_regions=[{
        "cloud_provider": "string",
        "region": "string",
    }],
    stream_config={
        "max_tier_size": "string",
        "tier": "string",
    })

    const streamWorkspaceResource = new mongodbatlas.StreamWorkspace("streamWorkspaceResource", {
    dataProcessRegion: {
        cloudProvider: "string",
        region: "string",
    },
    projectId: "string",
    workspaceName: "string",
    failoverRegions: [{
        cloudProvider: "string",
        region: "string",
    }],
    streamConfig: {
        maxTierSize: "string",
        tier: "string",
    },
});

    type: mongodbatlas:StreamWorkspace
properties:
    dataProcessRegion:
        cloudProvider: string
        region: string
    failoverRegions:
        - cloudProvider: string
          region: string
    projectId: string
    streamConfig:
        maxTierSize: string
        tier: string
    workspaceName: string

    StreamWorkspace Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The StreamWorkspace resource accepts the following input properties:

    DataProcessRegion StreamWorkspaceDataProcessRegion
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    WorkspaceName string
    Label that identifies the stream workspace.
    FailoverRegions List<StreamWorkspaceFailoverRegion>
    List of cloud provider regions to which the workspace can fail over if the primary region becomes unavailable. See failover regions. Write-once: once set, failoverRegions cannot be changed in-place — any modification forces the workspace to be destroyed and recreated. Mutually exclusive with dataProcessRegion updates: failoverRegions and dataProcessRegion cannot both be changed in the same apply. Apply each change in a separate operation.
    StreamConfig StreamWorkspaceStreamConfig
    Configuration options for an Atlas Stream Processing Instance. See stream config.
    DataProcessRegion StreamWorkspaceDataProcessRegionArgs
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    WorkspaceName string
    Label that identifies the stream workspace.
    FailoverRegions []StreamWorkspaceFailoverRegionArgs
    List of cloud provider regions to which the workspace can fail over if the primary region becomes unavailable. See failover regions. Write-once: once set, failoverRegions cannot be changed in-place — any modification forces the workspace to be destroyed and recreated. Mutually exclusive with dataProcessRegion updates: failoverRegions and dataProcessRegion cannot both be changed in the same apply. Apply each change in a separate operation.
    StreamConfig StreamWorkspaceStreamConfigArgs
    Configuration options for an Atlas Stream Processing Instance. See stream config.
    data_process_region object
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    project_id string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    workspace_name string
    Label that identifies the stream workspace.
    failover_regions list(object)
    List of cloud provider regions to which the workspace can fail over if the primary region becomes unavailable. See failover regions. Write-once: once set, failoverRegions cannot be changed in-place — any modification forces the workspace to be destroyed and recreated. Mutually exclusive with dataProcessRegion updates: failoverRegions and dataProcessRegion cannot both be changed in the same apply. Apply each change in a separate operation.
    stream_config object
    Configuration options for an Atlas Stream Processing Instance. See stream config.
    dataProcessRegion StreamWorkspaceDataProcessRegion
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    workspaceName String
    Label that identifies the stream workspace.
    failoverRegions List<StreamWorkspaceFailoverRegion>
    List of cloud provider regions to which the workspace can fail over if the primary region becomes unavailable. See failover regions. Write-once: once set, failoverRegions cannot be changed in-place — any modification forces the workspace to be destroyed and recreated. Mutually exclusive with dataProcessRegion updates: failoverRegions and dataProcessRegion cannot both be changed in the same apply. Apply each change in a separate operation.
    streamConfig StreamWorkspaceStreamConfig
    Configuration options for an Atlas Stream Processing Instance. See stream config.
    dataProcessRegion StreamWorkspaceDataProcessRegion
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    workspaceName string
    Label that identifies the stream workspace.
    failoverRegions StreamWorkspaceFailoverRegion[]
    List of cloud provider regions to which the workspace can fail over if the primary region becomes unavailable. See failover regions. Write-once: once set, failoverRegions cannot be changed in-place — any modification forces the workspace to be destroyed and recreated. Mutually exclusive with dataProcessRegion updates: failoverRegions and dataProcessRegion cannot both be changed in the same apply. Apply each change in a separate operation.
    streamConfig StreamWorkspaceStreamConfig
    Configuration options for an Atlas Stream Processing Instance. See stream config.
    data_process_region StreamWorkspaceDataProcessRegionArgs
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    workspace_name str
    Label that identifies the stream workspace.
    failover_regions Sequence[StreamWorkspaceFailoverRegionArgs]
    List of cloud provider regions to which the workspace can fail over if the primary region becomes unavailable. See failover regions. Write-once: once set, failoverRegions cannot be changed in-place — any modification forces the workspace to be destroyed and recreated. Mutually exclusive with dataProcessRegion updates: failoverRegions and dataProcessRegion cannot both be changed in the same apply. Apply each change in a separate operation.
    stream_config StreamWorkspaceStreamConfigArgs
    Configuration options for an Atlas Stream Processing Instance. See stream config.
    dataProcessRegion Property Map
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    workspaceName String
    Label that identifies the stream workspace.
    failoverRegions List<Property Map>
    List of cloud provider regions to which the workspace can fail over if the primary region becomes unavailable. See failover regions. Write-once: once set, failoverRegions cannot be changed in-place — any modification forces the workspace to be destroyed and recreated. Mutually exclusive with dataProcessRegion updates: failoverRegions and dataProcessRegion cannot both be changed in the same apply. Apply each change in a separate operation.
    streamConfig Property Map
    Configuration options for an Atlas Stream Processing Instance. See stream config.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StreamWorkspace resource produces the following output properties:

    Hostnames List<string>
    List that contains the hostnames assigned to the stream workspace.
    Id string
    The provider-assigned unique ID for this managed resource.
    Hostnames []string
    List that contains the hostnames assigned to the stream workspace.
    Id string
    The provider-assigned unique ID for this managed resource.
    hostnames list(string)
    List that contains the hostnames assigned to the stream workspace.
    id string
    The provider-assigned unique ID for this managed resource.
    hostnames List<String>
    List that contains the hostnames assigned to the stream workspace.
    id String
    The provider-assigned unique ID for this managed resource.
    hostnames string[]
    List that contains the hostnames assigned to the stream workspace.
    id string
    The provider-assigned unique ID for this managed resource.
    hostnames Sequence[str]
    List that contains the hostnames assigned to the stream workspace.
    id str
    The provider-assigned unique ID for this managed resource.
    hostnames List<String>
    List that contains the hostnames assigned to the stream workspace.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing StreamWorkspace Resource

    Get an existing StreamWorkspace resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: StreamWorkspaceState, opts?: CustomResourceOptions): StreamWorkspace
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_process_region: Optional[StreamWorkspaceDataProcessRegionArgs] = None,
        failover_regions: Optional[Sequence[StreamWorkspaceFailoverRegionArgs]] = None,
        hostnames: Optional[Sequence[str]] = None,
        project_id: Optional[str] = None,
        stream_config: Optional[StreamWorkspaceStreamConfigArgs] = None,
        workspace_name: Optional[str] = None) -> StreamWorkspace
    func GetStreamWorkspace(ctx *Context, name string, id IDInput, state *StreamWorkspaceState, opts ...ResourceOption) (*StreamWorkspace, error)
    public static StreamWorkspace Get(string name, Input<string> id, StreamWorkspaceState? state, CustomResourceOptions? opts = null)
    public static StreamWorkspace get(String name, Output<String> id, StreamWorkspaceState state, CustomResourceOptions options)
    resources:  _:    type: mongodbatlas:StreamWorkspace    get:      id: ${id}
    import {
  to = mongodbatlas_stream_workspace.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DataProcessRegion StreamWorkspaceDataProcessRegion
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    FailoverRegions List<StreamWorkspaceFailoverRegion>
    List of cloud provider regions to which the workspace can fail over if the primary region becomes unavailable. See failover regions. Write-once: once set, failoverRegions cannot be changed in-place — any modification forces the workspace to be destroyed and recreated. Mutually exclusive with dataProcessRegion updates: failoverRegions and dataProcessRegion cannot both be changed in the same apply. Apply each change in a separate operation.
    Hostnames List<string>
    List that contains the hostnames assigned to the stream workspace.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    StreamConfig StreamWorkspaceStreamConfig
    Configuration options for an Atlas Stream Processing Instance. See stream config.
    WorkspaceName string
    Label that identifies the stream workspace.
    DataProcessRegion StreamWorkspaceDataProcessRegionArgs
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    FailoverRegions []StreamWorkspaceFailoverRegionArgs
    List of cloud provider regions to which the workspace can fail over if the primary region becomes unavailable. See failover regions. Write-once: once set, failoverRegions cannot be changed in-place — any modification forces the workspace to be destroyed and recreated. Mutually exclusive with dataProcessRegion updates: failoverRegions and dataProcessRegion cannot both be changed in the same apply. Apply each change in a separate operation.
    Hostnames []string
    List that contains the hostnames assigned to the stream workspace.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    StreamConfig StreamWorkspaceStreamConfigArgs
    Configuration options for an Atlas Stream Processing Instance. See stream config.
    WorkspaceName string
    Label that identifies the stream workspace.
    data_process_region object
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    failover_regions list(object)
    List of cloud provider regions to which the workspace can fail over if the primary region becomes unavailable. See failover regions. Write-once: once set, failoverRegions cannot be changed in-place — any modification forces the workspace to be destroyed and recreated. Mutually exclusive with dataProcessRegion updates: failoverRegions and dataProcessRegion cannot both be changed in the same apply. Apply each change in a separate operation.
    hostnames list(string)
    List that contains the hostnames assigned to the stream workspace.
    project_id string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    stream_config object
    Configuration options for an Atlas Stream Processing Instance. See stream config.
    workspace_name string
    Label that identifies the stream workspace.
    dataProcessRegion StreamWorkspaceDataProcessRegion
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    failoverRegions List<StreamWorkspaceFailoverRegion>
    List of cloud provider regions to which the workspace can fail over if the primary region becomes unavailable. See failover regions. Write-once: once set, failoverRegions cannot be changed in-place — any modification forces the workspace to be destroyed and recreated. Mutually exclusive with dataProcessRegion updates: failoverRegions and dataProcessRegion cannot both be changed in the same apply. Apply each change in a separate operation.
    hostnames List<String>
    List that contains the hostnames assigned to the stream workspace.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    streamConfig StreamWorkspaceStreamConfig
    Configuration options for an Atlas Stream Processing Instance. See stream config.
    workspaceName String
    Label that identifies the stream workspace.
    dataProcessRegion StreamWorkspaceDataProcessRegion
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    failoverRegions StreamWorkspaceFailoverRegion[]
    List of cloud provider regions to which the workspace can fail over if the primary region becomes unavailable. See failover regions. Write-once: once set, failoverRegions cannot be changed in-place — any modification forces the workspace to be destroyed and recreated. Mutually exclusive with dataProcessRegion updates: failoverRegions and dataProcessRegion cannot both be changed in the same apply. Apply each change in a separate operation.
    hostnames string[]
    List that contains the hostnames assigned to the stream workspace.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    streamConfig StreamWorkspaceStreamConfig
    Configuration options for an Atlas Stream Processing Instance. See stream config.
    workspaceName string
    Label that identifies the stream workspace.
    data_process_region StreamWorkspaceDataProcessRegionArgs
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    failover_regions Sequence[StreamWorkspaceFailoverRegionArgs]
    List of cloud provider regions to which the workspace can fail over if the primary region becomes unavailable. See failover regions. Write-once: once set, failoverRegions cannot be changed in-place — any modification forces the workspace to be destroyed and recreated. Mutually exclusive with dataProcessRegion updates: failoverRegions and dataProcessRegion cannot both be changed in the same apply. Apply each change in a separate operation.
    hostnames Sequence[str]
    List that contains the hostnames assigned to the stream workspace.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    stream_config StreamWorkspaceStreamConfigArgs
    Configuration options for an Atlas Stream Processing Instance. See stream config.
    workspace_name str
    Label that identifies the stream workspace.
    dataProcessRegion Property Map
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    failoverRegions List<Property Map>
    List of cloud provider regions to which the workspace can fail over if the primary region becomes unavailable. See failover regions. Write-once: once set, failoverRegions cannot be changed in-place — any modification forces the workspace to be destroyed and recreated. Mutually exclusive with dataProcessRegion updates: failoverRegions and dataProcessRegion cannot both be changed in the same apply. Apply each change in a separate operation.
    hostnames List<String>
    List that contains the hostnames assigned to the stream workspace.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    streamConfig Property Map
    Configuration options for an Atlas Stream Processing Instance. See stream config.
    workspaceName String
    Label that identifies the stream workspace.

    Supporting Types

    StreamWorkspaceDataProcessRegion, StreamWorkspaceDataProcessRegionArgs

    CloudProvider string
    Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The MongoDB Atlas API describes the valid values.
    Region string
    Name of the cloud provider region hosting Atlas Stream Processing. The MongoDB Atlas API describes the valid values.
    CloudProvider string
    Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The MongoDB Atlas API describes the valid values.
    Region string
    Name of the cloud provider region hosting Atlas Stream Processing. The MongoDB Atlas API describes the valid values.
    cloud_provider string
    Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The MongoDB Atlas API describes the valid values.
    region string
    Name of the cloud provider region hosting Atlas Stream Processing. The MongoDB Atlas API describes the valid values.
    cloudProvider String
    Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The MongoDB Atlas API describes the valid values.
    region String
    Name of the cloud provider region hosting Atlas Stream Processing. The MongoDB Atlas API describes the valid values.
    cloudProvider string
    Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The MongoDB Atlas API describes the valid values.
    region string
    Name of the cloud provider region hosting Atlas Stream Processing. The MongoDB Atlas API describes the valid values.
    cloud_provider str
    Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The MongoDB Atlas API describes the valid values.
    region str
    Name of the cloud provider region hosting Atlas Stream Processing. The MongoDB Atlas API describes the valid values.
    cloudProvider String
    Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The MongoDB Atlas API describes the valid values.
    region String
    Name of the cloud provider region hosting Atlas Stream Processing. The MongoDB Atlas API describes the valid values.

    StreamWorkspaceFailoverRegion, StreamWorkspaceFailoverRegionArgs

    CloudProvider string
    Cloud service provider for the failover region. Must match the primary region's cloud provider.
    Region string
    Name of the failover cloud provider region.
    CloudProvider string
    Cloud service provider for the failover region. Must match the primary region's cloud provider.
    Region string
    Name of the failover cloud provider region.
    cloud_provider string
    Cloud service provider for the failover region. Must match the primary region's cloud provider.
    region string
    Name of the failover cloud provider region.
    cloudProvider String
    Cloud service provider for the failover region. Must match the primary region's cloud provider.
    region String
    Name of the failover cloud provider region.
    cloudProvider string
    Cloud service provider for the failover region. Must match the primary region's cloud provider.
    region string
    Name of the failover cloud provider region.
    cloud_provider str
    Cloud service provider for the failover region. Must match the primary region's cloud provider.
    region str
    Name of the failover cloud provider region.
    cloudProvider String
    Cloud service provider for the failover region. Must match the primary region's cloud provider.
    region String
    Name of the failover cloud provider region.

    StreamWorkspaceStreamConfig, StreamWorkspaceStreamConfigArgs

    MaxTierSize string
    Max tier size for the Stream Workspace. Configures Memory / VCPU allowances.
    Tier string
    Selected tier for the Stream Workspace. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
    MaxTierSize string
    Max tier size for the Stream Workspace. Configures Memory / VCPU allowances.
    Tier string
    Selected tier for the Stream Workspace. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
    max_tier_size string
    Max tier size for the Stream Workspace. Configures Memory / VCPU allowances.
    tier string
    Selected tier for the Stream Workspace. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
    maxTierSize String
    Max tier size for the Stream Workspace. Configures Memory / VCPU allowances.
    tier String
    Selected tier for the Stream Workspace. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
    maxTierSize string
    Max tier size for the Stream Workspace. Configures Memory / VCPU allowances.
    tier string
    Selected tier for the Stream Workspace. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
    max_tier_size str
    Max tier size for the Stream Workspace. Configures Memory / VCPU allowances.
    tier str
    Selected tier for the Stream Workspace. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
    maxTierSize String
    Max tier size for the Stream Workspace. Configures Memory / VCPU allowances.
    tier String
    Selected tier for the Stream Workspace. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.

    Import

    You can import stream workspace resource using the project ID and workspace name, in the format PROJECT_ID-WORKSPACE_NAME. For example:

    $ pulumi import mongodbatlas:index/streamWorkspace:StreamWorkspace test 650972848269185c55f40ca1-WorkspaceName

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    Viewing docs for MongoDB Atlas v4.13.0
    published on Thursday, Jul 30, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-mongodbatlas

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial