Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getStreamInstances
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getStreamInstances

Explore with Pulumi AI

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

# Data Source: mongodbatlas.getStreamInstances

mongodbatlas.getStreamInstances describes the stream instances defined in a project.

Example Usage

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

const test = mongodbatlas.getStreamInstances({
    projectId: "<PROJECT_ID>",
});
Copy
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.get_stream_instances(project_id="<PROJECT_ID>")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodbatlas.LookupStreamInstances(ctx, &mongodbatlas.LookupStreamInstancesArgs{
			ProjectId: "<PROJECT_ID>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var test = Mongodbatlas.GetStreamInstances.Invoke(new()
    {
        ProjectId = "<PROJECT_ID>",
    });

});
Copy
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.GetStreamInstancesArgs;
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.getStreamInstances(GetStreamInstancesArgs.builder()
            .projectId("<PROJECT_ID>")
            .build());

    }
}
Copy
variables:
  test:
    fn::invoke:
      function: mongodbatlas:getStreamInstances
      arguments:
        projectId: <PROJECT_ID>
Copy

Using getStreamInstances

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 getStreamInstances(args: GetStreamInstancesArgs, opts?: InvokeOptions): Promise<GetStreamInstancesResult>
function getStreamInstancesOutput(args: GetStreamInstancesOutputArgs, opts?: InvokeOptions): Output<GetStreamInstancesResult>
Copy
def get_stream_instances(items_per_page: Optional[int] = None,
                         page_num: Optional[int] = None,
                         project_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetStreamInstancesResult
def get_stream_instances_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[GetStreamInstancesResult]
Copy
func LookupStreamInstances(ctx *Context, args *LookupStreamInstancesArgs, opts ...InvokeOption) (*LookupStreamInstancesResult, error)
func LookupStreamInstancesOutput(ctx *Context, args *LookupStreamInstancesOutputArgs, opts ...InvokeOption) LookupStreamInstancesResultOutput
Copy

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

public static class GetStreamInstances 
{
    public static Task<GetStreamInstancesResult> InvokeAsync(GetStreamInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamInstancesResult> Invoke(GetStreamInstancesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetStreamInstancesResult> getStreamInstances(GetStreamInstancesArgs args, InvokeOptions options)
public static Output<GetStreamInstancesResult> getStreamInstances(GetStreamInstancesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: mongodbatlas:index/getStreamInstances:getStreamInstances
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ProjectId This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.

getStreamInstances Result

The following output properties are available:

Id string
ProjectId string
Unique 24-hexadecimal digit string that identifies your project.
Results List<GetStreamInstancesResult>
A list where each element contains a Stream Instance.
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
ProjectId string
Unique 24-hexadecimal digit string that identifies your project.
Results []GetStreamInstancesResult
A list where each element contains a Stream Instance.
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
projectId String
Unique 24-hexadecimal digit string that identifies your project.
results List<GetStreamInstancesResult>
A list where each element contains a Stream Instance.
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
projectId string
Unique 24-hexadecimal digit string that identifies your project.
results GetStreamInstancesResult[]
A list where each element contains a Stream Instance.
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
project_id str
Unique 24-hexadecimal digit string that identifies your project.
results Sequence[GetStreamInstancesResult]
A list where each element contains a Stream Instance.
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
projectId String
Unique 24-hexadecimal digit string that identifies your project.
results List<Property Map>
A list where each element contains a Stream Instance.
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

GetStreamInstancesResult

DataProcessRegion This property is required. GetStreamInstancesResultDataProcessRegion
Defines the cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
Hostnames This property is required. List<string>
List that contains the hostnames assigned to the stream instance.
Id This property is required. string
InstanceName This property is required. string
Human-readable label that identifies the stream instance.
ProjectId This property is required. string
Unique 24-hexadecimal digit string that identifies your project.
StreamConfig This property is required. GetStreamInstancesResultStreamConfig
Defines the configuration options for an Atlas Stream Processing Instance. See stream config
DataProcessRegion This property is required. GetStreamInstancesResultDataProcessRegion
Defines the cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
Hostnames This property is required. []string
List that contains the hostnames assigned to the stream instance.
Id This property is required. string
InstanceName This property is required. string
Human-readable label that identifies the stream instance.
ProjectId This property is required. string
Unique 24-hexadecimal digit string that identifies your project.
StreamConfig This property is required. GetStreamInstancesResultStreamConfig
Defines the configuration options for an Atlas Stream Processing Instance. See stream config
dataProcessRegion This property is required. GetStreamInstancesResultDataProcessRegion
Defines the cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
hostnames This property is required. List<String>
List that contains the hostnames assigned to the stream instance.
id This property is required. String
instanceName This property is required. String
Human-readable label that identifies the stream instance.
projectId This property is required. String
Unique 24-hexadecimal digit string that identifies your project.
streamConfig This property is required. GetStreamInstancesResultStreamConfig
Defines the configuration options for an Atlas Stream Processing Instance. See stream config
dataProcessRegion This property is required. GetStreamInstancesResultDataProcessRegion
Defines the cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
hostnames This property is required. string[]
List that contains the hostnames assigned to the stream instance.
id This property is required. string
instanceName This property is required. string
Human-readable label that identifies the stream instance.
projectId This property is required. string
Unique 24-hexadecimal digit string that identifies your project.
streamConfig This property is required. GetStreamInstancesResultStreamConfig
Defines the configuration options for an Atlas Stream Processing Instance. See stream config
data_process_region This property is required. GetStreamInstancesResultDataProcessRegion
Defines the cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
hostnames This property is required. Sequence[str]
List that contains the hostnames assigned to the stream instance.
id This property is required. str
instance_name This property is required. str
Human-readable label that identifies the stream instance.
project_id This property is required. str
Unique 24-hexadecimal digit string that identifies your project.
stream_config This property is required. GetStreamInstancesResultStreamConfig
Defines the configuration options for an Atlas Stream Processing Instance. See stream config
dataProcessRegion This property is required. Property Map
Defines the cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
hostnames This property is required. List<String>
List that contains the hostnames assigned to the stream instance.
id This property is required. String
instanceName This property is required. String
Human-readable label that identifies the stream instance.
projectId This property is required. String
Unique 24-hexadecimal digit string that identifies your project.
streamConfig This property is required. Property Map
Defines the configuration options for an Atlas Stream Processing Instance. See stream config

GetStreamInstancesResultDataProcessRegion

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

GetStreamInstancesResultStreamConfig

Tier This property is required. string
Selected tier for the Stream Instance. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
Tier This property is required. string
Selected tier for the Stream Instance. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
tier This property is required. String
Selected tier for the Stream Instance. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
tier This property is required. string
Selected tier for the Stream Instance. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
tier This property is required. str
Selected tier for the Stream Instance. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
tier This property is required. 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 v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas