1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getStreamConnection
MongoDB Atlas v4.3.0 published on Thursday, Feb 5, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

mongodbatlas.getStreamConnection

mongodbatlas logo
MongoDB Atlas v4.3.0 published on Thursday, Feb 5, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

    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>",
    workspaceName: "<WORKSPACE_NAME>",
    connectionName: "<CONNECTION_NAME>",
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

example = mongodbatlas.get_stream_connection(project_id="<PROJECT_ID>",
    workspace_name="<WORKSPACE_NAME>",
    connection_name="<CONNECTION_NAME>")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodbatlas.LookupStreamConnection(ctx, &mongodbatlas.LookupStreamConnectionArgs{
			ProjectId:      "<PROJECT_ID>",
			WorkspaceName:  pulumi.StringRef("<WORKSPACE_NAME>"),
			ConnectionName: "<CONNECTION_NAME>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var example = Mongodbatlas.GetStreamConnection.Invoke(new()
    {
        ProjectId = "<PROJECT_ID>",
        WorkspaceName = "<WORKSPACE_NAME>",
        ConnectionName = "<CONNECTION_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.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>")
            .workspaceName("<WORKSPACE_NAME>")
            .connectionName("<CONNECTION_NAME>")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: mongodbatlas:getStreamConnection
      arguments:
        projectId: <PROJECT_ID>
        workspaceName: <WORKSPACE_NAME>
        connectionName: <CONNECTION_NAME>

    Example using<span pulumi-lang-nodejs=" workspaceName

    " pulumi-lang-dotnet=" WorkspaceName " pulumi-lang-go=" workspaceName " pulumi-lang-python=" workspace_name " pulumi-lang-yaml=" workspaceName " pulumi-lang-java=" workspaceName “> workspace_name

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

const example = mongodbatlas.getStreamConnection({
    projectId: "<PROJECT_ID>",
    workspaceName: "<WORKSPACE_NAME>",
    connectionName: "<CONNECTION_NAME>",
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

example = mongodbatlas.get_stream_connection(project_id="<PROJECT_ID>",
    workspace_name="<WORKSPACE_NAME>",
    connection_name="<CONNECTION_NAME>")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodbatlas.LookupStreamConnection(ctx, &mongodbatlas.LookupStreamConnectionArgs{
			ProjectId:      "<PROJECT_ID>",
			WorkspaceName:  pulumi.StringRef("<WORKSPACE_NAME>"),
			ConnectionName: "<CONNECTION_NAME>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var example = Mongodbatlas.GetStreamConnection.Invoke(new()
    {
        ProjectId = "<PROJECT_ID>",
        WorkspaceName = "<WORKSPACE_NAME>",
        ConnectionName = "<CONNECTION_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.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>")
            .workspaceName("<WORKSPACE_NAME>")
            .connectionName("<CONNECTION_NAME>")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: mongodbatlas:getStreamConnection
      arguments:
        projectId: <PROJECT_ID>
        workspaceName: <WORKSPACE_NAME>
        connectionName: <CONNECTION_NAME>

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

    > 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)
}
    public static CompletableFuture<GetStreamConnectionResult> getStreamConnection(GetStreamConnectionArgs args, InvokeOptions options)
public static Output<GetStreamConnectionResult> getStreamConnection(GetStreamConnectionArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ConnectionName string

    Label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.

    NOTE: Either workspace_name or instance_name must be provided, but not both. These fields are functionally identical and workspace_name is an alias for instance_name. workspace_name should be used instead of instance_name.

    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    InstanceName string
    Label that identifies the stream processing workspace. Attribute is deprecated and will be removed in following major versions in favor of workspace_name.

    Deprecated: This parameter is deprecated. Please transition to workspace_name.

    WorkspaceName string
    Label that identifies the stream processing workspace. Conflicts with instance_name.
    ConnectionName string

    Label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.

    NOTE: Either workspace_name or instance_name must be provided, but not both. These fields are functionally identical and workspace_name is an alias for instance_name. workspace_name should be used instead of instance_name.

    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    InstanceName string
    Label that identifies the stream processing workspace. Attribute is deprecated and will be removed in following major versions in favor of workspace_name.

    Deprecated: This parameter is deprecated. Please transition to workspace_name.

    WorkspaceName string
    Label that identifies the stream processing workspace. Conflicts with instance_name.
    connectionName String

    Label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.

    NOTE: Either workspace_name or instance_name must be provided, but not both. These fields are functionally identical and workspace_name is an alias for instance_name. workspace_name should be used instead of instance_name.

    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    instanceName String
    Label that identifies the stream processing workspace. Attribute is deprecated and will be removed in following major versions in favor of workspace_name.

    Deprecated: This parameter is deprecated. Please transition to workspace_name.

    workspaceName String
    Label that identifies the stream processing workspace. Conflicts with instance_name.
    connectionName string

    Label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.

    NOTE: Either workspace_name or instance_name must be provided, but not both. These fields are functionally identical and workspace_name is an alias for instance_name. workspace_name should be used instead of instance_name.

    projectId string
    Unique 24-hexadecimal digit string that identifies your project.
    instanceName string
    Label that identifies the stream processing workspace. Attribute is deprecated and will be removed in following major versions in favor of workspace_name.

    Deprecated: This parameter is deprecated. Please transition to workspace_name.

    workspaceName string
    Label that identifies the stream processing workspace. Conflicts with instance_name.
    connection_name str

    Label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.

    NOTE: Either workspace_name or instance_name must be provided, but not both. These fields are functionally identical and workspace_name is an alias for instance_name. workspace_name should be used instead of instance_name.

    project_id str
    Unique 24-hexadecimal digit string that identifies your project.
    instance_name str
    Label that identifies the stream processing workspace. Attribute is deprecated and will be removed in following major versions in favor of workspace_name.

    Deprecated: This parameter is deprecated. Please transition to workspace_name.

    workspace_name str
    Label that identifies the stream processing workspace. Conflicts with instance_name.
    connectionName String

    Label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.

    NOTE: Either workspace_name or instance_name must be provided, but not both. These fields are functionally identical and workspace_name is an alias for instance_name. workspace_name should be used instead of instance_name.

    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    instanceName String
    Label that identifies the stream processing workspace. Attribute is deprecated and will be removed in following major versions in favor of workspace_name.

    Deprecated: This parameter is deprecated. Please transition to workspace_name.

    workspaceName String
    Label that identifies the stream processing workspace. Conflicts with instance_name.

    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.
    ClusterProjectId string
    Unique 24-hexadecimal digit string that identifies the project that contains the configured cluster. Required if the ID does not match the project containing the streams instance. You must first enable the organization setting.
    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
    Networking GetStreamConnectionNetworking
    Networking Access Type can either be PUBLIC (default) or VPC. See networking.
    ProjectId string
    SchemaRegistryAuthentication GetStreamConnectionSchemaRegistryAuthentication
    Authentication configuration for Schema Registry. See Schema Registry Authentication.
    SchemaRegistryProvider string
    The Schema Registry provider. Must be set to CONFLUENT.
    SchemaRegistryUrls List<string>
    List of Schema Registry endpoint URLs used by this connection. Each URL must use the http or https scheme and specify a valid host and optional port.
    Security GetStreamConnectionSecurity
    Properties for the secure transport connection to Kafka. For SASL_SSL, this can include the trusted certificate to use. See security.
    Type string
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    Url string
    URL of the HTTPs endpoint that will be used for creating a connection.
    InstanceName string

    Deprecated: This parameter is deprecated. Please transition to workspace_name.

    WorkspaceName string
    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.
    ClusterProjectId string
    Unique 24-hexadecimal digit string that identifies the project that contains the configured cluster. Required if the ID does not match the project containing the streams instance. You must first enable the organization setting.
    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
    Networking GetStreamConnectionNetworking
    Networking Access Type can either be PUBLIC (default) or VPC. See networking.
    ProjectId string
    SchemaRegistryAuthentication GetStreamConnectionSchemaRegistryAuthentication
    Authentication configuration for Schema Registry. See Schema Registry Authentication.
    SchemaRegistryProvider string
    The Schema Registry provider. Must be set to CONFLUENT.
    SchemaRegistryUrls []string
    List of Schema Registry endpoint URLs used by this connection. Each URL must use the http or https scheme and specify a valid host and optional port.
    Security GetStreamConnectionSecurity
    Properties for the secure transport connection to Kafka. For SASL_SSL, this can include the trusted certificate to use. See security.
    Type string
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    Url string
    URL of the HTTPs endpoint that will be used for creating a connection.
    InstanceName string

    Deprecated: This parameter is deprecated. Please transition to workspace_name.

    WorkspaceName string
    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.
    clusterProjectId String
    Unique 24-hexadecimal digit string that identifies the project that contains the configured cluster. Required if the ID does not match the project containing the streams instance. You must first enable the organization setting.
    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
    networking GetStreamConnectionNetworking
    Networking Access Type can either be PUBLIC (default) or VPC. See networking.
    projectId String
    schemaRegistryAuthentication GetStreamConnectionSchemaRegistryAuthentication
    Authentication configuration for Schema Registry. See Schema Registry Authentication.
    schemaRegistryProvider String
    The Schema Registry provider. Must be set to CONFLUENT.
    schemaRegistryUrls List<String>
    List of Schema Registry endpoint URLs used by this connection. Each URL must use the http or https scheme and specify a valid host and optional port.
    security GetStreamConnectionSecurity
    Properties for the secure transport connection to Kafka. For SASL_SSL, this can include the trusted certificate to use. See security.
    type String
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    url String
    URL of the HTTPs endpoint that will be used for creating a connection.
    instanceName String

    Deprecated: This parameter is deprecated. Please transition to workspace_name.

    workspaceName String
    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.
    clusterProjectId string
    Unique 24-hexadecimal digit string that identifies the project that contains the configured cluster. Required if the ID does not match the project containing the streams instance. You must first enable the organization setting.
    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
    networking GetStreamConnectionNetworking
    Networking Access Type can either be PUBLIC (default) or VPC. See networking.
    projectId string
    schemaRegistryAuthentication GetStreamConnectionSchemaRegistryAuthentication
    Authentication configuration for Schema Registry. See Schema Registry Authentication.
    schemaRegistryProvider string
    The Schema Registry provider. Must be set to CONFLUENT.
    schemaRegistryUrls string[]
    List of Schema Registry endpoint URLs used by this connection. Each URL must use the http or https scheme and specify a valid host and optional port.
    security GetStreamConnectionSecurity
    Properties for the secure transport connection to Kafka. For SASL_SSL, this can include the trusted certificate to use. See security.
    type string
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    url string
    URL of the HTTPs endpoint that will be used for creating a connection.
    instanceName string

    Deprecated: This parameter is deprecated. Please transition to workspace_name.

    workspaceName string
    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.
    cluster_project_id str
    Unique 24-hexadecimal digit string that identifies the project that contains the configured cluster. Required if the ID does not match the project containing the streams instance. You must first enable the organization setting.
    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
    networking GetStreamConnectionNetworking
    Networking Access Type can either be PUBLIC (default) or VPC. See networking.
    project_id str
    schema_registry_authentication GetStreamConnectionSchemaRegistryAuthentication
    Authentication configuration for Schema Registry. See Schema Registry Authentication.
    schema_registry_provider str
    The Schema Registry provider. Must be set to CONFLUENT.
    schema_registry_urls Sequence[str]
    List of Schema Registry endpoint URLs used by this connection. Each URL must use the http or https scheme and specify a valid host and optional port.
    security GetStreamConnectionSecurity
    Properties for the secure transport connection to Kafka. For SASL_SSL, this can include the trusted certificate to use. See security.
    type str
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    url str
    URL of the HTTPs endpoint that will be used for creating a connection.
    instance_name str

    Deprecated: This parameter is deprecated. Please transition to workspace_name.

    workspace_name str
    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.
    clusterProjectId String
    Unique 24-hexadecimal digit string that identifies the project that contains the configured cluster. Required if the ID does not match the project containing the streams instance. You must first enable the organization setting.
    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
    networking Property Map
    Networking Access Type can either be PUBLIC (default) or VPC. See networking.
    projectId String
    schemaRegistryAuthentication Property Map
    Authentication configuration for Schema Registry. See Schema Registry Authentication.
    schemaRegistryProvider String
    The Schema Registry provider. Must be set to CONFLUENT.
    schemaRegistryUrls List<String>
    List of Schema Registry endpoint URLs used by this connection. Each URL must use the http or https scheme and specify a valid host and optional port.
    security Property Map
    Properties for the secure transport connection to Kafka. For SASL_SSL, this can include the trusted certificate to use. See security.
    type String
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    url String
    URL of the HTTPs endpoint that will be used for creating a connection.
    instanceName String

    Deprecated: This parameter is deprecated. Please transition to workspace_name.

    workspaceName String

    Supporting Types

    GetStreamConnectionAuthentication

    ClientId string
    Public identifier for the Kafka client.
    ClientSecret string
    Secret known only to the Kafka client and the authorization server.
    Mechanism string
    Method of authentication. Value can be PLAIN, SCRAM-256, SCRAM-512, or OAUTHBEARER.
    Method string
    SASL OAUTHBEARER authentication method. Value must be OIDC.
    Password string
    Password for the Schema Registry. Required when type is USER_INFO.
    SaslOauthbearerExtensions string
    Additional information to provide to the Kafka broker.
    Scope string
    Scope of the access request to the broker specified by the Kafka clients.
    TokenEndpointUrl string
    OAUTH issuer (IdP provider) token endpoint HTTP(S) URI used to retrieve the token.
    Username string
    Username for the Schema Registry. Required when type is USER_INFO.
    ClientId string
    Public identifier for the Kafka client.
    ClientSecret string
    Secret known only to the Kafka client and the authorization server.
    Mechanism string
    Method of authentication. Value can be PLAIN, SCRAM-256, SCRAM-512, or OAUTHBEARER.
    Method string
    SASL OAUTHBEARER authentication method. Value must be OIDC.
    Password string
    Password for the Schema Registry. Required when type is USER_INFO.
    SaslOauthbearerExtensions string
    Additional information to provide to the Kafka broker.
    Scope string
    Scope of the access request to the broker specified by the Kafka clients.
    TokenEndpointUrl string
    OAUTH issuer (IdP provider) token endpoint HTTP(S) URI used to retrieve the token.
    Username string
    Username for the Schema Registry. Required when type is USER_INFO.
    clientId String
    Public identifier for the Kafka client.
    clientSecret String
    Secret known only to the Kafka client and the authorization server.
    mechanism String
    Method of authentication. Value can be PLAIN, SCRAM-256, SCRAM-512, or OAUTHBEARER.
    method String
    SASL OAUTHBEARER authentication method. Value must be OIDC.
    password String
    Password for the Schema Registry. Required when type is USER_INFO.
    saslOauthbearerExtensions String
    Additional information to provide to the Kafka broker.
    scope String
    Scope of the access request to the broker specified by the Kafka clients.
    tokenEndpointUrl String
    OAUTH issuer (IdP provider) token endpoint HTTP(S) URI used to retrieve the token.
    username String
    Username for the Schema Registry. Required when type is USER_INFO.
    clientId string
    Public identifier for the Kafka client.
    clientSecret string
    Secret known only to the Kafka client and the authorization server.
    mechanism string
    Method of authentication. Value can be PLAIN, SCRAM-256, SCRAM-512, or OAUTHBEARER.
    method string
    SASL OAUTHBEARER authentication method. Value must be OIDC.
    password string
    Password for the Schema Registry. Required when type is USER_INFO.
    saslOauthbearerExtensions string
    Additional information to provide to the Kafka broker.
    scope string
    Scope of the access request to the broker specified by the Kafka clients.
    tokenEndpointUrl string
    OAUTH issuer (IdP provider) token endpoint HTTP(S) URI used to retrieve the token.
    username string
    Username for the Schema Registry. Required when type is USER_INFO.
    client_id str
    Public identifier for the Kafka client.
    client_secret str
    Secret known only to the Kafka client and the authorization server.
    mechanism str
    Method of authentication. Value can be PLAIN, SCRAM-256, SCRAM-512, or OAUTHBEARER.
    method str
    SASL OAUTHBEARER authentication method. Value must be OIDC.
    password str
    Password for the Schema Registry. Required when type is USER_INFO.
    sasl_oauthbearer_extensions str
    Additional information to provide to the Kafka broker.
    scope str
    Scope of the access request to the broker specified by the Kafka clients.
    token_endpoint_url str
    OAUTH issuer (IdP provider) token endpoint HTTP(S) URI used to retrieve the token.
    username str
    Username for the Schema Registry. Required when type is USER_INFO.
    clientId String
    Public identifier for the Kafka client.
    clientSecret String
    Secret known only to the Kafka client and the authorization server.
    mechanism String
    Method of authentication. Value can be PLAIN, SCRAM-256, SCRAM-512, or OAUTHBEARER.
    method String
    SASL OAUTHBEARER authentication method. Value must be OIDC.
    password String
    Password for the Schema Registry. Required when type is USER_INFO.
    saslOauthbearerExtensions String
    Additional information to provide to the Kafka broker.
    scope String
    Scope of the access request to the broker specified by the Kafka clients.
    tokenEndpointUrl String
    OAUTH issuer (IdP provider) token endpoint HTTP(S) URI used to retrieve the token.
    username String
    Username for the Schema Registry. Required when type is USER_INFO.

    GetStreamConnectionAws

    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.

    GetStreamConnectionDbRoleToExecute

    Role string
    The name of the role to use. Can be a built in role or a custom role.
    Type string
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    Role string
    The name of the role to use. Can be a built in role or a custom role.
    Type string
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    role String
    The name of the role to use. Can be a built in role or a custom role.
    type String
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    role string
    The name of the role to use. Can be a built in role or a custom role.
    type string
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    role str
    The name of the role to use. Can be a built in role or a custom role.
    type str
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    role String
    The name of the role to use. Can be a built in role or a custom role.
    type String
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.

    GetStreamConnectionNetworking

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

    GetStreamConnectionNetworkingAccess

    ConnectionId string
    Id of the Private Link connection when type is PRIVATE_LINK.
    Type string
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    ConnectionId string
    Id of the Private Link connection when type is PRIVATE_LINK.
    Type string
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    connectionId String
    Id of the Private Link connection when type is PRIVATE_LINK.
    type String
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    connectionId string
    Id of the Private Link connection when type is PRIVATE_LINK.
    type string
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    connection_id str
    Id of the Private Link connection when type is PRIVATE_LINK.
    type str
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    connectionId String
    Id of the Private Link connection when type is PRIVATE_LINK.
    type String
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.

    GetStreamConnectionSchemaRegistryAuthentication

    Password string
    Password for the Schema Registry. Required when type is USER_INFO.
    Type string
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    Username string
    Username for the Schema Registry. Required when type is USER_INFO.
    Password string
    Password for the Schema Registry. Required when type is USER_INFO.
    Type string
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    Username string
    Username for the Schema Registry. Required when type is USER_INFO.
    password String
    Password for the Schema Registry. Required when type is USER_INFO.
    type String
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    username String
    Username for the Schema Registry. Required when type is USER_INFO.
    password string
    Password for the Schema Registry. Required when type is USER_INFO.
    type string
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    username string
    Username for the Schema Registry. Required when type is USER_INFO.
    password str
    Password for the Schema Registry. Required when type is USER_INFO.
    type str
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    username str
    Username for the Schema Registry. Required when type is USER_INFO.
    password String
    Password for the Schema Registry. Required when type is USER_INFO.
    type String
    Authentication type discriminator. Specifies the authentication mechanism for Confluent Schema Registry. Valid values are USER_INFO or SASL_INHERIT.

    • USER_INFO - Uses username and password authentication for Confluent Schema Registry.
    • SASL_INHERIT - Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
    username String
    Username for the Schema Registry. Required when type is USER_INFO.

    GetStreamConnectionSecurity

    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 SASL_PLAINTEXT or SASL_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 SASL_PLAINTEXT or SASL_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 SASL_PLAINTEXT or SASL_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 SASL_PLAINTEXT or SASL_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 SASL_PLAINTEXT or SASL_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 SASL_PLAINTEXT or SASL_SSL.

    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 v4.3.0 published on Thursday, Feb 5, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-mongodbatlas
      Meet Neo: Your AI Platform Teammate