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

mongodbatlas.getStreamConnectionFailovers

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

    mongodbatlas.getStreamConnectionFailovers describes all failover (regional-alternate) connections configured for an existing stream connection, identified by the parent connectionName. Only Kafka and Cluster connection types support failover.

    Example Usage

    S

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

// Lists all failover connections configured for a given (primary) stream connection.
const example = mongodbatlas.getStreamConnectionFailovers({
    projectId: projectId,
    workspaceName: exampleMongodbatlasStreamWorkspace.workspaceName,
    connectionName: exampleMongodbatlasStreamConnectionFailover.connectionName,
});
export const failoverRegions = example.then(example => .map(r => (r.region)));

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

# Lists all failover connections configured for a given (primary) stream connection.
example = mongodbatlas.get_stream_connection_failovers(project_id=project_id,
    workspace_name=example_mongodbatlas_stream_workspace["workspaceName"],
    connection_name=example_mongodbatlas_stream_connection_failover["connectionName"])
pulumi.export("failoverRegions", [r.region for r in example.results])

    Example coming soon!

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

return await Deployment.RunAsync(() => 
{
    // Lists all failover connections configured for a given (primary) stream connection.
    var example = Mongodbatlas.GetStreamConnectionFailovers.Invoke(new()
    {
        ProjectId = projectId,
        WorkspaceName = exampleMongodbatlasStreamWorkspace.WorkspaceName,
        ConnectionName = exampleMongodbatlasStreamConnectionFailover.ConnectionName,
    });

    return new Dictionary<string, object?>
    {
        ["failoverRegions"] = .Select(r => 
        {
            return r.Region;
        }).ToList(),
    };
});

    Example coming soon!

    Example coming soon!

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

data "mongodbatlas_getstreamconnectionfailovers" "example" {
  project_id      = projectId
  workspace_name  = exampleMongodbatlasStreamWorkspace.workspaceName
  connection_name = exampleMongodbatlasStreamConnectionFailover.connectionName
}

# Lists all failover connections configured for a given (primary) stream connection.
output "failoverRegions" {
  value = [for r in data.mongodbatlas_getstreamconnectionfailovers.example.results : r.region]
}

    Using getStreamConnectionFailovers

    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 getStreamConnectionFailovers(args: GetStreamConnectionFailoversArgs, opts?: InvokeOptions): Promise<GetStreamConnectionFailoversResult>
function getStreamConnectionFailoversOutput(args: GetStreamConnectionFailoversOutputArgs, opts?: InvokeOptions): Output<GetStreamConnectionFailoversResult>
    def get_stream_connection_failovers(connection_name: Optional[str] = None,
                                    project_id: Optional[str] = None,
                                    workspace_name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetStreamConnectionFailoversResult
def get_stream_connection_failovers_output(connection_name: pulumi.Input[Optional[str]] = None,
                                    project_id: pulumi.Input[Optional[str]] = None,
                                    workspace_name: pulumi.Input[Optional[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetStreamConnectionFailoversResult]
    func LookupStreamConnectionFailovers(ctx *Context, args *LookupStreamConnectionFailoversArgs, opts ...InvokeOption) (*LookupStreamConnectionFailoversResult, error)
func LookupStreamConnectionFailoversOutput(ctx *Context, args *LookupStreamConnectionFailoversOutputArgs, opts ...InvokeOption) LookupStreamConnectionFailoversResultOutput

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

    public static class GetStreamConnectionFailovers 
{
    public static Task<GetStreamConnectionFailoversResult> InvokeAsync(GetStreamConnectionFailoversArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamConnectionFailoversResult> Invoke(GetStreamConnectionFailoversInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetStreamConnectionFailoversResult> getStreamConnectionFailovers(GetStreamConnectionFailoversArgs args, InvokeOptions options)
public static Output<GetStreamConnectionFailoversResult> getStreamConnectionFailovers(GetStreamConnectionFailoversArgs args, InvokeOptions options)

    fn::invoke:
  function: mongodbatlas:index/getStreamConnectionFailovers:getStreamConnectionFailovers
  arguments:
    # arguments dictionary
    data "mongodbatlas_get_stream_connection_failovers" "name" {
    # arguments
}

    The following arguments are supported:

    ConnectionName string
    Label that identifies the stream connection.
    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.
    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.
    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.
    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.
    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.
    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.
    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.

    getStreamConnectionFailovers Result

    The following output properties are available:

    ConnectionName string
    Label that identifies the stream connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    Results List<GetStreamConnectionFailoversResult>
    List of returned documents that MongoDB Cloud provides when completing this request.
    WorkspaceName string
    Label that identifies the stream workspace.
    ConnectionName string
    Label that identifies the stream connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    Results []GetStreamConnectionFailoversResult
    List of returned documents that MongoDB Cloud provides when completing this request.
    WorkspaceName string
    Label that identifies the stream workspace.
    connection_name string
    Label that identifies the stream connection.
    id string
    The provider-assigned unique ID for this managed resource.
    project_id string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    results list(object)
    List of returned documents that MongoDB Cloud provides when completing this request.
    workspace_name string
    Label that identifies the stream workspace.
    connectionName String
    Label that identifies the stream connection.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    results List<GetStreamConnectionFailoversResult>
    List of returned documents that MongoDB Cloud provides when completing this request.
    workspaceName String
    Label that identifies the stream workspace.
    connectionName string
    Label that identifies the stream connection.
    id string
    The provider-assigned unique ID for this managed resource.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    results GetStreamConnectionFailoversResult[]
    List of returned documents that MongoDB Cloud provides when completing this request.
    workspaceName string
    Label that identifies the stream workspace.
    connection_name str
    Label that identifies the stream connection.
    id str
    The provider-assigned unique ID for this managed resource.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    results Sequence[GetStreamConnectionFailoversResult]
    List of returned documents that MongoDB Cloud provides when completing this request.
    workspace_name str
    Label that identifies the stream workspace.
    connectionName String
    Label that identifies the stream connection.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    results List<Property Map>
    List of returned documents that MongoDB Cloud provides when completing this request.
    workspaceName String
    Label that identifies the stream workspace.

    Supporting Types

    GetStreamConnectionFailoversResult

    Authentication GetStreamConnectionFailoversResultAuthentication
    Applies to type: Kafka. User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.
    BootstrapServers string
    Applies to type: Kafka. Comma separated list of server addresses.
    ClusterName string
    Applies to type: Cluster. Name of the cluster configured for this connection.
    ClusterProjectId string
    Applies to type: Cluster. 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 workspace. You must first enable the organization setting.
    Config Dictionary<string, string>
    Applies to type: Kafka. A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    DbRoleToExecute GetStreamConnectionFailoversResultDbRoleToExecute
    Applies to type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    FailoverConnectionId string
    Unique identifier of the connection.
    Networking GetStreamConnectionFailoversResultNetworking
    Applies to type: Kafka. Networking configuration for Streams connections.
    Region string
    The connection's region.
    Security GetStreamConnectionFailoversResultSecurity
    Applies to type: Kafka. Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.
    State string
    The state of the connection.
    Type string
    Type of the connection.
    Authentication GetStreamConnectionFailoversResultAuthentication
    Applies to type: Kafka. User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.
    BootstrapServers string
    Applies to type: Kafka. Comma separated list of server addresses.
    ClusterName string
    Applies to type: Cluster. Name of the cluster configured for this connection.
    ClusterProjectId string
    Applies to type: Cluster. 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 workspace. You must first enable the organization setting.
    Config map[string]string
    Applies to type: Kafka. A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    DbRoleToExecute GetStreamConnectionFailoversResultDbRoleToExecute
    Applies to type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    FailoverConnectionId string
    Unique identifier of the connection.
    Networking GetStreamConnectionFailoversResultNetworking
    Applies to type: Kafka. Networking configuration for Streams connections.
    Region string
    The connection's region.
    Security GetStreamConnectionFailoversResultSecurity
    Applies to type: Kafka. Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.
    State string
    The state of the connection.
    Type string
    Type of the connection.
    authentication object
    Applies to type: Kafka. User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.
    bootstrap_servers string
    Applies to type: Kafka. Comma separated list of server addresses.
    cluster_name string
    Applies to type: Cluster. Name of the cluster configured for this connection.
    cluster_project_id string
    Applies to type: Cluster. 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 workspace. You must first enable the organization setting.
    config map(string)
    Applies to type: Kafka. A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    db_role_to_execute object
    Applies to type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    failover_connection_id string
    Unique identifier of the connection.
    networking object
    Applies to type: Kafka. Networking configuration for Streams connections.
    region string
    The connection's region.
    security object
    Applies to type: Kafka. Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.
    state string
    The state of the connection.
    type string
    Type of the connection.
    authentication GetStreamConnectionFailoversResultAuthentication
    Applies to type: Kafka. User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.
    bootstrapServers String
    Applies to type: Kafka. Comma separated list of server addresses.
    clusterName String
    Applies to type: Cluster. Name of the cluster configured for this connection.
    clusterProjectId String
    Applies to type: Cluster. 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 workspace. You must first enable the organization setting.
    config Map<String,String>
    Applies to type: Kafka. A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    dbRoleToExecute GetStreamConnectionFailoversResultDbRoleToExecute
    Applies to type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    failoverConnectionId String
    Unique identifier of the connection.
    networking GetStreamConnectionFailoversResultNetworking
    Applies to type: Kafka. Networking configuration for Streams connections.
    region String
    The connection's region.
    security GetStreamConnectionFailoversResultSecurity
    Applies to type: Kafka. Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.
    state String
    The state of the connection.
    type String
    Type of the connection.
    authentication GetStreamConnectionFailoversResultAuthentication
    Applies to type: Kafka. User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.
    bootstrapServers string
    Applies to type: Kafka. Comma separated list of server addresses.
    clusterName string
    Applies to type: Cluster. Name of the cluster configured for this connection.
    clusterProjectId string
    Applies to type: Cluster. 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 workspace. You must first enable the organization setting.
    config {[key: string]: string}
    Applies to type: Kafka. A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    dbRoleToExecute GetStreamConnectionFailoversResultDbRoleToExecute
    Applies to type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    failoverConnectionId string
    Unique identifier of the connection.
    networking GetStreamConnectionFailoversResultNetworking
    Applies to type: Kafka. Networking configuration for Streams connections.
    region string
    The connection's region.
    security GetStreamConnectionFailoversResultSecurity
    Applies to type: Kafka. Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.
    state string
    The state of the connection.
    type string
    Type of the connection.
    authentication GetStreamConnectionFailoversResultAuthentication
    Applies to type: Kafka. User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.
    bootstrap_servers str
    Applies to type: Kafka. Comma separated list of server addresses.
    cluster_name str
    Applies to type: Cluster. Name of the cluster configured for this connection.
    cluster_project_id str
    Applies to type: Cluster. 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 workspace. You must first enable the organization setting.
    config Mapping[str, str]
    Applies to type: Kafka. A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    db_role_to_execute GetStreamConnectionFailoversResultDbRoleToExecute
    Applies to type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    failover_connection_id str
    Unique identifier of the connection.
    networking GetStreamConnectionFailoversResultNetworking
    Applies to type: Kafka. Networking configuration for Streams connections.
    region str
    The connection's region.
    security GetStreamConnectionFailoversResultSecurity
    Applies to type: Kafka. Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.
    state str
    The state of the connection.
    type str
    Type of the connection.
    authentication Property Map
    Applies to type: Kafka. User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.
    bootstrapServers String
    Applies to type: Kafka. Comma separated list of server addresses.
    clusterName String
    Applies to type: Cluster. Name of the cluster configured for this connection.
    clusterProjectId String
    Applies to type: Cluster. 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 workspace. You must first enable the organization setting.
    config Map<String>
    Applies to type: Kafka. A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    dbRoleToExecute Property Map
    Applies to type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    failoverConnectionId String
    Unique identifier of the connection.
    networking Property Map
    Applies to type: Kafka. Networking configuration for Streams connections.
    region String
    The connection's region.
    security Property Map
    Applies to type: Kafka. Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.
    state String
    The state of the connection.
    type String
    Type of the connection.

    GetStreamConnectionFailoversResultAuthentication

    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.

    GetStreamConnectionFailoversResultDbRoleToExecute

    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.

    GetStreamConnectionFailoversResultNetworking

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

    GetStreamConnectionFailoversResultNetworkingAccess

    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.

    GetStreamConnectionFailoversResultSecurity

    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