mongodbatlas.getStreamInstance

MongoDB Atlas v4.2.0, Jan 23 26

MongoDB Atlas v4.2.0 published on Friday, Jan 23, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-mongodbatlas

MongoDB Atlas v4.2.0 published on Friday, Jan 23, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-mongodbatlas

Migration to<span pulumi-lang-nodejs=" streamWorkspace

" pulumi-lang-dotnet=" StreamWorkspace " pulumi-lang-go=" streamWorkspace " pulumi-lang-python=" stream_workspace " pulumi-lang-yaml=" streamWorkspace " pulumi-lang-java=" streamWorkspace “> stream_workspace To migrate from mongodbatlas.StreamInstance to mongodbatlas.StreamWorkspace, update your data source configuration. See Migration Guide: Stream Instance to Stream Workspace for step-by-step instructions and examples:

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

// New (recommended)
const example = mongodbatlas.getStreamWorkspace({
    projectId: "<PROJECT_ID>",
    workspaceName: "<WORKSPACE_NAME>",
});
// Old (deprecated)
const exampleGetStreamInstance = mongodbatlas.getStreamInstance({
    projectId: "<PROJECT_ID>",
    instanceName: "<INSTANCE_NAME>",
});

import pulumi
import pulumi_mongodbatlas as mongodbatlas

# New (recommended)
example = mongodbatlas.get_stream_workspace(project_id="<PROJECT_ID>",
    workspace_name="<WORKSPACE_NAME>")
# Old (deprecated)
example_get_stream_instance = mongodbatlas.get_stream_instance(project_id="<PROJECT_ID>",
    instance_name="<INSTANCE_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 {
		// New (recommended)
		_, err := mongodbatlas.LookupStreamWorkspace(ctx, &mongodbatlas.LookupStreamWorkspaceArgs{
			ProjectId:     "<PROJECT_ID>",
			WorkspaceName: "<WORKSPACE_NAME>",
		}, nil)
		if err != nil {
			return err
		}
		// Old (deprecated)
		_, err = mongodbatlas.LookupStreamInstance(ctx, &mongodbatlas.LookupStreamInstanceArgs{
			ProjectId:    "<PROJECT_ID>",
			InstanceName: "<INSTANCE_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(() => 
{
    // New (recommended)
    var example = Mongodbatlas.GetStreamWorkspace.Invoke(new()
    {
        ProjectId = "<PROJECT_ID>",
        WorkspaceName = "<WORKSPACE_NAME>",
    });

    // Old (deprecated)
    var exampleGetStreamInstance = Mongodbatlas.GetStreamInstance.Invoke(new()
    {
        ProjectId = "<PROJECT_ID>",
        InstanceName = "<INSTANCE_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 com.pulumi.mongodbatlas.inputs.GetStreamInstanceArgs;
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) {
        // New (recommended)
        final var example = MongodbatlasFunctions.getStreamWorkspace(GetStreamWorkspaceArgs.builder()
            .projectId("<PROJECT_ID>")
            .workspaceName("<WORKSPACE_NAME>")
            .build());

        // Old (deprecated)
        final var exampleGetStreamInstance = MongodbatlasFunctions.getStreamInstance(GetStreamInstanceArgs.builder()
            .projectId("<PROJECT_ID>")
            .instanceName("<INSTANCE_NAME>")
            .build());

    }
}

variables:
  # New (recommended)
  example:
    fn::invoke:
      function: mongodbatlas:getStreamWorkspace
      arguments:
        projectId: <PROJECT_ID>
        workspaceName: <WORKSPACE_NAME>
  # Old (deprecated)
  exampleGetStreamInstance:
    fn::invoke:
      function: mongodbatlas:getStreamInstance
      arguments:
        projectId: <PROJECT_ID>
        instanceName: <INSTANCE_NAME>

Example Usage

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

const example = mongodbatlas.getStreamInstance({
    projectId: "<PROJECT_ID>",
    instanceName: "<INSTANCE_NAME>",
});

import pulumi
import pulumi_mongodbatlas as mongodbatlas

example = mongodbatlas.get_stream_instance(project_id="<PROJECT_ID>",
    instance_name="<INSTANCE_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.LookupStreamInstance(ctx, &mongodbatlas.LookupStreamInstanceArgs{
			ProjectId:    "<PROJECT_ID>",
			InstanceName: "<INSTANCE_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.GetStreamInstance.Invoke(new()
    {
        ProjectId = "<PROJECT_ID>",
        InstanceName = "<INSTANCE_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.GetStreamInstanceArgs;
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.getStreamInstance(GetStreamInstanceArgs.builder()
            .projectId("<PROJECT_ID>")
            .instanceName("<INSTANCE_NAME>")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: mongodbatlas:getStreamInstance
      arguments:
        projectId: <PROJECT_ID>
        instanceName: <INSTANCE_NAME>

Using getStreamInstance

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 getStreamInstance(args: GetStreamInstanceArgs, opts?: InvokeOptions): Promise<GetStreamInstanceResult>
function getStreamInstanceOutput(args: GetStreamInstanceOutputArgs, opts?: InvokeOptions): Output<GetStreamInstanceResult>

def get_stream_instance(instance_name: Optional[str] = None,
                        project_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetStreamInstanceResult
def get_stream_instance_output(instance_name: Optional[pulumi.Input[str]] = None,
                        project_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetStreamInstanceResult]

func LookupStreamInstance(ctx *Context, args *LookupStreamInstanceArgs, opts ...InvokeOption) (*LookupStreamInstanceResult, error)
func LookupStreamInstanceOutput(ctx *Context, args *LookupStreamInstanceOutputArgs, opts ...InvokeOption) LookupStreamInstanceResultOutput

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

public static class GetStreamInstance 
{
    public static Task<GetStreamInstanceResult> InvokeAsync(GetStreamInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamInstanceResult> Invoke(GetStreamInstanceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetStreamInstanceResult> getStreamInstance(GetStreamInstanceArgs args, InvokeOptions options)
public static Output<GetStreamInstanceResult> getStreamInstance(GetStreamInstanceArgs args, InvokeOptions options)

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

The following arguments are supported:

InstanceName string: Human-readable label that identifies the stream instance.
ProjectId string: Unique 24-hexadecimal digit string that identifies your project.

InstanceName string: Human-readable label that identifies the stream instance.
ProjectId string: Unique 24-hexadecimal digit string that identifies your project.

instanceName String: Human-readable label that identifies the stream instance.
projectId String: Unique 24-hexadecimal digit string that identifies your project.

instanceName string: Human-readable label that identifies the stream instance.
projectId string: Unique 24-hexadecimal digit string that identifies your project.

instance_name str: Human-readable label that identifies the stream instance.
project_id str: Unique 24-hexadecimal digit string that identifies your project.

instanceName String: Human-readable label that identifies the stream instance.
projectId String: Unique 24-hexadecimal digit string that identifies your project.

getStreamInstance Result

The following output properties are available:

DataProcessRegion GetStreamInstanceDataProcessRegion: 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 instance.
Id string
InstanceName string
ProjectId string
StreamConfig GetStreamInstanceStreamConfig: Defines the configuration options for an Atlas Stream Processing Instance. See stream config

DataProcessRegion GetStreamInstanceDataProcessRegion: 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 instance.
Id string
InstanceName string
ProjectId string
StreamConfig GetStreamInstanceStreamConfig: Defines the configuration options for an Atlas Stream Processing Instance. See stream config

dataProcessRegion GetStreamInstanceDataProcessRegion: 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 instance.
id String
instanceName String
projectId String
streamConfig GetStreamInstanceStreamConfig: Defines the configuration options for an Atlas Stream Processing Instance. See stream config

dataProcessRegion GetStreamInstanceDataProcessRegion: 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 instance.
id string
instanceName string
projectId string
streamConfig GetStreamInstanceStreamConfig: Defines the configuration options for an Atlas Stream Processing Instance. See stream config

data_process_region GetStreamInstanceDataProcessRegion: 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 instance.
id str
instance_name str
project_id str
stream_config GetStreamInstanceStreamConfig: Defines the configuration options for an Atlas Stream Processing Instance. See stream config

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 instance.
id String
instanceName String
projectId String
streamConfig Property Map: Defines the configuration options for an Atlas Stream Processing Instance. See stream config

Supporting Types

GetStreamInstanceDataProcessRegion

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.

GetStreamInstanceStreamConfig

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.

MongoDB Atlas v4.2.0 published on Friday, Jan 23, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-mongodbatlas

mongodbatlas.getStreamInstance

On this page

On this page

Migration to<span pulumi-lang-nodejs=" streamWorkspace

Example Usage

Using getStreamInstance

getStreamInstance Result

Supporting Types

GetStreamInstanceDataProcessRegion

GetStreamInstanceStreamConfig

Package Details

On this page

On this page