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

mongodbatlas.getStreamConnection

Explore with Pulumi AI

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

# Data Source: mongodbatlas.StreamConnection

mongodbatlas.StreamConnection describes a stream connection.

Example Usage

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

const example = mongodbatlas.getStreamConnection({
    projectId: "<PROJECT_ID>",
    instanceName: "<INSTANCE_NAME>",
    connectionName: "<CONNECTION_NAME>",
});
Copy
import pulumi
import pulumi_mongodbatlas as mongodbatlas

example = mongodbatlas.get_stream_connection(project_id="<PROJECT_ID>",
    instance_name="<INSTANCE_NAME>",
    connection_name="<CONNECTION_NAME>")
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.LookupStreamConnection(ctx, &mongodbatlas.LookupStreamConnectionArgs{
			ProjectId:      "<PROJECT_ID>",
			InstanceName:   "<INSTANCE_NAME>",
			ConnectionName: "<CONNECTION_NAME>",
		}, 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 example = Mongodbatlas.GetStreamConnection.Invoke(new()
    {
        ProjectId = "<PROJECT_ID>",
        InstanceName = "<INSTANCE_NAME>",
        ConnectionName = "<CONNECTION_NAME>",
    });

});
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.GetStreamConnectionArgs;
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.getStreamConnection(GetStreamConnectionArgs.builder()
            .projectId("<PROJECT_ID>")
            .instanceName("<INSTANCE_NAME>")
            .connectionName("<CONNECTION_NAME>")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: mongodbatlas:getStreamConnection
      arguments:
        projectId: <PROJECT_ID>
        instanceName: <INSTANCE_NAME>
        connectionName: <CONNECTION_NAME>
Copy

Using getStreamConnection

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 getStreamConnection(args: GetStreamConnectionArgs, opts?: InvokeOptions): Promise<GetStreamConnectionResult>
function getStreamConnectionOutput(args: GetStreamConnectionOutputArgs, opts?: InvokeOptions): Output<GetStreamConnectionResult>
Copy
def get_stream_connection(connection_name: Optional[str] = None,
                          instance_name: Optional[str] = None,
                          project_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetStreamConnectionResult
def get_stream_connection_output(connection_name: Optional[pulumi.Input[str]] = None,
                          instance_name: Optional[pulumi.Input[str]] = None,
                          project_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetStreamConnectionResult]
Copy
func LookupStreamConnection(ctx *Context, args *LookupStreamConnectionArgs, opts ...InvokeOption) (*LookupStreamConnectionResult, error)
func LookupStreamConnectionOutput(ctx *Context, args *LookupStreamConnectionOutputArgs, opts ...InvokeOption) LookupStreamConnectionResultOutput
Copy

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

public static class GetStreamConnection 
{
    public static Task<GetStreamConnectionResult> InvokeAsync(GetStreamConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamConnectionResult> Invoke(GetStreamConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetStreamConnectionResult> getStreamConnection(GetStreamConnectionArgs args, InvokeOptions options)
public static Output<GetStreamConnectionResult> getStreamConnection(GetStreamConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: mongodbatlas:index/getStreamConnection:getStreamConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConnectionName This property is required. string
Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
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.
ConnectionName This property is required. string
Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
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.
connectionName This property is required. String
Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
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.
connectionName This property is required. string
Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
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.
connection_name This property is required. str
Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
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.
connectionName This property is required. String
Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
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.

getStreamConnection Result

The following output properties are available:

Authentication GetStreamConnectionAuthentication
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 GetStreamConnectionAws
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
DbRoleToExecute GetStreamConnectionDbRoleToExecute
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
Networking GetStreamConnectionNetworking
Networking Access Type can either be PUBLIC (default) or VPC. See networking.
ProjectId string
Security GetStreamConnectionSecurity
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, VPC or PRIVATE_LINK. Defaults to PUBLIC.
Url string
URL of the HTTPs endpoint that will be used for creating a connection.
Authentication GetStreamConnectionAuthentication
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 GetStreamConnectionAws
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
DbRoleToExecute GetStreamConnectionDbRoleToExecute
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
Networking GetStreamConnectionNetworking
Networking Access Type can either be PUBLIC (default) or VPC. See networking.
ProjectId string
Security GetStreamConnectionSecurity
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, VPC or PRIVATE_LINK. Defaults to PUBLIC.
Url string
URL of the HTTPs endpoint that will be used for creating a connection.
authentication GetStreamConnectionAuthentication
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 GetStreamConnectionAws
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
dbRoleToExecute GetStreamConnectionDbRoleToExecute
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
networking GetStreamConnectionNetworking
Networking Access Type can either be PUBLIC (default) or VPC. See networking.
projectId String
security GetStreamConnectionSecurity
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, VPC or PRIVATE_LINK. Defaults to PUBLIC.
url String
URL of the HTTPs endpoint that will be used for creating a connection.
authentication GetStreamConnectionAuthentication
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 GetStreamConnectionAws
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
dbRoleToExecute GetStreamConnectionDbRoleToExecute
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
networking GetStreamConnectionNetworking
Networking Access Type can either be PUBLIC (default) or VPC. See networking.
projectId string
security GetStreamConnectionSecurity
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, VPC or PRIVATE_LINK. Defaults to PUBLIC.
url string
URL of the HTTPs endpoint that will be used for creating a connection.
authentication GetStreamConnectionAuthentication
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 GetStreamConnectionAws
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
db_role_to_execute GetStreamConnectionDbRoleToExecute
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
networking GetStreamConnectionNetworking
Networking Access Type can either be PUBLIC (default) or VPC. See networking.
project_id str
security GetStreamConnectionSecurity
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, VPC or PRIVATE_LINK. Defaults to PUBLIC.
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
dbRoleToExecute Property Map
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
networking Property Map
Networking Access Type can either be PUBLIC (default) or VPC. See networking.
projectId String
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, VPC or PRIVATE_LINK. Defaults to PUBLIC.
url String
URL of the HTTPs endpoint that will be used for creating a connection.

Supporting Types

GetStreamConnectionAuthentication

Mechanism This property is required. string
Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512.
Password This property is required. string
Password of the account to connect to the Kafka cluster.
Username This property is required. string
Username of the account to connect to the Kafka cluster.
Mechanism This property is required. string
Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512.
Password This property is required. string
Password of the account to connect to the Kafka cluster.
Username This property is required. string
Username of the account to connect to the Kafka cluster.
mechanism This property is required. String
Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512.
password This property is required. String
Password of the account to connect to the Kafka cluster.
username This property is required. String
Username of the account to connect to the Kafka cluster.
mechanism This property is required. string
Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512.
password This property is required. string
Password of the account to connect to the Kafka cluster.
username This property is required. string
Username of the account to connect to the Kafka cluster.
mechanism This property is required. str
Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512.
password This property is required. str
Password of the account to connect to the Kafka cluster.
username This property is required. str
Username of the account to connect to the Kafka cluster.
mechanism This property is required. String
Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512.
password This property is required. String
Password of the account to connect to the Kafka cluster.
username This property is required. String
Username of the account to connect to the Kafka cluster.

GetStreamConnectionAws

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

GetStreamConnectionDbRoleToExecute

Role This property is required. string
The name of the role to use. Can be a built in role or a custom role.
Type This property is required. string
Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC.
Role This property is required. string
The name of the role to use. Can be a built in role or a custom role.
Type This property is required. string
Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC.
role This property is required. String
The name of the role to use. Can be a built in role or a custom role.
type This property is required. String
Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC.
role This property is required. string
The name of the role to use. Can be a built in role or a custom role.
type This property is required. string
Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC.
role This property is required. str
The name of the role to use. Can be a built in role or a custom role.
type This property is required. str
Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC.
role This property is required. String
The name of the role to use. Can be a built in role or a custom role.
type This property is required. String
Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC.

GetStreamConnectionNetworking

Access This property is required. GetStreamConnectionNetworkingAccess
Information about the networking access. See access.
Access This property is required. GetStreamConnectionNetworkingAccess
Information about the networking access. See access.
access This property is required. GetStreamConnectionNetworkingAccess
Information about the networking access. See access.
access This property is required. GetStreamConnectionNetworkingAccess
Information about the networking access. See access.
access This property is required. GetStreamConnectionNetworkingAccess
Information about the networking access. See access.
access This property is required. Property Map
Information about the networking access. See access.

GetStreamConnectionNetworkingAccess

ConnectionId This property is required. string
Id of the Private Link connection when type is PRIVATE_LINK.
Type This property is required. string
Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC.
ConnectionId This property is required. string
Id of the Private Link connection when type is PRIVATE_LINK.
Type This property is required. string
Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC.
connectionId This property is required. String
Id of the Private Link connection when type is PRIVATE_LINK.
type This property is required. String
Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC.
connectionId This property is required. string
Id of the Private Link connection when type is PRIVATE_LINK.
type This property is required. string
Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC.
connection_id This property is required. str
Id of the Private Link connection when type is PRIVATE_LINK.
type This property is required. str
Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC.
connectionId This property is required. String
Id of the Private Link connection when type is PRIVATE_LINK.
type This property is required. String
Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC.

GetStreamConnectionSecurity

BrokerPublicCertificate This property is required. string
A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
Protocol This property is required. string
Describes the transport type. Can be either PLAINTEXT or SSL.
BrokerPublicCertificate This property is required. string
A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
Protocol This property is required. string
Describes the transport type. Can be either PLAINTEXT or SSL.
brokerPublicCertificate This property is required. String
A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
protocol This property is required. String
Describes the transport type. Can be either PLAINTEXT or SSL.
brokerPublicCertificate This property is required. string
A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
protocol This property is required. string
Describes the transport type. Can be either PLAINTEXT or SSL.
broker_public_certificate This property is required. str
A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
protocol This property is required. str
Describes the transport type. Can be either PLAINTEXT or SSL.
brokerPublicCertificate This property is required. String
A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
protocol This property is required. String
Describes the transport type. Can be either PLAINTEXT or SSL.

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