1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getStreamWorkspace
MongoDB Atlas v4.0.0 published on Tuesday, Dec 30, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

mongodbatlas.getStreamWorkspace

mongodbatlas logo
MongoDB Atlas v4.0.0 published on Tuesday, Dec 30, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

    mongodbatlas.StreamWorkspace describes a stream workspace that contains configurations for stream processing.

    NOTE: Use this data source for new configurations instead of mongodbatlas.StreamInstance.

    Example Usage

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

const example = mongodbatlas.getStreamWorkspace({
    projectId: "<PROJECT_ID>",
    workspaceName: "<WORKSPACE_NAME>",
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

example = mongodbatlas.get_stream_workspace(project_id="<PROJECT_ID>",
    workspace_name="<WORKSPACE_NAME>")

    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.LookupStreamWorkspace(ctx, &mongodbatlas.LookupStreamWorkspaceArgs{
			ProjectId:     "<PROJECT_ID>",
			WorkspaceName: "<WORKSPACE_NAME>",
		}, nil)
		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 = Mongodbatlas.GetStreamWorkspace.Invoke(new()
    {
        ProjectId = "<PROJECT_ID>",
        WorkspaceName = "<WORKSPACE_NAME>",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetStreamWorkspaceArgs;
import java.util.List;
import java.util.ArrayList;
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) {
        final var example = MongodbatlasFunctions.getStreamWorkspace(GetStreamWorkspaceArgs.builder()
            .projectId("<PROJECT_ID>")
            .workspaceName("<WORKSPACE_NAME>")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: mongodbatlas:getStreamWorkspace
      arguments:
        projectId: <PROJECT_ID>
        workspaceName: <WORKSPACE_NAME>

    Migration from<span pulumi-lang-nodejs=" streamInstance

    " pulumi-lang-dotnet=" StreamInstance " pulumi-lang-go=" streamInstance " pulumi-lang-python=" stream_instance " pulumi-lang-yaml=" streamInstance " pulumi-lang-java=" streamInstance “> stream_instance If you’re migrating from the deprecated mongodbatlas.StreamInstance data source, see the Migration Guide: Stream Instance to Stream Workspace for step-by-step instructions and examples.

    Using getStreamWorkspace

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getStreamWorkspace(args: GetStreamWorkspaceArgs, opts?: InvokeOptions): Promise<GetStreamWorkspaceResult>
function getStreamWorkspaceOutput(args: GetStreamWorkspaceOutputArgs, opts?: InvokeOptions): Output<GetStreamWorkspaceResult>
    def get_stream_workspace(project_id: Optional[str] = None,
                         workspace_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetStreamWorkspaceResult
def get_stream_workspace_output(project_id: Optional[pulumi.Input[str]] = None,
                         workspace_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetStreamWorkspaceResult]
    func LookupStreamWorkspace(ctx *Context, args *LookupStreamWorkspaceArgs, opts ...InvokeOption) (*LookupStreamWorkspaceResult, error)
func LookupStreamWorkspaceOutput(ctx *Context, args *LookupStreamWorkspaceOutputArgs, opts ...InvokeOption) LookupStreamWorkspaceResultOutput

    > Note: This function is named LookupStreamWorkspace in the Go SDK.

    public static class GetStreamWorkspace 
{
    public static Task<GetStreamWorkspaceResult> InvokeAsync(GetStreamWorkspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamWorkspaceResult> Invoke(GetStreamWorkspaceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetStreamWorkspaceResult> getStreamWorkspace(GetStreamWorkspaceArgs args, InvokeOptions options)
public static Output<GetStreamWorkspaceResult> getStreamWorkspace(GetStreamWorkspaceArgs args, InvokeOptions options)

    fn::invoke:
  function: mongodbatlas:index/getStreamWorkspace:getStreamWorkspace
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    WorkspaceName string
    Label that identifies the stream workspace.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    WorkspaceName string
    Label that identifies the stream workspace.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    workspaceName String
    Label that identifies the stream workspace.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project.
    workspaceName string
    Label that identifies the stream workspace.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project.
    workspace_name str
    Label that identifies the stream workspace.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    workspaceName String
    Label that identifies the stream workspace.

    getStreamWorkspace Result

    The following output properties are available:

    DataProcessRegion GetStreamWorkspaceDataProcessRegion
    Defines the cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    Hostnames List<string>
    List that contains the hostnames assigned to the stream workspace.
    Id string
    ProjectId string
    StreamConfig GetStreamWorkspaceStreamConfig
    Defines the configuration options for an Atlas Stream Processing Instance. See stream config
    WorkspaceName string
    DataProcessRegion GetStreamWorkspaceDataProcessRegion
    Defines the cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    Hostnames []string
    List that contains the hostnames assigned to the stream workspace.
    Id string
    ProjectId string
    StreamConfig GetStreamWorkspaceStreamConfig
    Defines the configuration options for an Atlas Stream Processing Instance. See stream config
    WorkspaceName string
    dataProcessRegion GetStreamWorkspaceDataProcessRegion
    Defines the cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    hostnames List<String>
    List that contains the hostnames assigned to the stream workspace.
    id String
    projectId String
    streamConfig GetStreamWorkspaceStreamConfig
    Defines the configuration options for an Atlas Stream Processing Instance. See stream config
    workspaceName String
    dataProcessRegion GetStreamWorkspaceDataProcessRegion
    Defines the cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    hostnames string[]
    List that contains the hostnames assigned to the stream workspace.
    id string
    projectId string
    streamConfig GetStreamWorkspaceStreamConfig
    Defines the configuration options for an Atlas Stream Processing Instance. See stream config
    workspaceName string
    data_process_region GetStreamWorkspaceDataProcessRegion
    Defines the cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    hostnames Sequence[str]
    List that contains the hostnames assigned to the stream workspace.
    id str
    project_id str
    stream_config GetStreamWorkspaceStreamConfig
    Defines the configuration options for an Atlas Stream Processing Instance. See stream config
    workspace_name str
    dataProcessRegion Property Map
    Defines the cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    hostnames List<String>
    List that contains the hostnames assigned to the stream workspace.
    id String
    projectId String
    streamConfig Property Map
    Defines the configuration options for an Atlas Stream Processing Instance. See stream config
    workspaceName String

    Supporting Types

    GetStreamWorkspaceDataProcessRegion

    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.
    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.

    GetStreamWorkspaceStreamConfig

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

    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
    MongoDB Atlas v4.0.0 published on Tuesday, Dec 30, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-mongodbatlas
      Meet Neo: Your AI Platform Teammate