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

mongodbatlas.StreamConnection

Explore with Pulumi AI

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

    # Resource: mongodbatlas.StreamConnection

    mongodbatlas.StreamConnection provides a Stream Connection resource. The resource lets you create, edit, and delete stream instance connections.

    IMPORTANT: All arguments including the Kafka authentication password will be stored in the raw state as plaintext. Read more about sensitive data in state.

    Example Usage

    Example Cluster Connection

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

const test = new mongodbatlas.StreamConnection("test", {
    projectId: projectId,
    instanceName: "InstanceName",
    connectionName: "ConnectionName",
    type: "Cluster",
    clusterName: "Cluster0",
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.StreamConnection("test",
    project_id=project_id,
    instance_name="InstanceName",
    connection_name="ConnectionName",
    type="Cluster",
    cluster_name="Cluster0")

    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.NewStreamConnection(ctx, "test", &mongodbatlas.StreamConnectionArgs{
			ProjectId:      pulumi.Any(projectId),
			InstanceName:   pulumi.String("InstanceName"),
			ConnectionName: pulumi.String("ConnectionName"),
			Type:           pulumi.String("Cluster"),
			ClusterName:    pulumi.String("Cluster0"),
		})
		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 = new Mongodbatlas.StreamConnection("test", new()
    {
        ProjectId = projectId,
        InstanceName = "InstanceName",
        ConnectionName = "ConnectionName",
        Type = "Cluster",
        ClusterName = "Cluster0",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.StreamConnection;
import com.pulumi.mongodbatlas.StreamConnectionArgs;
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) {
        var test = new StreamConnection("test", StreamConnectionArgs.builder()
            .projectId(projectId)
            .instanceName("InstanceName")
            .connectionName("ConnectionName")
            .type("Cluster")
            .clusterName("Cluster0")
            .build());

    }
}

    resources:
  test:
    type: mongodbatlas:StreamConnection
    properties:
      projectId: ${projectId}
      instanceName: InstanceName
      connectionName: ConnectionName
      type: Cluster
      clusterName: Cluster0

    Example Kafka Plaintext Connection

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

const test = new mongodbatlas.StreamConnection("test", {
    projectId: projectId,
    instanceName: "NewInstance",
    connectionName: "KafkaConnection",
    type: "Kafka",
    authentication: {
        mechanism: "SCRAM-256",
        username: "user",
        password: "somepassword",
    },
    security: {
        protocol: "PLAINTEXT",
    },
    config: {
        "auto.offset.reset": "latest",
    },
    bootstrapServers: "localhost:9091,localhost:9092",
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.StreamConnection("test",
    project_id=project_id,
    instance_name="NewInstance",
    connection_name="KafkaConnection",
    type="Kafka",
    authentication={
        "mechanism": "SCRAM-256",
        "username": "user",
        "password": "somepassword",
    },
    security={
        "protocol": "PLAINTEXT",
    },
    config={
        "auto.offset.reset": "latest",
    },
    bootstrap_servers="localhost:9091,localhost:9092")

    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.NewStreamConnection(ctx, "test", &mongodbatlas.StreamConnectionArgs{
			ProjectId:      pulumi.Any(projectId),
			InstanceName:   pulumi.String("NewInstance"),
			ConnectionName: pulumi.String("KafkaConnection"),
			Type:           pulumi.String("Kafka"),
			Authentication: &mongodbatlas.StreamConnectionAuthenticationArgs{
				Mechanism: pulumi.String("SCRAM-256"),
				Username:  pulumi.String("user"),
				Password:  pulumi.String("somepassword"),
			},
			Security: &mongodbatlas.StreamConnectionSecurityArgs{
				Protocol: pulumi.String("PLAINTEXT"),
			},
			Config: pulumi.StringMap{
				"auto.offset.reset": pulumi.String("latest"),
			},
			BootstrapServers: pulumi.String("localhost:9091,localhost:9092"),
		})
		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 = new Mongodbatlas.StreamConnection("test", new()
    {
        ProjectId = projectId,
        InstanceName = "NewInstance",
        ConnectionName = "KafkaConnection",
        Type = "Kafka",
        Authentication = new Mongodbatlas.Inputs.StreamConnectionAuthenticationArgs
        {
            Mechanism = "SCRAM-256",
            Username = "user",
            Password = "somepassword",
        },
        Security = new Mongodbatlas.Inputs.StreamConnectionSecurityArgs
        {
            Protocol = "PLAINTEXT",
        },
        Config = 
        {
            { "auto.offset.reset", "latest" },
        },
        BootstrapServers = "localhost:9091,localhost:9092",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.StreamConnection;
import com.pulumi.mongodbatlas.StreamConnectionArgs;
import com.pulumi.mongodbatlas.inputs.StreamConnectionAuthenticationArgs;
import com.pulumi.mongodbatlas.inputs.StreamConnectionSecurityArgs;
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) {
        var test = new StreamConnection("test", StreamConnectionArgs.builder()
            .projectId(projectId)
            .instanceName("NewInstance")
            .connectionName("KafkaConnection")
            .type("Kafka")
            .authentication(StreamConnectionAuthenticationArgs.builder()
                .mechanism("SCRAM-256")
                .username("user")
                .password("somepassword")
                .build())
            .security(StreamConnectionSecurityArgs.builder()
                .protocol("PLAINTEXT")
                .build())
            .config(Map.of("auto.offset.reset", "latest"))
            .bootstrapServers("localhost:9091,localhost:9092")
            .build());

    }
}

    resources:
  test:
    type: mongodbatlas:StreamConnection
    properties:
      projectId: ${projectId}
      instanceName: NewInstance
      connectionName: KafkaConnection
      type: Kafka
      authentication:
        mechanism: SCRAM-256
        username: user
        password: somepassword
      security:
        protocol: PLAINTEXT
      config:
        auto.offset.reset: latest
      bootstrapServers: localhost:9091,localhost:9092

    Example Kafka SSL Connection

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.StreamConnection;
import com.pulumi.mongodbatlas.StreamConnectionArgs;
import com.pulumi.mongodbatlas.inputs.StreamConnectionAuthenticationArgs;
import com.pulumi.mongodbatlas.inputs.StreamConnectionSecurityArgs;
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) {
        var test = new StreamConnection("test", StreamConnectionArgs.builder()
            .projectId(projectId)
            .instanceName("NewInstance")
            .connectionName("KafkaConnection")
            .type("Kafka")
            .authentication(StreamConnectionAuthenticationArgs.builder()
                .mechanism("PLAIN")
                .username("user")
                .password("somepassword")
                .build())
            .security(StreamConnectionSecurityArgs.builder()
                .protocol("SSL")
                .broker_public_certificate("-----BEGIN CERTIFICATE-----<CONTENT>-----END CERTIFICATE-----")
                .build())
            .config(Map.of("auto.offset.reset", "latest"))
            .bootstrapServers("localhost:9091,localhost:9092")
            .build());

    }
}

    resources:
  test:
    type: mongodbatlas:StreamConnection
    properties:
      projectId: ${projectId}
      instanceName: NewInstance
      connectionName: KafkaConnection
      type: Kafka
      authentication:
        mechanism: PLAIN
        username: user
        password: somepassword
      security:
        protocol: SSL
        broker_public_certificate: '-----BEGIN CERTIFICATE-----<CONTENT>-----END CERTIFICATE-----'
      config:
        auto.offset.reset: latest
      bootstrapServers: localhost:9091,localhost:9092

    Example AWSLambda Connection

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.StreamConnection;
import com.pulumi.mongodbatlas.StreamConnectionArgs;
import com.pulumi.mongodbatlas.inputs.StreamConnectionAwsArgs;
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) {
        var test = new StreamConnection("test", StreamConnectionArgs.builder()
            .projectId(projectId)
            .instanceName("NewInstance")
            .connectionName("AWSLambdaConnection")
            .type("AWSLambda")
            .aws(StreamConnectionAwsArgs.builder()
                .role_arn("arn:aws:iam::123456789123:role/lambdaRole")
                .build())
            .build());

    }
}

    resources:
  test:
    type: mongodbatlas:StreamConnection
    properties:
      projectId: ${projectId}
      instanceName: NewInstance
      connectionName: AWSLambdaConnection
      type: AWSLambda
      aws:
        role_arn: arn:aws:iam::123456789123:role/lambdaRole

    Example Https Connection

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

const example_https = new mongodbatlas.StreamConnection("example-https", {
    projectId: projectId,
    instanceName: example.instanceName,
    connectionName: "https_connection_tf_new",
    type: "Https",
    url: "https://example.com",
    headers: {
        key1: "value1",
        key2: "value2",
    },
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

example_https = mongodbatlas.StreamConnection("example-https",
    project_id=project_id,
    instance_name=example["instanceName"],
    connection_name="https_connection_tf_new",
    type="Https",
    url="https://example.com",
    headers={
        "key1": "value1",
        "key2": "value2",
    })

    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.NewStreamConnection(ctx, "example-https", &mongodbatlas.StreamConnectionArgs{
			ProjectId:      pulumi.Any(projectId),
			InstanceName:   pulumi.Any(example.InstanceName),
			ConnectionName: pulumi.String("https_connection_tf_new"),
			Type:           pulumi.String("Https"),
			Url:            pulumi.String("https://example.com"),
			Headers: pulumi.StringMap{
				"key1": pulumi.String("value1"),
				"key2": pulumi.String("value2"),
			},
		})
		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_https = new Mongodbatlas.StreamConnection("example-https", new()
    {
        ProjectId = projectId,
        InstanceName = example.InstanceName,
        ConnectionName = "https_connection_tf_new",
        Type = "Https",
        Url = "https://example.com",
        Headers = 
        {
            { "key1", "value1" },
            { "key2", "value2" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.StreamConnection;
import com.pulumi.mongodbatlas.StreamConnectionArgs;
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) {
        var example_https = new StreamConnection("example-https", StreamConnectionArgs.builder()
            .projectId(projectId)
            .instanceName(example.instanceName())
            .connectionName("https_connection_tf_new")
            .type("Https")
            .url("https://example.com")
            .headers(Map.ofEntries(
                Map.entry("key1", "value1"),
                Map.entry("key2", "value2")
            ))
            .build());

    }
}

    resources:
  example-https:
    type: mongodbatlas:StreamConnection
    properties:
      projectId: ${projectId}
      instanceName: ${example.instanceName}
      connectionName: https_connection_tf_new
      type: Https
      url: https://example.com
      headers:
        key1: value1
        key2: value2

    Create StreamConnection Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new StreamConnection(name: string, args: StreamConnectionArgs, opts?: CustomResourceOptions);
    @overload
def StreamConnection(resource_name: str,
                     args: StreamConnectionArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def StreamConnection(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     connection_name: Optional[str] = None,
                     type: Optional[str] = None,
                     project_id: Optional[str] = None,
                     instance_name: Optional[str] = None,
                     db_role_to_execute: Optional[StreamConnectionDbRoleToExecuteArgs] = None,
                     config: Optional[Mapping[str, str]] = None,
                     authentication: Optional[StreamConnectionAuthenticationArgs] = None,
                     headers: Optional[Mapping[str, str]] = None,
                     cluster_name: Optional[str] = None,
                     networking: Optional[StreamConnectionNetworkingArgs] = None,
                     bootstrap_servers: Optional[str] = None,
                     security: Optional[StreamConnectionSecurityArgs] = None,
                     aws: Optional[StreamConnectionAwsArgs] = None,
                     url: Optional[str] = None)
    func NewStreamConnection(ctx *Context, name string, args StreamConnectionArgs, opts ...ResourceOption) (*StreamConnection, error)
    public StreamConnection(string name, StreamConnectionArgs args, CustomResourceOptions? opts = null)
    public StreamConnection(String name, StreamConnectionArgs args)
public StreamConnection(String name, StreamConnectionArgs args, CustomResourceOptions options)

    type: mongodbatlas:StreamConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args StreamConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StreamConnectionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StreamConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StreamConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StreamConnectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var streamConnectionResource = new Mongodbatlas.StreamConnection("streamConnectionResource", new()
{
    ConnectionName = "string",
    Type = "string",
    ProjectId = "string",
    InstanceName = "string",
    DbRoleToExecute = new Mongodbatlas.Inputs.StreamConnectionDbRoleToExecuteArgs
    {
        Role = "string",
        Type = "string",
    },
    Config = 
    {
        { "string", "string" },
    },
    Authentication = new Mongodbatlas.Inputs.StreamConnectionAuthenticationArgs
    {
        Mechanism = "string",
        Password = "string",
        Username = "string",
    },
    Headers = 
    {
        { "string", "string" },
    },
    ClusterName = "string",
    Networking = new Mongodbatlas.Inputs.StreamConnectionNetworkingArgs
    {
        Access = new Mongodbatlas.Inputs.StreamConnectionNetworkingAccessArgs
        {
            Type = "string",
            ConnectionId = "string",
        },
    },
    BootstrapServers = "string",
    Security = new Mongodbatlas.Inputs.StreamConnectionSecurityArgs
    {
        BrokerPublicCertificate = "string",
        Protocol = "string",
    },
    Aws = new Mongodbatlas.Inputs.StreamConnectionAwsArgs
    {
        RoleArn = "string",
    },
    Url = "string",
});

    example, err := mongodbatlas.NewStreamConnection(ctx, "streamConnectionResource", &mongodbatlas.StreamConnectionArgs{
	ConnectionName: pulumi.String("string"),
	Type:           pulumi.String("string"),
	ProjectId:      pulumi.String("string"),
	InstanceName:   pulumi.String("string"),
	DbRoleToExecute: &mongodbatlas.StreamConnectionDbRoleToExecuteArgs{
		Role: pulumi.String("string"),
		Type: pulumi.String("string"),
	},
	Config: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Authentication: &mongodbatlas.StreamConnectionAuthenticationArgs{
		Mechanism: pulumi.String("string"),
		Password:  pulumi.String("string"),
		Username:  pulumi.String("string"),
	},
	Headers: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ClusterName: pulumi.String("string"),
	Networking: &mongodbatlas.StreamConnectionNetworkingArgs{
		Access: &mongodbatlas.StreamConnectionNetworkingAccessArgs{
			Type:         pulumi.String("string"),
			ConnectionId: pulumi.String("string"),
		},
	},
	BootstrapServers: pulumi.String("string"),
	Security: &mongodbatlas.StreamConnectionSecurityArgs{
		BrokerPublicCertificate: pulumi.String("string"),
		Protocol:                pulumi.String("string"),
	},
	Aws: &mongodbatlas.StreamConnectionAwsArgs{
		RoleArn: pulumi.String("string"),
	},
	Url: pulumi.String("string"),
})

    var streamConnectionResource = new StreamConnection("streamConnectionResource", StreamConnectionArgs.builder()
    .connectionName("string")
    .type("string")
    .projectId("string")
    .instanceName("string")
    .dbRoleToExecute(StreamConnectionDbRoleToExecuteArgs.builder()
        .role("string")
        .type("string")
        .build())
    .config(Map.of("string", "string"))
    .authentication(StreamConnectionAuthenticationArgs.builder()
        .mechanism("string")
        .password("string")
        .username("string")
        .build())
    .headers(Map.of("string", "string"))
    .clusterName("string")
    .networking(StreamConnectionNetworkingArgs.builder()
        .access(StreamConnectionNetworkingAccessArgs.builder()
            .type("string")
            .connectionId("string")
            .build())
        .build())
    .bootstrapServers("string")
    .security(StreamConnectionSecurityArgs.builder()
        .brokerPublicCertificate("string")
        .protocol("string")
        .build())
    .aws(StreamConnectionAwsArgs.builder()
        .roleArn("string")
        .build())
    .url("string")
    .build());

    stream_connection_resource = mongodbatlas.StreamConnection("streamConnectionResource",
    connection_name="string",
    type="string",
    project_id="string",
    instance_name="string",
    db_role_to_execute={
        "role": "string",
        "type": "string",
    },
    config={
        "string": "string",
    },
    authentication={
        "mechanism": "string",
        "password": "string",
        "username": "string",
    },
    headers={
        "string": "string",
    },
    cluster_name="string",
    networking={
        "access": {
            "type": "string",
            "connection_id": "string",
        },
    },
    bootstrap_servers="string",
    security={
        "broker_public_certificate": "string",
        "protocol": "string",
    },
    aws={
        "role_arn": "string",
    },
    url="string")

    const streamConnectionResource = new mongodbatlas.StreamConnection("streamConnectionResource", {
    connectionName: "string",
    type: "string",
    projectId: "string",
    instanceName: "string",
    dbRoleToExecute: {
        role: "string",
        type: "string",
    },
    config: {
        string: "string",
    },
    authentication: {
        mechanism: "string",
        password: "string",
        username: "string",
    },
    headers: {
        string: "string",
    },
    clusterName: "string",
    networking: {
        access: {
            type: "string",
            connectionId: "string",
        },
    },
    bootstrapServers: "string",
    security: {
        brokerPublicCertificate: "string",
        protocol: "string",
    },
    aws: {
        roleArn: "string",
    },
    url: "string",
});

    type: mongodbatlas:StreamConnection
properties:
    authentication:
        mechanism: string
        password: string
        username: string
    aws:
        roleArn: string
    bootstrapServers: string
    clusterName: string
    config:
        string: string
    connectionName: string
    dbRoleToExecute:
        role: string
        type: string
    headers:
        string: string
    instanceName: string
    networking:
        access:
            connectionId: string
            type: string
    projectId: string
    security:
        brokerPublicCertificate: string
        protocol: string
    type: string
    url: string

    StreamConnection Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The StreamConnection resource accepts the following input properties:

    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.
    InstanceName string
    Human-readable label that identifies the stream instance.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    Type string
    Type of connection. Can be AWSLambda, Cluster, Https, Kafka or Sample.
    Authentication StreamConnectionAuthentication
    Aws StreamConnectionAws
    BootstrapServers string
    ClusterName string
    Config Dictionary<string, string>
    DbRoleToExecute StreamConnectionDbRoleToExecute
    Headers Dictionary<string, string>
    Networking StreamConnectionNetworking
    Security StreamConnectionSecurity
    Url string
    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.
    InstanceName string
    Human-readable label that identifies the stream instance.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    Type string
    Type of connection. Can be AWSLambda, Cluster, Https, Kafka or Sample.
    Authentication StreamConnectionAuthenticationArgs
    Aws StreamConnectionAwsArgs
    BootstrapServers string
    ClusterName string
    Config map[string]string
    DbRoleToExecute StreamConnectionDbRoleToExecuteArgs
    Headers map[string]string
    Networking StreamConnectionNetworkingArgs
    Security StreamConnectionSecurityArgs
    Url string
    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.
    instanceName String
    Human-readable label that identifies the stream instance.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    type String
    Type of connection. Can be AWSLambda, Cluster, Https, Kafka or Sample.
    authentication StreamConnectionAuthentication
    aws StreamConnectionAws
    bootstrapServers String
    clusterName String
    config Map<String,String>
    dbRoleToExecute StreamConnectionDbRoleToExecute
    headers Map<String,String>
    networking StreamConnectionNetworking
    security StreamConnectionSecurity
    url String
    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.
    instanceName string
    Human-readable label that identifies the stream instance.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project.
    type string
    Type of connection. Can be AWSLambda, Cluster, Https, Kafka or Sample.
    authentication StreamConnectionAuthentication
    aws StreamConnectionAws
    bootstrapServers string
    clusterName string
    config {[key: string]: string}
    dbRoleToExecute StreamConnectionDbRoleToExecute
    headers {[key: string]: string}
    networking StreamConnectionNetworking
    security StreamConnectionSecurity
    url string
    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.
    instance_name str
    Human-readable label that identifies the stream instance.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project.
    type str
    Type of connection. Can be AWSLambda, Cluster, Https, Kafka or Sample.
    authentication StreamConnectionAuthenticationArgs
    aws StreamConnectionAwsArgs
    bootstrap_servers str
    cluster_name str
    config Mapping[str, str]
    db_role_to_execute StreamConnectionDbRoleToExecuteArgs
    headers Mapping[str, str]
    networking StreamConnectionNetworkingArgs
    security StreamConnectionSecurityArgs
    url str
    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.
    instanceName String
    Human-readable label that identifies the stream instance.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    type String
    Type of connection. Can be AWSLambda, Cluster, Https, Kafka or Sample.
    authentication Property Map
    aws Property Map
    bootstrapServers String
    clusterName String
    config Map<String>
    dbRoleToExecute Property Map
    headers Map<String>
    networking Property Map
    security Property Map
    url String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StreamConnection resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing StreamConnection Resource

    Get an existing StreamConnection resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: StreamConnectionState, opts?: CustomResourceOptions): StreamConnection
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication: Optional[StreamConnectionAuthenticationArgs] = None,
        aws: Optional[StreamConnectionAwsArgs] = None,
        bootstrap_servers: Optional[str] = None,
        cluster_name: Optional[str] = None,
        config: Optional[Mapping[str, str]] = None,
        connection_name: Optional[str] = None,
        db_role_to_execute: Optional[StreamConnectionDbRoleToExecuteArgs] = None,
        headers: Optional[Mapping[str, str]] = None,
        instance_name: Optional[str] = None,
        networking: Optional[StreamConnectionNetworkingArgs] = None,
        project_id: Optional[str] = None,
        security: Optional[StreamConnectionSecurityArgs] = None,
        type: Optional[str] = None,
        url: Optional[str] = None) -> StreamConnection
    func GetStreamConnection(ctx *Context, name string, id IDInput, state *StreamConnectionState, opts ...ResourceOption) (*StreamConnection, error)
    public static StreamConnection Get(string name, Input<string> id, StreamConnectionState? state, CustomResourceOptions? opts = null)
    public static StreamConnection get(String name, Output<String> id, StreamConnectionState state, CustomResourceOptions options)
    resources:  _:    type: mongodbatlas:StreamConnection    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Authentication StreamConnectionAuthentication
    Aws StreamConnectionAws
    BootstrapServers string
    ClusterName string
    Config Dictionary<string, string>
    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.
    DbRoleToExecute StreamConnectionDbRoleToExecute
    Headers Dictionary<string, string>
    InstanceName string
    Human-readable label that identifies the stream instance.
    Networking StreamConnectionNetworking
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    Security StreamConnectionSecurity
    Type string
    Type of connection. Can be AWSLambda, Cluster, Https, Kafka or Sample.
    Url string
    Authentication StreamConnectionAuthenticationArgs
    Aws StreamConnectionAwsArgs
    BootstrapServers string
    ClusterName string
    Config map[string]string
    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.
    DbRoleToExecute StreamConnectionDbRoleToExecuteArgs
    Headers map[string]string
    InstanceName string
    Human-readable label that identifies the stream instance.
    Networking StreamConnectionNetworkingArgs
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    Security StreamConnectionSecurityArgs
    Type string
    Type of connection. Can be AWSLambda, Cluster, Https, Kafka or Sample.
    Url string
    authentication StreamConnectionAuthentication
    aws StreamConnectionAws
    bootstrapServers String
    clusterName String
    config Map<String,String>
    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.
    dbRoleToExecute StreamConnectionDbRoleToExecute
    headers Map<String,String>
    instanceName String
    Human-readable label that identifies the stream instance.
    networking StreamConnectionNetworking
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    security StreamConnectionSecurity
    type String
    Type of connection. Can be AWSLambda, Cluster, Https, Kafka or Sample.
    url String
    authentication StreamConnectionAuthentication
    aws StreamConnectionAws
    bootstrapServers string
    clusterName string
    config {[key: string]: string}
    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.
    dbRoleToExecute StreamConnectionDbRoleToExecute
    headers {[key: string]: string}
    instanceName string
    Human-readable label that identifies the stream instance.
    networking StreamConnectionNetworking
    projectId string
    Unique 24-hexadecimal digit string that identifies your project.
    security StreamConnectionSecurity
    type string
    Type of connection. Can be AWSLambda, Cluster, Https, Kafka or Sample.
    url string
    authentication StreamConnectionAuthenticationArgs
    aws StreamConnectionAwsArgs
    bootstrap_servers str
    cluster_name str
    config Mapping[str, str]
    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_to_execute StreamConnectionDbRoleToExecuteArgs
    headers Mapping[str, str]
    instance_name str
    Human-readable label that identifies the stream instance.
    networking StreamConnectionNetworkingArgs
    project_id str
    Unique 24-hexadecimal digit string that identifies your project.
    security StreamConnectionSecurityArgs
    type str
    Type of connection. Can be AWSLambda, Cluster, Https, Kafka or Sample.
    url str
    authentication Property Map
    aws Property Map
    bootstrapServers String
    clusterName String
    config Map<String>
    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.
    dbRoleToExecute Property Map
    headers Map<String>
    instanceName String
    Human-readable label that identifies the stream instance.
    networking Property Map
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    security Property Map
    type String
    Type of connection. Can be AWSLambda, Cluster, Https, Kafka or Sample.
    url String

    Supporting Types

    StreamConnectionAuthentication, StreamConnectionAuthenticationArgs

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

    StreamConnectionAws, StreamConnectionAwsArgs

    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.

    StreamConnectionDbRoleToExecute, StreamConnectionDbRoleToExecuteArgs

    Role string
    The name of the role to use. Value can be atlasAdmin, readWriteAnyDatabase, or readAnyDatabase if type is set to BUILT_IN, or the name of a user-defined role if type is set to CUSTOM.
    Type string
    Type of connection. Can be AWSLambda, Cluster, Https, Kafka or Sample.
    Role string
    The name of the role to use. Value can be atlasAdmin, readWriteAnyDatabase, or readAnyDatabase if type is set to BUILT_IN, or the name of a user-defined role if type is set to CUSTOM.
    Type string
    Type of connection. Can be AWSLambda, Cluster, Https, Kafka or Sample.
    role String
    The name of the role to use. Value can be atlasAdmin, readWriteAnyDatabase, or readAnyDatabase if type is set to BUILT_IN, or the name of a user-defined role if type is set to CUSTOM.
    type String
    Type of connection. Can be AWSLambda, Cluster, Https, Kafka or Sample.
    role string
    The name of the role to use. Value can be atlasAdmin, readWriteAnyDatabase, or readAnyDatabase if type is set to BUILT_IN, or the name of a user-defined role if type is set to CUSTOM.
    type string
    Type of connection. Can be AWSLambda, Cluster, Https, Kafka or Sample.
    role str
    The name of the role to use. Value can be atlasAdmin, readWriteAnyDatabase, or readAnyDatabase if type is set to BUILT_IN, or the name of a user-defined role if type is set to CUSTOM.
    type str
    Type of connection. Can be AWSLambda, Cluster, Https, Kafka or Sample.
    role String
    The name of the role to use. Value can be atlasAdmin, readWriteAnyDatabase, or readAnyDatabase if type is set to BUILT_IN, or the name of a user-defined role if type is set to CUSTOM.
    type String
    Type of connection. Can be AWSLambda, Cluster, Https, Kafka or Sample.

    StreamConnectionNetworking, StreamConnectionNetworkingArgs

    Access StreamConnectionNetworkingAccess
    Information about the networking access. See access.
    Access StreamConnectionNetworkingAccess
    Information about the networking access. See access.
    access StreamConnectionNetworkingAccess
    Information about the networking access. See access.
    access StreamConnectionNetworkingAccess
    Information about the networking access. See access.
    access StreamConnectionNetworkingAccess
    Information about the networking access. See access.
    access Property Map
    Information about the networking access. See access.

    StreamConnectionNetworkingAccess, StreamConnectionNetworkingAccessArgs

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

    StreamConnectionSecurity, StreamConnectionSecurityArgs

    BrokerPublicCertificate string
    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 PLAINTEXT or SSL.
    BrokerPublicCertificate string
    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 PLAINTEXT or SSL.
    brokerPublicCertificate String
    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 PLAINTEXT or SSL.
    brokerPublicCertificate string
    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 PLAINTEXT or SSL.
    broker_public_certificate str
    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 PLAINTEXT or SSL.
    brokerPublicCertificate String
    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 PLAINTEXT or SSL.

    Import

    You can import a stream connection resource using the instance name, project ID, and connection name. The format must be INSTANCE_NAME-PROJECT_ID-CONNECTION_NAME. For example:

    $ pulumi import mongodbatlas:index/streamConnection:StreamConnection test "DefaultInstance-12251446ae5f3f6ec7968b13-NewConnection"

    To learn more, see: MongoDB Atlas API - Stream Connection Documentation. The Terraform Provider Examples Section also contains details on the overall support for Atlas Streams Processing in Terraform.

    To learn more about importing existing cloud resources, see Importing resources.

    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 v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
    pulumi/pulumi-mongodbatlas