MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
mongodbatlas.getStreamConnections
Explore with Pulumi AI
# Data Source: mongodbatlas.getStreamConnections
mongodbatlas.getStreamConnections describes all connections of a stream instance for the specified project.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const test = mongodbatlas.getStreamConnections({
    projectId: "<PROJECT_ID>",
    instanceName: "<INSTANCE_NAME>",
});
import pulumi
import pulumi_mongodbatlas as mongodbatlas
test = mongodbatlas.get_stream_connections(project_id="<PROJECT_ID>",
    instance_name="<INSTANCE_NAME>")
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.LookupStreamConnections(ctx, &mongodbatlas.LookupStreamConnectionsArgs{
			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 test = Mongodbatlas.GetStreamConnections.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.GetStreamConnectionsArgs;
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.getStreamConnections(GetStreamConnectionsArgs.builder()
            .projectId("<PROJECT_ID>")
            .instanceName("<INSTANCE_NAME>")
            .build());
    }
}
variables:
  test:
    fn::invoke:
      function: mongodbatlas:getStreamConnections
      arguments:
        projectId: <PROJECT_ID>
        instanceName: <INSTANCE_NAME>
Using getStreamConnections
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 getStreamConnections(args: GetStreamConnectionsArgs, opts?: InvokeOptions): Promise<GetStreamConnectionsResult>
function getStreamConnectionsOutput(args: GetStreamConnectionsOutputArgs, opts?: InvokeOptions): Output<GetStreamConnectionsResult>def get_stream_connections(instance_name: Optional[str] = None,
                           items_per_page: Optional[int] = None,
                           page_num: Optional[int] = None,
                           project_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetStreamConnectionsResult
def get_stream_connections_output(instance_name: Optional[pulumi.Input[str]] = None,
                           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[GetStreamConnectionsResult]func LookupStreamConnections(ctx *Context, args *LookupStreamConnectionsArgs, opts ...InvokeOption) (*LookupStreamConnectionsResult, error)
func LookupStreamConnectionsOutput(ctx *Context, args *LookupStreamConnectionsOutputArgs, opts ...InvokeOption) LookupStreamConnectionsResultOutput> Note: This function is named LookupStreamConnections in the Go SDK.
public static class GetStreamConnections 
{
    public static Task<GetStreamConnectionsResult> InvokeAsync(GetStreamConnectionsArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamConnectionsResult> Invoke(GetStreamConnectionsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetStreamConnectionsResult> getStreamConnections(GetStreamConnectionsArgs args, InvokeOptions options)
public static Output<GetStreamConnectionsResult> getStreamConnections(GetStreamConnectionsArgs args, InvokeOptions options)
fn::invoke:
  function: mongodbatlas:index/getStreamConnections:getStreamConnections
  arguments:
    # arguments dictionaryThe 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.
- ItemsPer intPage 
- Number of items that the response returns per page, up to a maximum of 500. Defaults to100.
- PageNum int
- Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
- InstanceName string
- Human-readable label that identifies the stream instance.
- ProjectId string
- Unique 24-hexadecimal digit string that identifies your project.
- ItemsPer intPage 
- Number of items that the response returns per page, up to a maximum of 500. Defaults to100.
- PageNum int
- Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
- instanceName String
- Human-readable label that identifies the stream instance.
- projectId String
- Unique 24-hexadecimal digit string that identifies your project.
- itemsPer IntegerPage 
- Number of items that the response returns per page, up to a maximum of 500. Defaults to100.
- pageNum Integer
- Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
- instanceName string
- Human-readable label that identifies the stream instance.
- projectId string
- Unique 24-hexadecimal digit string that identifies your project.
- itemsPer numberPage 
- Number of items that the response returns per page, up to a maximum of 500. Defaults to100.
- pageNum number
- Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
- instance_name str
- Human-readable label that identifies the stream instance.
- project_id str
- Unique 24-hexadecimal digit string that identifies your project.
- items_per_ intpage 
- Number of items that the response returns per page, up to a maximum of 500. Defaults to100.
- page_num int
- Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
- instanceName String
- Human-readable label that identifies the stream instance.
- projectId String
- Unique 24-hexadecimal digit string that identifies your project.
- itemsPer NumberPage 
- Number of items that the response returns per page, up to a maximum of 500. Defaults to100.
- pageNum Number
- Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
getStreamConnections Result
The following output properties are available:
- Id string
- InstanceName string
- Human-readable label that identifies the stream instance.
- ProjectId string
- Unique 24-hexadecimal digit string that identifies your project.
- Results
List<GetStream Connections Result> 
- A list where each element contains a stream connection.
- 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.
- ItemsPer intPage 
- PageNum int
- Id string
- InstanceName string
- Human-readable label that identifies the stream instance.
- ProjectId string
- Unique 24-hexadecimal digit string that identifies your project.
- Results
[]GetStream Connections Result 
- A list where each element contains a stream connection.
- 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.
- ItemsPer intPage 
- PageNum int
- id String
- instanceName String
- Human-readable label that identifies the stream instance.
- projectId String
- Unique 24-hexadecimal digit string that identifies your project.
- results
List<GetStream Connections Result> 
- A list where each element contains a stream connection.
- 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.
- itemsPer IntegerPage 
- pageNum Integer
- id string
- instanceName string
- Human-readable label that identifies the stream instance.
- projectId string
- Unique 24-hexadecimal digit string that identifies your project.
- results
GetStream Connections Result[] 
- A list where each element contains a stream connection.
- 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.
- itemsPer numberPage 
- pageNum number
- id str
- instance_name str
- Human-readable label that identifies the stream instance.
- project_id str
- Unique 24-hexadecimal digit string that identifies your project.
- results
Sequence[GetStream Connections Result] 
- A list where each element contains a stream connection.
- 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_ intpage 
- page_num int
- id String
- instanceName String
- Human-readable label that identifies the stream instance.
- projectId String
- Unique 24-hexadecimal digit string that identifies your project.
- results List<Property Map>
- A list where each element contains a stream connection.
- 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.
- itemsPer NumberPage 
- pageNum Number
Supporting Types
GetStreamConnectionsResult   
- Authentication
GetStream Connections Result Authentication 
- User credentials required to connect to a Kafka cluster. Includes the authentication type, as well as the parameters for that authentication mode. See authentication.
- Aws
GetStream Connections Result Aws 
- The configuration for AWS Lambda connection. See AWS
- BootstrapServers string
- Comma separated list of server addresses.
- ClusterName string
- Name of the cluster configured for this connection.
- Config Dictionary<string, string>
- A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
- ConnectionName string
- Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
- DbRole GetTo Execute Stream Connections Result Db Role To Execute 
- The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See DBRoleToExecute.
- Headers Dictionary<string, string>
- A map of key-value pairs for optional headers.
- Id string
- InstanceName string
- Human-readable label that identifies the stream instance.
- Networking
GetStream Connections Result Networking 
- Networking Access Type can either be PUBLIC(default) orVPC. See networking.
- ProjectId string
- Unique 24-hexadecimal digit string that identifies your project.
- Security
GetStream Connections Result Security 
- Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. See security.
- Type string
- Selected networking type. Either PUBLIC,VPCorPRIVATE_LINK. Defaults toPUBLIC.
- Url string
- URL of the HTTPs endpoint that will be used for creating a connection.
- Authentication
GetStream Connections Result Authentication 
- User credentials required to connect to a Kafka cluster. Includes the authentication type, as well as the parameters for that authentication mode. See authentication.
- Aws
GetStream Connections Result Aws 
- The configuration for AWS Lambda connection. See AWS
- BootstrapServers string
- Comma separated list of server addresses.
- ClusterName string
- Name of the cluster configured for this connection.
- Config map[string]string
- A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
- ConnectionName string
- Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
- DbRole GetTo Execute Stream Connections Result Db Role To Execute 
- The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See DBRoleToExecute.
- Headers map[string]string
- A map of key-value pairs for optional headers.
- Id string
- InstanceName string
- Human-readable label that identifies the stream instance.
- Networking
GetStream Connections Result Networking 
- Networking Access Type can either be PUBLIC(default) orVPC. See networking.
- ProjectId string
- Unique 24-hexadecimal digit string that identifies your project.
- Security
GetStream Connections Result Security 
- Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. See security.
- Type string
- Selected networking type. Either PUBLIC,VPCorPRIVATE_LINK. Defaults toPUBLIC.
- Url string
- URL of the HTTPs endpoint that will be used for creating a connection.
- authentication
GetStream Connections Result Authentication 
- User credentials required to connect to a Kafka cluster. Includes the authentication type, as well as the parameters for that authentication mode. See authentication.
- aws
GetStream Connections Result Aws 
- The configuration for AWS Lambda connection. See AWS
- bootstrapServers String
- Comma separated list of server addresses.
- clusterName String
- Name of the cluster configured for this connection.
- config Map<String,String>
- A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
- connectionName String
- Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
- dbRole GetTo Execute Stream Connections Result Db Role To Execute 
- The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See DBRoleToExecute.
- headers Map<String,String>
- A map of key-value pairs for optional headers.
- id String
- instanceName String
- Human-readable label that identifies the stream instance.
- networking
GetStream Connections Result Networking 
- Networking Access Type can either be PUBLIC(default) orVPC. See networking.
- projectId String
- Unique 24-hexadecimal digit string that identifies your project.
- security
GetStream Connections Result Security 
- Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. See security.
- type String
- Selected networking type. Either PUBLIC,VPCorPRIVATE_LINK. Defaults toPUBLIC.
- url String
- URL of the HTTPs endpoint that will be used for creating a connection.
- authentication
GetStream Connections Result Authentication 
- User credentials required to connect to a Kafka cluster. Includes the authentication type, as well as the parameters for that authentication mode. See authentication.
- aws
GetStream Connections Result Aws 
- The configuration for AWS Lambda connection. See AWS
- bootstrapServers string
- Comma separated list of server addresses.
- clusterName string
- Name of the cluster configured for this connection.
- config {[key: string]: string}
- A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
- connectionName string
- Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
- dbRole GetTo Execute Stream Connections Result Db Role To Execute 
- The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See DBRoleToExecute.
- headers {[key: string]: string}
- A map of key-value pairs for optional headers.
- id string
- instanceName string
- Human-readable label that identifies the stream instance.
- networking
GetStream Connections Result Networking 
- Networking Access Type can either be PUBLIC(default) orVPC. See networking.
- projectId string
- Unique 24-hexadecimal digit string that identifies your project.
- security
GetStream Connections Result Security 
- Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. See security.
- type string
- Selected networking type. Either PUBLIC,VPCorPRIVATE_LINK. Defaults toPUBLIC.
- url string
- URL of the HTTPs endpoint that will be used for creating a connection.
- authentication
GetStream Connections Result Authentication 
- User credentials required to connect to a Kafka cluster. Includes the authentication type, as well as the parameters for that authentication mode. See authentication.
- aws
GetStream Connections Result Aws 
- The configuration for AWS Lambda connection. See AWS
- bootstrap_servers str
- Comma separated list of server addresses.
- cluster_name str
- Name of the cluster configured for this connection.
- config Mapping[str, str]
- A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
- connection_name str
- Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
- db_role_ Getto_ execute Stream Connections Result Db Role To Execute 
- The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See DBRoleToExecute.
- headers Mapping[str, str]
- A map of key-value pairs for optional headers.
- id str
- instance_name str
- Human-readable label that identifies the stream instance.
- networking
GetStream Connections Result Networking 
- Networking Access Type can either be PUBLIC(default) orVPC. See networking.
- project_id str
- Unique 24-hexadecimal digit string that identifies your project.
- security
GetStream Connections Result Security 
- Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. See security.
- type str
- Selected networking type. Either PUBLIC,VPCorPRIVATE_LINK. Defaults toPUBLIC.
- url str
- URL of the HTTPs endpoint that will be used for creating a connection.
- authentication Property Map
- User credentials required to connect to a Kafka cluster. Includes the authentication type, as well as the parameters for that authentication mode. See authentication.
- aws Property Map
- The configuration for AWS Lambda connection. See AWS
- bootstrapServers String
- Comma separated list of server addresses.
- clusterName String
- Name of the cluster configured for this connection.
- config Map<String>
- A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
- connectionName String
- Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
- dbRole Property MapTo Execute 
- The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See DBRoleToExecute.
- headers Map<String>
- A map of key-value pairs for optional headers.
- id String
- instanceName String
- Human-readable label that identifies the stream instance.
- networking Property Map
- Networking Access Type can either be PUBLIC(default) orVPC. See networking.
- projectId String
- Unique 24-hexadecimal digit string that identifies your project.
- security Property Map
- Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. See security.
- type String
- Selected networking type. Either PUBLIC,VPCorPRIVATE_LINK. Defaults toPUBLIC.
- url String
- URL of the HTTPs endpoint that will be used for creating a connection.
GetStreamConnectionsResultAuthentication    
GetStreamConnectionsResultAws    
- RoleArn string
- Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.
- RoleArn string
- Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.
- roleArn String
- Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.
- roleArn string
- Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.
- role_arn str
- Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.
- roleArn String
- Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.
GetStreamConnectionsResultDbRoleToExecute       
GetStreamConnectionsResultNetworking    
- Access
GetStream Connections Result Networking Access 
- Information about the networking access. See access.
- Access
GetStream Connections Result Networking Access 
- Information about the networking access. See access.
- access
GetStream Connections Result Networking Access 
- Information about the networking access. See access.
- access
GetStream Connections Result Networking Access 
- Information about the networking access. See access.
- access
GetStream Connections Result Networking Access 
- Information about the networking access. See access.
- access Property Map
- Information about the networking access. See access.
GetStreamConnectionsResultNetworkingAccess     
- ConnectionId string
- Id of the Private Link connection when type is PRIVATE_LINK.
- Type string
- Selected networking type. Either PUBLIC,VPCorPRIVATE_LINK. Defaults toPUBLIC.
- ConnectionId string
- Id of the Private Link connection when type is PRIVATE_LINK.
- Type string
- Selected networking type. Either PUBLIC,VPCorPRIVATE_LINK. Defaults toPUBLIC.
- connectionId String
- Id of the Private Link connection when type is PRIVATE_LINK.
- type String
- Selected networking type. Either PUBLIC,VPCorPRIVATE_LINK. Defaults toPUBLIC.
- connectionId string
- Id of the Private Link connection when type is PRIVATE_LINK.
- type string
- Selected networking type. Either PUBLIC,VPCorPRIVATE_LINK. Defaults toPUBLIC.
- connection_id str
- Id of the Private Link connection when type is PRIVATE_LINK.
- type str
- Selected networking type. Either PUBLIC,VPCorPRIVATE_LINK. Defaults toPUBLIC.
- connectionId String
- Id of the Private Link connection when type is PRIVATE_LINK.
- type String
- Selected networking type. Either PUBLIC,VPCorPRIVATE_LINK. Defaults toPUBLIC.
GetStreamConnectionsResultSecurity    
- BrokerPublic stringCertificate 
- A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
- Protocol string
- Describes the transport type. Can be either PLAINTEXTorSSL.
- BrokerPublic stringCertificate 
- A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
- Protocol string
- Describes the transport type. Can be either PLAINTEXTorSSL.
- brokerPublic StringCertificate 
- A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
- protocol String
- Describes the transport type. Can be either PLAINTEXTorSSL.
- brokerPublic stringCertificate 
- A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
- protocol string
- Describes the transport type. Can be either PLAINTEXTorSSL.
- broker_public_ strcertificate 
- A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
- protocol str
- Describes the transport type. Can be either PLAINTEXTorSSL.
- brokerPublic StringCertificate 
- A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
- protocol String
- Describes the transport type. Can be either PLAINTEXTorSSL.
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the mongodbatlasTerraform Provider.