Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Mongodbatlas Provider
  4. API Docs
  5. getStreamConnectionFailover
Viewing docs for MongoDB Atlas v4.12.0
published on Thursday, Jul 16, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

mongodbatlas.getStreamConnectionFailover

mongodbatlas logo
Viewing docs for MongoDB Atlas v4.12.0
published on Thursday, Jul 16, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

    mongodbatlas.StreamConnectionFailover describes a failover (regional-alternate) connection for an existing stream connection. It is looked up by its parent connectionName and its computed failoverConnectionId. Only Kafka and Cluster connection types support failover.

    Example Usage

    S

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

// Reads a single failover connection by its ID.
const example = mongodbatlas.getStreamConnectionFailover({
    projectId: projectId,
    workspaceName: exampleMongodbatlasStreamWorkspace.workspaceName,
    connectionName: exampleMongodbatlasStreamConnectionFailover.connectionName,
    failoverConnectionId: exampleMongodbatlasStreamConnectionFailover.failoverConnectionId,
});
export const failoverBootstrapServers = example.then(example => example.bootstrapServers);

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

# Reads a single failover connection by its ID.
example = mongodbatlas.get_stream_connection_failover(project_id=project_id,
    workspace_name=example_mongodbatlas_stream_workspace["workspaceName"],
    connection_name=example_mongodbatlas_stream_connection_failover["connectionName"],
    failover_connection_id=example_mongodbatlas_stream_connection_failover["failoverConnectionId"])
pulumi.export("failoverBootstrapServers", example.bootstrap_servers)

    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 {
		// Reads a single failover connection by its ID.
		example, err := mongodbatlas.GetStreamConnectionFailover(ctx, &mongodbatlas.LookupStreamConnectionFailoverArgs{
			ProjectId:            projectId,
			WorkspaceName:        exampleMongodbatlasStreamWorkspace.WorkspaceName,
			ConnectionName:       exampleMongodbatlasStreamConnectionFailover.ConnectionName,
			FailoverConnectionId: exampleMongodbatlasStreamConnectionFailover.FailoverConnectionId,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("failoverBootstrapServers", example.BootstrapServers)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Reads a single failover connection by its ID.
    var example = Mongodbatlas.GetStreamConnectionFailover.Invoke(new()
    {
        ProjectId = projectId,
        WorkspaceName = exampleMongodbatlasStreamWorkspace.WorkspaceName,
        ConnectionName = exampleMongodbatlasStreamConnectionFailover.ConnectionName,
        FailoverConnectionId = exampleMongodbatlasStreamConnectionFailover.FailoverConnectionId,
    });

    return new Dictionary<string, object?>
    {
        ["failoverBootstrapServers"] = example.Apply(getStreamConnectionFailoverResult => getStreamConnectionFailoverResult.BootstrapServers),
    };
});

    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.GetStreamConnectionFailoverArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        // Reads a single failover connection by its ID.
        final var example = MongodbatlasFunctions.getStreamConnectionFailover(GetStreamConnectionFailoverArgs.builder()
            .projectId(projectId)
            .workspaceName(exampleMongodbatlasStreamWorkspace.workspaceName())
            .connectionName(exampleMongodbatlasStreamConnectionFailover.connectionName())
            .failoverConnectionId(exampleMongodbatlasStreamConnectionFailover.failoverConnectionId())
            .build());

        ctx.export("failoverBootstrapServers", example.bootstrapServers());
    }
}

    variables:
  # Reads a single failover connection by its ID.
  example:
    fn::invoke:
      function: mongodbatlas:getStreamConnectionFailover
      arguments:
        projectId: ${projectId}
        workspaceName: ${exampleMongodbatlasStreamWorkspace.workspaceName}
        connectionName: ${exampleMongodbatlasStreamConnectionFailover.connectionName}
        failoverConnectionId: ${exampleMongodbatlasStreamConnectionFailover.failoverConnectionId}
outputs:
  failoverBootstrapServers: ${example.bootstrapServers}

    pulumi {
  required_providers {
    mongodbatlas = {
      source = "pulumi/mongodbatlas"
    }
  }
}

data "mongodbatlas_getstreamconnectionfailover" "example" {
  project_id             = projectId
  workspace_name         = exampleMongodbatlasStreamWorkspace.workspaceName
  connection_name        = exampleMongodbatlasStreamConnectionFailover.connectionName
  failover_connection_id = exampleMongodbatlasStreamConnectionFailover.failoverConnectionId
}

# Reads a single failover connection by its ID.
output "failoverBootstrapServers" {
  value = data.mongodbatlas_getstreamconnectionfailover.example.bootstrap_servers
}

    Using getStreamConnectionFailover

    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 getStreamConnectionFailover(args: GetStreamConnectionFailoverArgs, opts?: InvokeOptions): Promise<GetStreamConnectionFailoverResult>
function getStreamConnectionFailoverOutput(args: GetStreamConnectionFailoverOutputArgs, opts?: InvokeOptions): Output<GetStreamConnectionFailoverResult>
    def get_stream_connection_failover(connection_name: Optional[str] = None,
                                   failover_connection_id: Optional[str] = None,
                                   project_id: Optional[str] = None,
                                   workspace_name: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetStreamConnectionFailoverResult
def get_stream_connection_failover_output(connection_name: pulumi.Input[Optional[str]] = None,
                                   failover_connection_id: pulumi.Input[Optional[str]] = None,
                                   project_id: pulumi.Input[Optional[str]] = None,
                                   workspace_name: pulumi.Input[Optional[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetStreamConnectionFailoverResult]
    func LookupStreamConnectionFailover(ctx *Context, args *LookupStreamConnectionFailoverArgs, opts ...InvokeOption) (*LookupStreamConnectionFailoverResult, error)
func LookupStreamConnectionFailoverOutput(ctx *Context, args *LookupStreamConnectionFailoverOutputArgs, opts ...InvokeOption) LookupStreamConnectionFailoverResultOutput

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

    public static class GetStreamConnectionFailover 
{
    public static Task<GetStreamConnectionFailoverResult> InvokeAsync(GetStreamConnectionFailoverArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamConnectionFailoverResult> Invoke(GetStreamConnectionFailoverInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetStreamConnectionFailoverResult> getStreamConnectionFailover(GetStreamConnectionFailoverArgs args, InvokeOptions options)
public static Output<GetStreamConnectionFailoverResult> getStreamConnectionFailover(GetStreamConnectionFailoverArgs args, InvokeOptions options)

    fn::invoke:
  function: mongodbatlas:index/getStreamConnectionFailover:getStreamConnectionFailover
  arguments:
    # arguments dictionary
    data "mongodbatlas_get_stream_connection_failover" "name" {
    # arguments
}

    The following arguments are supported:

    ConnectionName string
    Label that identifies the stream connection.
    FailoverConnectionId string
    Label that identifies the stream failover connection id.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    WorkspaceName string
    Label that identifies the stream workspace.
    ConnectionName string
    Label that identifies the stream connection.
    FailoverConnectionId string
    Label that identifies the stream failover connection id.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    WorkspaceName string
    Label that identifies the stream workspace.
    connection_name string
    Label that identifies the stream connection.
    failover_connection_id string
    Label that identifies the stream failover connection id.
    project_id string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    workspace_name string
    Label that identifies the stream workspace.
    connectionName String
    Label that identifies the stream connection.
    failoverConnectionId String
    Label that identifies the stream failover connection id.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    workspaceName String
    Label that identifies the stream workspace.
    connectionName string
    Label that identifies the stream connection.
    failoverConnectionId string
    Label that identifies the stream failover connection id.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    workspaceName string
    Label that identifies the stream workspace.
    connection_name str
    Label that identifies the stream connection.
    failover_connection_id str
    Label that identifies the stream failover connection id.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    workspace_name str
    Label that identifies the stream workspace.
    connectionName String
    Label that identifies the stream connection.
    failoverConnectionId String
    Label that identifies the stream failover connection id.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    workspaceName String
    Label that identifies the stream workspace.

    getStreamConnectionFailover Result

    The following output properties are available:

    Authentication GetStreamConnectionFailoverAuthentication
    BootstrapServers string
    ClusterName string
    ClusterProjectId string
    Config Dictionary<string, string>
    ConnectionName string
    Label that identifies the stream connection.
    DbRoleToExecute GetStreamConnectionFailoverDbRoleToExecute
    FailoverConnectionId string
    Label that identifies the stream failover connection id.
    Id string
    The provider-assigned unique ID for this managed resource.
    Networking GetStreamConnectionFailoverNetworking
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    Region string
    The connection's region.
    Security GetStreamConnectionFailoverSecurity
    State string
    The state of the connection.
    Type string
    Type of the connection.
    WorkspaceName string
    Label that identifies the stream workspace.
    Authentication GetStreamConnectionFailoverAuthentication
    BootstrapServers string
    ClusterName string
    ClusterProjectId string
    Config map[string]string
    ConnectionName string
    Label that identifies the stream connection.
    DbRoleToExecute GetStreamConnectionFailoverDbRoleToExecute
    FailoverConnectionId string
    Label that identifies the stream failover connection id.
    Id string
    The provider-assigned unique ID for this managed resource.
    Networking GetStreamConnectionFailoverNetworking
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    Region string
    The connection's region.
    Security GetStreamConnectionFailoverSecurity
    State string
    The state of the connection.
    Type string
    Type of the connection.
    WorkspaceName string
    Label that identifies the stream workspace.
    authentication object
    bootstrap_servers string
    cluster_name string
    cluster_project_id string
    config map(string)
    connection_name string
    Label that identifies the stream connection.
    db_role_to_execute object
    failover_connection_id string
    Label that identifies the stream failover connection id.
    id string
    The provider-assigned unique ID for this managed resource.
    networking object
    project_id string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    region string
    The connection's region.
    security object
    state string
    The state of the connection.
    type string
    Type of the connection.
    workspace_name string
    Label that identifies the stream workspace.
    authentication GetStreamConnectionFailoverAuthentication
    bootstrapServers String
    clusterName String
    clusterProjectId String
    config Map<String,String>
    connectionName String
    Label that identifies the stream connection.
    dbRoleToExecute GetStreamConnectionFailoverDbRoleToExecute
    failoverConnectionId String
    Label that identifies the stream failover connection id.
    id String
    The provider-assigned unique ID for this managed resource.
    networking GetStreamConnectionFailoverNetworking
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    region String
    The connection's region.
    security GetStreamConnectionFailoverSecurity
    state String
    The state of the connection.
    type String
    Type of the connection.
    workspaceName String
    Label that identifies the stream workspace.
    authentication GetStreamConnectionFailoverAuthentication
    bootstrapServers string
    clusterName string
    clusterProjectId string
    config {[key: string]: string}
    connectionName string
    Label that identifies the stream connection.
    dbRoleToExecute GetStreamConnectionFailoverDbRoleToExecute
    failoverConnectionId string
    Label that identifies the stream failover connection id.
    id string
    The provider-assigned unique ID for this managed resource.
    networking GetStreamConnectionFailoverNetworking
    projectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    region string
    The connection's region.
    security GetStreamConnectionFailoverSecurity
    state string
    The state of the connection.
    type string
    Type of the connection.
    workspaceName string
    Label that identifies the stream workspace.
    authentication GetStreamConnectionFailoverAuthentication
    bootstrap_servers str
    cluster_name str
    cluster_project_id str
    config Mapping[str, str]
    connection_name str
    Label that identifies the stream connection.
    db_role_to_execute GetStreamConnectionFailoverDbRoleToExecute
    failover_connection_id str
    Label that identifies the stream failover connection id.
    id str
    The provider-assigned unique ID for this managed resource.
    networking GetStreamConnectionFailoverNetworking
    project_id str
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    region str
    The connection's region.
    security GetStreamConnectionFailoverSecurity
    state str
    The state of the connection.
    type str
    Type of the connection.
    workspace_name str
    Label that identifies the stream workspace.
    authentication Property Map
    bootstrapServers String
    clusterName String
    clusterProjectId String
    config Map<String>
    connectionName String
    Label that identifies the stream connection.
    dbRoleToExecute Property Map
    failoverConnectionId String
    Label that identifies the stream failover connection id.
    id String
    The provider-assigned unique ID for this managed resource.
    networking Property Map
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    region String
    The connection's region.
    security Property Map
    state String
    The state of the connection.
    type String
    Type of the connection.
    workspaceName String
    Label that identifies the stream workspace.

    Supporting Types

    GetStreamConnectionFailoverAuthentication

    ClientId string
    OIDC client identifier for authentication to the Kafka cluster.
    ClientSecret string
    OIDC client secret for authentication to the Kafka cluster.
    Mechanism string
    Style of authentication. Can be one of PLAIN, SCRAM-256, SCRAM-512, or OAUTHBEARER.
    Method string
    SASL OAUTHBEARER authentication method. Can only be OIDC currently.
    Password string
    Password of the account to connect to the Kafka cluster.
    SaslOauthbearerExtensions string
    SASL OAUTHBEARER extensions parameter for additional OAuth2 configuration.
    Scope string
    OIDC scope parameter defining the access permissions requested.
    SslCertificate string
    SSL certificate for client authentication to Kafka.
    SslKey string
    SSL key for client authentication to Kafka.
    SslKeyPassword string
    Password for the SSL key, if it is password protected.
    TokenEndpointUrl string
    OIDC token endpoint URL for obtaining access tokens.
    Username string
    Username of the account to connect to the Kafka cluster.
    ClientId string
    OIDC client identifier for authentication to the Kafka cluster.
    ClientSecret string
    OIDC client secret for authentication to the Kafka cluster.
    Mechanism string
    Style of authentication. Can be one of PLAIN, SCRAM-256, SCRAM-512, or OAUTHBEARER.
    Method string
    SASL OAUTHBEARER authentication method. Can only be OIDC currently.
    Password string
    Password of the account to connect to the Kafka cluster.
    SaslOauthbearerExtensions string
    SASL OAUTHBEARER extensions parameter for additional OAuth2 configuration.
    Scope string
    OIDC scope parameter defining the access permissions requested.
    SslCertificate string
    SSL certificate for client authentication to Kafka.
    SslKey string
    SSL key for client authentication to Kafka.
    SslKeyPassword string
    Password for the SSL key, if it is password protected.
    TokenEndpointUrl string
    OIDC token endpoint URL for obtaining access tokens.
    Username string
    Username of the account to connect to the Kafka cluster.
    client_id string
    OIDC client identifier for authentication to the Kafka cluster.
    client_secret string
    OIDC client secret for authentication to the Kafka cluster.
    mechanism string
    Style of authentication. Can be one of PLAIN, SCRAM-256, SCRAM-512, or OAUTHBEARER.
    method string
    SASL OAUTHBEARER authentication method. Can only be OIDC currently.
    password string
    Password of the account to connect to the Kafka cluster.
    sasl_oauthbearer_extensions string
    SASL OAUTHBEARER extensions parameter for additional OAuth2 configuration.
    scope string
    OIDC scope parameter defining the access permissions requested.
    ssl_certificate string
    SSL certificate for client authentication to Kafka.
    ssl_key string
    SSL key for client authentication to Kafka.
    ssl_key_password string
    Password for the SSL key, if it is password protected.
    token_endpoint_url string
    OIDC token endpoint URL for obtaining access tokens.
    username string
    Username of the account to connect to the Kafka cluster.
    clientId String
    OIDC client identifier for authentication to the Kafka cluster.
    clientSecret String
    OIDC client secret for authentication to the Kafka cluster.
    mechanism String
    Style of authentication. Can be one of PLAIN, SCRAM-256, SCRAM-512, or OAUTHBEARER.
    method String
    SASL OAUTHBEARER authentication method. Can only be OIDC currently.
    password String
    Password of the account to connect to the Kafka cluster.
    saslOauthbearerExtensions String
    SASL OAUTHBEARER extensions parameter for additional OAuth2 configuration.
    scope String
    OIDC scope parameter defining the access permissions requested.
    sslCertificate String
    SSL certificate for client authentication to Kafka.
    sslKey String
    SSL key for client authentication to Kafka.
    sslKeyPassword String
    Password for the SSL key, if it is password protected.
    tokenEndpointUrl String
    OIDC token endpoint URL for obtaining access tokens.
    username String
    Username of the account to connect to the Kafka cluster.
    clientId string
    OIDC client identifier for authentication to the Kafka cluster.
    clientSecret string
    OIDC client secret for authentication to the Kafka cluster.
    mechanism string
    Style of authentication. Can be one of PLAIN, SCRAM-256, SCRAM-512, or OAUTHBEARER.
    method string
    SASL OAUTHBEARER authentication method. Can only be OIDC currently.
    password string
    Password of the account to connect to the Kafka cluster.
    saslOauthbearerExtensions string
    SASL OAUTHBEARER extensions parameter for additional OAuth2 configuration.
    scope string
    OIDC scope parameter defining the access permissions requested.
    sslCertificate string
    SSL certificate for client authentication to Kafka.
    sslKey string
    SSL key for client authentication to Kafka.
    sslKeyPassword string
    Password for the SSL key, if it is password protected.
    tokenEndpointUrl string
    OIDC token endpoint URL for obtaining access tokens.
    username string
    Username of the account to connect to the Kafka cluster.
    client_id str
    OIDC client identifier for authentication to the Kafka cluster.
    client_secret str
    OIDC client secret for authentication to the Kafka cluster.
    mechanism str
    Style of authentication. Can be one of PLAIN, SCRAM-256, SCRAM-512, or OAUTHBEARER.
    method str
    SASL OAUTHBEARER authentication method. Can only be OIDC currently.
    password str
    Password of the account to connect to the Kafka cluster.
    sasl_oauthbearer_extensions str
    SASL OAUTHBEARER extensions parameter for additional OAuth2 configuration.
    scope str
    OIDC scope parameter defining the access permissions requested.
    ssl_certificate str
    SSL certificate for client authentication to Kafka.
    ssl_key str
    SSL key for client authentication to Kafka.
    ssl_key_password str
    Password for the SSL key, if it is password protected.
    token_endpoint_url str
    OIDC token endpoint URL for obtaining access tokens.
    username str
    Username of the account to connect to the Kafka cluster.
    clientId String
    OIDC client identifier for authentication to the Kafka cluster.
    clientSecret String
    OIDC client secret for authentication to the Kafka cluster.
    mechanism String
    Style of authentication. Can be one of PLAIN, SCRAM-256, SCRAM-512, or OAUTHBEARER.
    method String
    SASL OAUTHBEARER authentication method. Can only be OIDC currently.
    password String
    Password of the account to connect to the Kafka cluster.
    saslOauthbearerExtensions String
    SASL OAUTHBEARER extensions parameter for additional OAuth2 configuration.
    scope String
    OIDC scope parameter defining the access permissions requested.
    sslCertificate String
    SSL certificate for client authentication to Kafka.
    sslKey String
    SSL key for client authentication to Kafka.
    sslKeyPassword String
    Password for the SSL key, if it is password protected.
    tokenEndpointUrl String
    OIDC token endpoint URL for obtaining access tokens.
    username String
    Username of the account to connect to the Kafka cluster.

    GetStreamConnectionFailoverDbRoleToExecute

    Role string
    The name of the role to use. Can be a built in role or a custom role.
    Type string
    Type of the DB role. Can be either Built In or Custom.
    Role string
    The name of the role to use. Can be a built in role or a custom role.
    Type string
    Type of the DB role. Can be either Built In or Custom.
    role string
    The name of the role to use. Can be a built in role or a custom role.
    type string
    Type of the DB role. Can be either Built In or Custom.
    role String
    The name of the role to use. Can be a built in role or a custom role.
    type String
    Type of the DB role. Can be either Built In or Custom.
    role string
    The name of the role to use. Can be a built in role or a custom role.
    type string
    Type of the DB role. Can be either Built In or Custom.
    role str
    The name of the role to use. Can be a built in role or a custom role.
    type str
    Type of the DB role. Can be either Built In or Custom.
    role String
    The name of the role to use. Can be a built in role or a custom role.
    type String
    Type of the DB role. Can be either Built In or Custom.

    GetStreamConnectionFailoverNetworking

    Access GetStreamConnectionFailoverNetworkingAccess
    Information about networking access.
    Access GetStreamConnectionFailoverNetworkingAccess
    Information about networking access.
    access object
    Information about networking access.
    access GetStreamConnectionFailoverNetworkingAccess
    Information about networking access.
    access GetStreamConnectionFailoverNetworkingAccess
    Information about networking access.
    access GetStreamConnectionFailoverNetworkingAccess
    Information about networking access.
    access Property Map
    Information about networking access.

    GetStreamConnectionFailoverNetworkingAccess

    ConnectionId string
    Reserved. Will be used by PRIVATE_LINK connection type.
    Name string
    Reserved. Will be used by PRIVATE_LINK connection type.
    TgwRouteId string
    Reserved. Will be used by TRANSIT_GATEWAY connection type.
    Type string
    Selected networking type. Either PUBLIC, VPC, PRIVATE_LINK, or TRANSIT_GATEWAY. Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity has been established between Atlas VPC and the VPC where Kafka cluster is hosted for the connection to function properly. TRANSIT_GATEWAY support is coming soon.
    ConnectionId string
    Reserved. Will be used by PRIVATE_LINK connection type.
    Name string
    Reserved. Will be used by PRIVATE_LINK connection type.
    TgwRouteId string
    Reserved. Will be used by TRANSIT_GATEWAY connection type.
    Type string
    Selected networking type. Either PUBLIC, VPC, PRIVATE_LINK, or TRANSIT_GATEWAY. Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity has been established between Atlas VPC and the VPC where Kafka cluster is hosted for the connection to function properly. TRANSIT_GATEWAY support is coming soon.
    connection_id string
    Reserved. Will be used by PRIVATE_LINK connection type.
    name string
    Reserved. Will be used by PRIVATE_LINK connection type.
    tgw_route_id string
    Reserved. Will be used by TRANSIT_GATEWAY connection type.
    type string
    Selected networking type. Either PUBLIC, VPC, PRIVATE_LINK, or TRANSIT_GATEWAY. Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity has been established between Atlas VPC and the VPC where Kafka cluster is hosted for the connection to function properly. TRANSIT_GATEWAY support is coming soon.
    connectionId String
    Reserved. Will be used by PRIVATE_LINK connection type.
    name String
    Reserved. Will be used by PRIVATE_LINK connection type.
    tgwRouteId String
    Reserved. Will be used by TRANSIT_GATEWAY connection type.
    type String
    Selected networking type. Either PUBLIC, VPC, PRIVATE_LINK, or TRANSIT_GATEWAY. Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity has been established between Atlas VPC and the VPC where Kafka cluster is hosted for the connection to function properly. TRANSIT_GATEWAY support is coming soon.
    connectionId string
    Reserved. Will be used by PRIVATE_LINK connection type.
    name string
    Reserved. Will be used by PRIVATE_LINK connection type.
    tgwRouteId string
    Reserved. Will be used by TRANSIT_GATEWAY connection type.
    type string
    Selected networking type. Either PUBLIC, VPC, PRIVATE_LINK, or TRANSIT_GATEWAY. Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity has been established between Atlas VPC and the VPC where Kafka cluster is hosted for the connection to function properly. TRANSIT_GATEWAY support is coming soon.
    connection_id str
    Reserved. Will be used by PRIVATE_LINK connection type.
    name str
    Reserved. Will be used by PRIVATE_LINK connection type.
    tgw_route_id str
    Reserved. Will be used by TRANSIT_GATEWAY connection type.
    type str
    Selected networking type. Either PUBLIC, VPC, PRIVATE_LINK, or TRANSIT_GATEWAY. Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity has been established between Atlas VPC and the VPC where Kafka cluster is hosted for the connection to function properly. TRANSIT_GATEWAY support is coming soon.
    connectionId String
    Reserved. Will be used by PRIVATE_LINK connection type.
    name String
    Reserved. Will be used by PRIVATE_LINK connection type.
    tgwRouteId String
    Reserved. Will be used by TRANSIT_GATEWAY connection type.
    type String
    Selected networking type. Either PUBLIC, VPC, PRIVATE_LINK, or TRANSIT_GATEWAY. Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity has been established between Atlas VPC and the VPC where Kafka cluster is hosted for the connection to function properly. TRANSIT_GATEWAY support is coming soon.

    GetStreamConnectionFailoverSecurity

    BrokerPublicCertificate string
    A trusted, public x509 certificate for connecting to Kafka over SSL.
    Protocol string
    Describes the transport type. Can be either SASL_PLAINTEXT, SASL_SSL, or SSL.
    BrokerPublicCertificate string
    A trusted, public x509 certificate for connecting to Kafka over SSL.
    Protocol string
    Describes the transport type. Can be either SASL_PLAINTEXT, SASL_SSL, or SSL.
    broker_public_certificate string
    A trusted, public x509 certificate for connecting to Kafka over SSL.
    protocol string
    Describes the transport type. Can be either SASL_PLAINTEXT, SASL_SSL, or SSL.
    brokerPublicCertificate String
    A trusted, public x509 certificate for connecting to Kafka over SSL.
    protocol String
    Describes the transport type. Can be either SASL_PLAINTEXT, SASL_SSL, or SSL.
    brokerPublicCertificate string
    A trusted, public x509 certificate for connecting to Kafka over SSL.
    protocol string
    Describes the transport type. Can be either SASL_PLAINTEXT, SASL_SSL, or SSL.
    broker_public_certificate str
    A trusted, public x509 certificate for connecting to Kafka over SSL.
    protocol str
    Describes the transport type. Can be either SASL_PLAINTEXT, SASL_SSL, or SSL.
    brokerPublicCertificate String
    A trusted, public x509 certificate for connecting to Kafka over SSL.
    protocol String
    Describes the transport type. Can be either SASL_PLAINTEXT, SASL_SSL, or SSL.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    Viewing docs for MongoDB Atlas v4.12.0
    published on Thursday, Jul 16, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-mongodbatlas

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial