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

mongodbatlas.getStreamWorkspaces

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

    mongodbatlas.getStreamWorkspaces describes the stream workspaces defined in a project.

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

    Example Usage

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

const test = mongodbatlas.getStreamWorkspaces({
    projectId: "<PROJECT_ID>",
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.get_stream_workspaces(project_id="<PROJECT_ID>")

    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.LookupStreamWorkspaces(ctx, &mongodbatlas.LookupStreamWorkspacesArgs{
			ProjectId: "<PROJECT_ID>",
		}, 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 test = Mongodbatlas.GetStreamWorkspaces.Invoke(new()
    {
        ProjectId = "<PROJECT_ID>",
    });

});

    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.GetStreamWorkspacesArgs;
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 test = MongodbatlasFunctions.getStreamWorkspaces(GetStreamWorkspacesArgs.builder()
            .projectId("<PROJECT_ID>")
            .build());

    }
}

    variables:
  test:
    fn::invoke:
      function: mongodbatlas:getStreamWorkspaces
      arguments:
        projectId: <PROJECT_ID>

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

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

    Using getStreamWorkspaces

    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 getStreamWorkspaces(args: GetStreamWorkspacesArgs, opts?: InvokeOptions): Promise<GetStreamWorkspacesResult>
function getStreamWorkspacesOutput(args: GetStreamWorkspacesOutputArgs, opts?: InvokeOptions): Output<GetStreamWorkspacesResult>
    def get_stream_workspaces(items_per_page: Optional[int] = None,
                          page_num: Optional[int] = None,
                          project_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetStreamWorkspacesResult
def get_stream_workspaces_output(items_per_page: Optional[pulumi.Input[int]] = None,
                          page_num: Optional[pulumi.Input[int]] = None,
                          project_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetStreamWorkspacesResult]
    func LookupStreamWorkspaces(ctx *Context, args *LookupStreamWorkspacesArgs, opts ...InvokeOption) (*LookupStreamWorkspacesResult, error)
func LookupStreamWorkspacesOutput(ctx *Context, args *LookupStreamWorkspacesOutputArgs, opts ...InvokeOption) LookupStreamWorkspacesResultOutput

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

    public static class GetStreamWorkspaces 
{
    public static Task<GetStreamWorkspacesResult> InvokeAsync(GetStreamWorkspacesArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamWorkspacesResult> Invoke(GetStreamWorkspacesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetStreamWorkspacesResult> getStreamWorkspaces(GetStreamWorkspacesArgs args, InvokeOptions options)
public static Output<GetStreamWorkspacesResult> getStreamWorkspaces(GetStreamWorkspacesArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    ItemsPerPage int
    Number of items that the response returns per page, up to a maximum of 500. Defaults to 100.
    PageNum int
    Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    ItemsPerPage int
    Number of items that the response returns per page, up to a maximum of 500. Defaults to 100.
    PageNum int
    Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    itemsPerPage Integer
    Number of items that the response returns per page, up to a maximum of 500. Defaults to 100.
    pageNum Integer
    Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project.
    itemsPerPage number
    Number of items that the response returns per page, up to a maximum of 500. Defaults to 100.
    pageNum number
    Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project.
    items_per_page int
    Number of items that the response returns per page, up to a maximum of 500. Defaults to 100.
    page_num int
    Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    itemsPerPage Number
    Number of items that the response returns per page, up to a maximum of 500. Defaults to 100.
    pageNum Number
    Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.

    getStreamWorkspaces Result

    The following output properties are available:

    Id string

    Deprecated: This parameter is deprecated.

    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    Results List<GetStreamWorkspacesResult>
    A list where each element contains a Stream Workspace.
    TotalCount int
    Count of the total number of items in the result set. The count might be greater than the number of objects in the results array if the entire result set is paginated.
    ItemsPerPage int
    PageNum int
    Id string

    Deprecated: This parameter is deprecated.

    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    Results []GetStreamWorkspacesResult
    A list where each element contains a Stream Workspace.
    TotalCount int
    Count of the total number of items in the result set. The count might be greater than the number of objects in the results array if the entire result set is paginated.
    ItemsPerPage int
    PageNum int
    id String

    Deprecated: This parameter is deprecated.

    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    results List<GetStreamWorkspacesResult>
    A list where each element contains a Stream Workspace.
    totalCount Integer
    Count of the total number of items in the result set. The count might be greater than the number of objects in the results array if the entire result set is paginated.
    itemsPerPage Integer
    pageNum Integer
    id string

    Deprecated: This parameter is deprecated.

    projectId string
    Unique 24-hexadecimal digit string that identifies your project.
    results GetStreamWorkspacesResult[]
    A list where each element contains a Stream Workspace.
    totalCount number
    Count of the total number of items in the result set. The count might be greater than the number of objects in the results array if the entire result set is paginated.
    itemsPerPage number
    pageNum number
    id str

    Deprecated: This parameter is deprecated.

    project_id str
    Unique 24-hexadecimal digit string that identifies your project.
    results Sequence[GetStreamWorkspacesResult]
    A list where each element contains a Stream Workspace.
    total_count int
    Count of the total number of items in the result set. The count might be greater than the number of objects in the results array if the entire result set is paginated.
    items_per_page int
    page_num int
    id String

    Deprecated: This parameter is deprecated.

    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    results List<Property Map>
    A list where each element contains a Stream Workspace.
    totalCount Number
    Count of the total number of items in the result set. The count might be greater than the number of objects in the results array if the entire result set is paginated.
    itemsPerPage Number
    pageNum Number

    Supporting Types

    GetStreamWorkspacesResult

    DataProcessRegion GetStreamWorkspacesResultDataProcessRegion
    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
    Unique 24-hexadecimal digit string that identifies your project.
    StreamConfig GetStreamWorkspacesResultStreamConfig
    Defines the configuration options for an Atlas Stream Processing Instance. See stream config
    WorkspaceName string
    Label that identifies the stream workspace.
    DataProcessRegion GetStreamWorkspacesResultDataProcessRegion
    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
    Unique 24-hexadecimal digit string that identifies your project.
    StreamConfig GetStreamWorkspacesResultStreamConfig
    Defines the configuration options for an Atlas Stream Processing Instance. See stream config
    WorkspaceName string
    Label that identifies the stream workspace.
    dataProcessRegion GetStreamWorkspacesResultDataProcessRegion
    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
    Unique 24-hexadecimal digit string that identifies your project.
    streamConfig GetStreamWorkspacesResultStreamConfig
    Defines the configuration options for an Atlas Stream Processing Instance. See stream config
    workspaceName String
    Label that identifies the stream workspace.
    dataProcessRegion GetStreamWorkspacesResultDataProcessRegion
    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
    Unique 24-hexadecimal digit string that identifies your project.
    streamConfig GetStreamWorkspacesResultStreamConfig
    Defines the configuration options for an Atlas Stream Processing Instance. See stream config
    workspaceName string
    Label that identifies the stream workspace.
    data_process_region GetStreamWorkspacesResultDataProcessRegion
    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
    Unique 24-hexadecimal digit string that identifies your project.
    stream_config GetStreamWorkspacesResultStreamConfig
    Defines the configuration options for an Atlas Stream Processing Instance. See stream config
    workspace_name str
    Label that identifies the stream workspace.
    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
    Unique 24-hexadecimal digit string that identifies your project.
    streamConfig Property Map
    Defines the configuration options for an Atlas Stream Processing Instance. See stream config
    workspaceName String
    Label that identifies the stream workspace.

    GetStreamWorkspacesResultDataProcessRegion

    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.

    GetStreamWorkspacesResultStreamConfig

    MaxTierSize string
    Tier string
    Selected tier for the Stream Workspace. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
    MaxTierSize string
    Tier string
    Selected tier for the Stream Workspace. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
    maxTierSize String
    tier String
    Selected tier for the Stream Workspace. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
    maxTierSize string
    tier string
    Selected tier for the Stream Workspace. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
    max_tier_size str
    tier str
    Selected tier for the Stream Workspace. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
    maxTierSize String
    tier String
    Selected tier for the Stream Workspace. 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