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

mongodbatlas.StreamConnectionFailover

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 provides a Stream Failover Connection resource. It lets you create, update, delete, and import a failover (regional-alternate) connection for an existing stream connection.

    A failover connection shares its primary connection’s connectionName and is created for one of the workspace’s failover regions (configured via the failoverRegions argument of mongodbatlas.StreamWorkspace). It is uniquely identified by its computed failoverConnectionId and carries its own regional connection configuration in the region attribute. Only Kafka and Cluster connection types support failover.

    Example Usage

    S

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

const example = new mongodbatlas.StreamWorkspace("example", {
    projectId: projectId,
    workspaceName: "workspace-with-failover",
    dataProcessRegion: {
        region: "VIRGINIA_USA",
        cloudProvider: "AWS",
    },
    failoverRegions: [{
        region: "DUBLIN_IRL",
        cloudProvider: "AWS",
    }],
    streamConfig: {
        tier: "SP10",
    },
});
// The primary (default-region) stream connection.
const exampleStreamConnection = new mongodbatlas.StreamConnection("example", {
    projectId: projectId,
    workspaceName: example.workspaceName,
    connectionName: "KafkaConnection",
    type: "Kafka",
    bootstrapServers: bootstrapServers,
    authentication: {
        mechanism: "PLAIN",
        username: kafkaUsername,
        password: kafkaPassword,
    },
    security: {
        protocol: "SASL_SSL",
    },
});
// A failover connection shares the primary connection's name and is created for one of the
// workspace's failover regions, with its own regional configuration.
const exampleStreamConnectionFailover = new mongodbatlas.StreamConnectionFailover("example", {
    projectId: projectId,
    workspaceName: example.workspaceName,
    connectionName: exampleStreamConnection.connectionName,
    region: "DUBLIN_IRL",
    type: "Kafka",
    bootstrapServers: failoverBootstrapServers,
    authentication: {
        mechanism: "PLAIN",
        username: failoverKafkaUsername,
        password: failoverKafkaPassword,
    },
    security: {
        protocol: "SASL_SSL",
    },
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

example = mongodbatlas.StreamWorkspace("example",
    project_id=project_id,
    workspace_name="workspace-with-failover",
    data_process_region={
        "region": "VIRGINIA_USA",
        "cloud_provider": "AWS",
    },
    failover_regions=[{
        "region": "DUBLIN_IRL",
        "cloud_provider": "AWS",
    }],
    stream_config={
        "tier": "SP10",
    })
# The primary (default-region) stream connection.
example_stream_connection = mongodbatlas.StreamConnection("example",
    project_id=project_id,
    workspace_name=example.workspace_name,
    connection_name="KafkaConnection",
    type="Kafka",
    bootstrap_servers=bootstrap_servers,
    authentication={
        "mechanism": "PLAIN",
        "username": kafka_username,
        "password": kafka_password,
    },
    security={
        "protocol": "SASL_SSL",
    })
# A failover connection shares the primary connection's name and is created for one of the
# workspace's failover regions, with its own regional configuration.
example_stream_connection_failover = mongodbatlas.StreamConnectionFailover("example",
    project_id=project_id,
    workspace_name=example.workspace_name,
    connection_name=example_stream_connection.connection_name,
    region="DUBLIN_IRL",
    type="Kafka",
    bootstrap_servers=failover_bootstrap_servers,
    authentication={
        "mechanism": "PLAIN",
        "username": failover_kafka_username,
        "password": failover_kafka_password,
    },
    security={
        "protocol": "SASL_SSL",
    })

    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 {
		example, err := mongodbatlas.NewStreamWorkspace(ctx, "example", &mongodbatlas.StreamWorkspaceArgs{
			ProjectId:     pulumi.Any(projectId),
			WorkspaceName: pulumi.String("workspace-with-failover"),
			DataProcessRegion: &mongodbatlas.StreamWorkspaceDataProcessRegionArgs{
				Region:        pulumi.String("VIRGINIA_USA"),
				CloudProvider: pulumi.String("AWS"),
			},
			FailoverRegions: mongodbatlas.StreamWorkspaceFailoverRegionArray{
				&mongodbatlas.StreamWorkspaceFailoverRegionArgs{
					Region:        pulumi.String("DUBLIN_IRL"),
					CloudProvider: pulumi.String("AWS"),
				},
			},
			StreamConfig: &mongodbatlas.StreamWorkspaceStreamConfigArgs{
				Tier: pulumi.String("SP10"),
			},
		})
		if err != nil {
			return err
		}
		// The primary (default-region) stream connection.
		exampleStreamConnection, err := mongodbatlas.NewStreamConnection(ctx, "example", &mongodbatlas.StreamConnectionArgs{
			ProjectId:        pulumi.Any(projectId),
			WorkspaceName:    example.WorkspaceName,
			ConnectionName:   pulumi.String("KafkaConnection"),
			Type:             pulumi.String("Kafka"),
			BootstrapServers: pulumi.Any(bootstrapServers),
			Authentication: &mongodbatlas.StreamConnectionAuthenticationArgs{
				Mechanism: pulumi.String("PLAIN"),
				Username:  pulumi.Any(kafkaUsername),
				Password:  pulumi.Any(kafkaPassword),
			},
			Security: &mongodbatlas.StreamConnectionSecurityArgs{
				Protocol: pulumi.String("SASL_SSL"),
			},
		})
		if err != nil {
			return err
		}
		// A failover connection shares the primary connection's name and is created for one of the
		// workspace's failover regions, with its own regional configuration.
		_, err = mongodbatlas.NewStreamConnectionFailover(ctx, "example", &mongodbatlas.StreamConnectionFailoverArgs{
			ProjectId:        pulumi.Any(projectId),
			WorkspaceName:    example.WorkspaceName,
			ConnectionName:   exampleStreamConnection.ConnectionName,
			Region:           pulumi.String("DUBLIN_IRL"),
			Type:             pulumi.String("Kafka"),
			BootstrapServers: pulumi.Any(failoverBootstrapServers),
			Authentication: &mongodbatlas.StreamConnectionFailoverAuthenticationArgs{
				Mechanism: pulumi.String("PLAIN"),
				Username:  pulumi.Any(failoverKafkaUsername),
				Password:  pulumi.Any(failoverKafkaPassword),
			},
			Security: &mongodbatlas.StreamConnectionFailoverSecurityArgs{
				Protocol: pulumi.String("SASL_SSL"),
			},
		})
		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 = new Mongodbatlas.StreamWorkspace("example", new()
    {
        ProjectId = projectId,
        WorkspaceName = "workspace-with-failover",
        DataProcessRegion = new Mongodbatlas.Inputs.StreamWorkspaceDataProcessRegionArgs
        {
            Region = "VIRGINIA_USA",
            CloudProvider = "AWS",
        },
        FailoverRegions = new[]
        {
            new Mongodbatlas.Inputs.StreamWorkspaceFailoverRegionArgs
            {
                Region = "DUBLIN_IRL",
                CloudProvider = "AWS",
            },
        },
        StreamConfig = new Mongodbatlas.Inputs.StreamWorkspaceStreamConfigArgs
        {
            Tier = "SP10",
        },
    });

    // The primary (default-region) stream connection.
    var exampleStreamConnection = new Mongodbatlas.StreamConnection("example", new()
    {
        ProjectId = projectId,
        WorkspaceName = example.WorkspaceName,
        ConnectionName = "KafkaConnection",
        Type = "Kafka",
        BootstrapServers = bootstrapServers,
        Authentication = new Mongodbatlas.Inputs.StreamConnectionAuthenticationArgs
        {
            Mechanism = "PLAIN",
            Username = kafkaUsername,
            Password = kafkaPassword,
        },
        Security = new Mongodbatlas.Inputs.StreamConnectionSecurityArgs
        {
            Protocol = "SASL_SSL",
        },
    });

    // A failover connection shares the primary connection's name and is created for one of the
    // workspace's failover regions, with its own regional configuration.
    var exampleStreamConnectionFailover = new Mongodbatlas.StreamConnectionFailover("example", new()
    {
        ProjectId = projectId,
        WorkspaceName = example.WorkspaceName,
        ConnectionName = exampleStreamConnection.ConnectionName,
        Region = "DUBLIN_IRL",
        Type = "Kafka",
        BootstrapServers = failoverBootstrapServers,
        Authentication = new Mongodbatlas.Inputs.StreamConnectionFailoverAuthenticationArgs
        {
            Mechanism = "PLAIN",
            Username = failoverKafkaUsername,
            Password = failoverKafkaPassword,
        },
        Security = new Mongodbatlas.Inputs.StreamConnectionFailoverSecurityArgs
        {
            Protocol = "SASL_SSL",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.StreamWorkspace;
import com.pulumi.mongodbatlas.StreamWorkspaceArgs;
import com.pulumi.mongodbatlas.inputs.StreamWorkspaceDataProcessRegionArgs;
import com.pulumi.mongodbatlas.inputs.StreamWorkspaceFailoverRegionArgs;
import com.pulumi.mongodbatlas.inputs.StreamWorkspaceStreamConfigArgs;
import com.pulumi.mongodbatlas.StreamConnection;
import com.pulumi.mongodbatlas.StreamConnectionArgs;
import com.pulumi.mongodbatlas.inputs.StreamConnectionAuthenticationArgs;
import com.pulumi.mongodbatlas.inputs.StreamConnectionSecurityArgs;
import com.pulumi.mongodbatlas.StreamConnectionFailover;
import com.pulumi.mongodbatlas.StreamConnectionFailoverArgs;
import com.pulumi.mongodbatlas.inputs.StreamConnectionFailoverAuthenticationArgs;
import com.pulumi.mongodbatlas.inputs.StreamConnectionFailoverSecurityArgs;
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) {
        var example = new StreamWorkspace("example", StreamWorkspaceArgs.builder()
            .projectId(projectId)
            .workspaceName("workspace-with-failover")
            .dataProcessRegion(StreamWorkspaceDataProcessRegionArgs.builder()
                .region("VIRGINIA_USA")
                .cloudProvider("AWS")
                .build())
            .failoverRegions(StreamWorkspaceFailoverRegionArgs.builder()
                .region("DUBLIN_IRL")
                .cloudProvider("AWS")
                .build())
            .streamConfig(StreamWorkspaceStreamConfigArgs.builder()
                .tier("SP10")
                .build())
            .build());

        // The primary (default-region) stream connection.
        var exampleStreamConnection = new StreamConnection("exampleStreamConnection", StreamConnectionArgs.builder()
            .projectId(projectId)
            .workspaceName(example.workspaceName())
            .connectionName("KafkaConnection")
            .type("Kafka")
            .bootstrapServers(bootstrapServers)
            .authentication(StreamConnectionAuthenticationArgs.builder()
                .mechanism("PLAIN")
                .username(kafkaUsername)
                .password(kafkaPassword)
                .build())
            .security(StreamConnectionSecurityArgs.builder()
                .protocol("SASL_SSL")
                .build())
            .build());

        // A failover connection shares the primary connection's name and is created for one of the
        // workspace's failover regions, with its own regional configuration.
        var exampleStreamConnectionFailover = new StreamConnectionFailover("exampleStreamConnectionFailover", StreamConnectionFailoverArgs.builder()
            .projectId(projectId)
            .workspaceName(example.workspaceName())
            .connectionName(exampleStreamConnection.connectionName())
            .region("DUBLIN_IRL")
            .type("Kafka")
            .bootstrapServers(failoverBootstrapServers)
            .authentication(StreamConnectionFailoverAuthenticationArgs.builder()
                .mechanism("PLAIN")
                .username(failoverKafkaUsername)
                .password(failoverKafkaPassword)
                .build())
            .security(StreamConnectionFailoverSecurityArgs.builder()
                .protocol("SASL_SSL")
                .build())
            .build());

    }
}

    resources:
  example:
    type: mongodbatlas:StreamWorkspace
    properties:
      projectId: ${projectId}
      workspaceName: workspace-with-failover
      dataProcessRegion:
        region: VIRGINIA_USA
        cloudProvider: AWS
      failoverRegions:
        - region: DUBLIN_IRL
          cloudProvider: AWS
      streamConfig:
        tier: SP10
  # The primary (default-region) stream connection.
  exampleStreamConnection:
    type: mongodbatlas:StreamConnection
    name: example
    properties:
      projectId: ${projectId}
      workspaceName: ${example.workspaceName}
      connectionName: KafkaConnection
      type: Kafka
      bootstrapServers: ${bootstrapServers}
      authentication:
        mechanism: PLAIN
        username: ${kafkaUsername}
        password: ${kafkaPassword}
      security:
        protocol: SASL_SSL
  # A failover connection shares the primary connection's name and is created for one of the
  # workspace's failover regions, with its own regional configuration.
  exampleStreamConnectionFailover:
    type: mongodbatlas:StreamConnectionFailover
    name: example
    properties:
      projectId: ${projectId}
      workspaceName: ${example.workspaceName}
      connectionName: ${exampleStreamConnection.connectionName}
      region: DUBLIN_IRL
      type: Kafka
      bootstrapServers: ${failoverBootstrapServers}
      authentication:
        mechanism: PLAIN
        username: ${failoverKafkaUsername}
        password: ${failoverKafkaPassword}
      security:
        protocol: SASL_SSL

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

resource "mongodbatlas_streamworkspace" "example" {
  project_id     = projectId
  workspace_name = "workspace-with-failover"
  data_process_region = {
    region         = "VIRGINIA_USA"
    cloud_provider = "AWS"
  }
  failover_regions {
    region         = "DUBLIN_IRL"
    cloud_provider = "AWS"
  }
  stream_config = {
    tier = "SP10"
  }
}
# The primary (default-region) stream connection.
resource "mongodbatlas_streamconnection" "example" {
  project_id        = projectId
  workspace_name    = mongodbatlas_streamworkspace.example.workspace_name
  connection_name   = "KafkaConnection"
  type              = "Kafka"
  bootstrap_servers = bootstrapServers
  authentication = {
    mechanism = "PLAIN"
    username  = kafkaUsername
    password  = kafkaPassword
  }
  security = {
    protocol = "SASL_SSL"
  }
}
# A failover connection shares the primary connection's name and is created for one of the
# workspace's failover regions, with its own regional configuration.
resource "mongodbatlas_streamconnectionfailover" "example" {
  project_id        = projectId
  workspace_name    = mongodbatlas_streamworkspace.example.workspace_name
  connection_name   = mongodbatlas_streamconnection.example.connection_name
  region            = "DUBLIN_IRL"
  type              = "Kafka"
  bootstrap_servers = failoverBootstrapServers
  authentication = {
    mechanism = "PLAIN"
    username  = failoverKafkaUsername
    password  = failoverKafkaPassword
  }
  security = {
    protocol = "SASL_SSL"
  }
}

    Create StreamConnectionFailover Resource

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

    Constructor syntax

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

@overload
def StreamConnectionFailover(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             connection_name: Optional[str] = None,
                             workspace_name: Optional[str] = None,
                             type: Optional[str] = None,
                             region: Optional[str] = None,
                             project_id: Optional[str] = None,
                             cluster_project_id: Optional[str] = None,
                             db_role_to_execute: Optional[StreamConnectionFailoverDbRoleToExecuteArgs] = None,
                             delete_on_create_timeout: Optional[bool] = None,
                             networking: Optional[StreamConnectionFailoverNetworkingArgs] = None,
                             config: Optional[Mapping[str, str]] = None,
                             authentication: Optional[StreamConnectionFailoverAuthenticationArgs] = None,
                             security: Optional[StreamConnectionFailoverSecurityArgs] = None,
                             timeouts: Optional[StreamConnectionFailoverTimeoutsArgs] = None,
                             cluster_name: Optional[str] = None,
                             bootstrap_servers: Optional[str] = None)
    func NewStreamConnectionFailover(ctx *Context, name string, args StreamConnectionFailoverArgs, opts ...ResourceOption) (*StreamConnectionFailover, error)
    public StreamConnectionFailover(string name, StreamConnectionFailoverArgs args, CustomResourceOptions? opts = null)
    public StreamConnectionFailover(String name, StreamConnectionFailoverArgs args)
public StreamConnectionFailover(String name, StreamConnectionFailoverArgs args, CustomResourceOptions options)

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


    resource "mongodbatlas_stream_connection_failover" "name" {
    # resource properties
}

    Parameters

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

    Constructor example

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

    var streamConnectionFailoverResource = new Mongodbatlas.StreamConnectionFailover("streamConnectionFailoverResource", new()
{
    ConnectionName = "string",
    WorkspaceName = "string",
    Type = "string",
    Region = "string",
    ProjectId = "string",
    ClusterProjectId = "string",
    DbRoleToExecute = new Mongodbatlas.Inputs.StreamConnectionFailoverDbRoleToExecuteArgs
    {
        Role = "string",
        Type = "string",
    },
    DeleteOnCreateTimeout = false,
    Networking = new Mongodbatlas.Inputs.StreamConnectionFailoverNetworkingArgs
    {
        Access = new Mongodbatlas.Inputs.StreamConnectionFailoverNetworkingAccessArgs
        {
            ConnectionId = "string",
            Name = "string",
            TgwRouteId = "string",
            Type = "string",
        },
    },
    Config = 
    {
        { "string", "string" },
    },
    Authentication = new Mongodbatlas.Inputs.StreamConnectionFailoverAuthenticationArgs
    {
        ClientId = "string",
        ClientSecret = "string",
        Mechanism = "string",
        Method = "string",
        Password = "string",
        SaslOauthbearerExtensions = "string",
        Scope = "string",
        SslCertificate = "string",
        SslKey = "string",
        SslKeyPassword = "string",
        TokenEndpointUrl = "string",
        Username = "string",
    },
    Security = new Mongodbatlas.Inputs.StreamConnectionFailoverSecurityArgs
    {
        BrokerPublicCertificate = "string",
        Protocol = "string",
    },
    Timeouts = new Mongodbatlas.Inputs.StreamConnectionFailoverTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    ClusterName = "string",
    BootstrapServers = "string",
});

    example, err := mongodbatlas.NewStreamConnectionFailover(ctx, "streamConnectionFailoverResource", &mongodbatlas.StreamConnectionFailoverArgs{
	ConnectionName:   pulumi.String("string"),
	WorkspaceName:    pulumi.String("string"),
	Type:             pulumi.String("string"),
	Region:           pulumi.String("string"),
	ProjectId:        pulumi.String("string"),
	ClusterProjectId: pulumi.String("string"),
	DbRoleToExecute: &mongodbatlas.StreamConnectionFailoverDbRoleToExecuteArgs{
		Role: pulumi.String("string"),
		Type: pulumi.String("string"),
	},
	DeleteOnCreateTimeout: pulumi.Bool(false),
	Networking: &mongodbatlas.StreamConnectionFailoverNetworkingArgs{
		Access: &mongodbatlas.StreamConnectionFailoverNetworkingAccessArgs{
			ConnectionId: pulumi.String("string"),
			Name:         pulumi.String("string"),
			TgwRouteId:   pulumi.String("string"),
			Type:         pulumi.String("string"),
		},
	},
	Config: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Authentication: &mongodbatlas.StreamConnectionFailoverAuthenticationArgs{
		ClientId:                  pulumi.String("string"),
		ClientSecret:              pulumi.String("string"),
		Mechanism:                 pulumi.String("string"),
		Method:                    pulumi.String("string"),
		Password:                  pulumi.String("string"),
		SaslOauthbearerExtensions: pulumi.String("string"),
		Scope:                     pulumi.String("string"),
		SslCertificate:            pulumi.String("string"),
		SslKey:                    pulumi.String("string"),
		SslKeyPassword:            pulumi.String("string"),
		TokenEndpointUrl:          pulumi.String("string"),
		Username:                  pulumi.String("string"),
	},
	Security: &mongodbatlas.StreamConnectionFailoverSecurityArgs{
		BrokerPublicCertificate: pulumi.String("string"),
		Protocol:                pulumi.String("string"),
	},
	Timeouts: &mongodbatlas.StreamConnectionFailoverTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	ClusterName:      pulumi.String("string"),
	BootstrapServers: pulumi.String("string"),
})

    resource "mongodbatlas_stream_connection_failover" "streamConnectionFailoverResource" {
  lifecycle {
    create_before_destroy = true
  }
  connection_name    = "string"
  workspace_name     = "string"
  type               = "string"
  region             = "string"
  project_id         = "string"
  cluster_project_id = "string"
  db_role_to_execute = {
    role = "string"
    type = "string"
  }
  delete_on_create_timeout = false
  networking = {
    access = {
      connection_id = "string"
      name          = "string"
      tgw_route_id  = "string"
      type          = "string"
    }
  }
  config = {
    "string" = "string"
  }
  authentication = {
    client_id                   = "string"
    client_secret               = "string"
    mechanism                   = "string"
    method                      = "string"
    password                    = "string"
    sasl_oauthbearer_extensions = "string"
    scope                       = "string"
    ssl_certificate             = "string"
    ssl_key                     = "string"
    ssl_key_password            = "string"
    token_endpoint_url          = "string"
    username                    = "string"
  }
  security = {
    broker_public_certificate = "string"
    protocol                  = "string"
  }
  timeouts = {
    create = "string"
    delete = "string"
    update = "string"
  }
  cluster_name      = "string"
  bootstrap_servers = "string"
}

    var streamConnectionFailoverResource = new StreamConnectionFailover("streamConnectionFailoverResource", StreamConnectionFailoverArgs.builder()
    .connectionName("string")
    .workspaceName("string")
    .type("string")
    .region("string")
    .projectId("string")
    .clusterProjectId("string")
    .dbRoleToExecute(StreamConnectionFailoverDbRoleToExecuteArgs.builder()
        .role("string")
        .type("string")
        .build())
    .deleteOnCreateTimeout(false)
    .networking(StreamConnectionFailoverNetworkingArgs.builder()
        .access(StreamConnectionFailoverNetworkingAccessArgs.builder()
            .connectionId("string")
            .name("string")
            .tgwRouteId("string")
            .type("string")
            .build())
        .build())
    .config(Map.of("string", "string"))
    .authentication(StreamConnectionFailoverAuthenticationArgs.builder()
        .clientId("string")
        .clientSecret("string")
        .mechanism("string")
        .method("string")
        .password("string")
        .saslOauthbearerExtensions("string")
        .scope("string")
        .sslCertificate("string")
        .sslKey("string")
        .sslKeyPassword("string")
        .tokenEndpointUrl("string")
        .username("string")
        .build())
    .security(StreamConnectionFailoverSecurityArgs.builder()
        .brokerPublicCertificate("string")
        .protocol("string")
        .build())
    .timeouts(StreamConnectionFailoverTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .clusterName("string")
    .bootstrapServers("string")
    .build());

    stream_connection_failover_resource = mongodbatlas.StreamConnectionFailover("streamConnectionFailoverResource",
    connection_name="string",
    workspace_name="string",
    type="string",
    region="string",
    project_id="string",
    cluster_project_id="string",
    db_role_to_execute={
        "role": "string",
        "type": "string",
    },
    delete_on_create_timeout=False,
    networking={
        "access": {
            "connection_id": "string",
            "name": "string",
            "tgw_route_id": "string",
            "type": "string",
        },
    },
    config={
        "string": "string",
    },
    authentication={
        "client_id": "string",
        "client_secret": "string",
        "mechanism": "string",
        "method": "string",
        "password": "string",
        "sasl_oauthbearer_extensions": "string",
        "scope": "string",
        "ssl_certificate": "string",
        "ssl_key": "string",
        "ssl_key_password": "string",
        "token_endpoint_url": "string",
        "username": "string",
    },
    security={
        "broker_public_certificate": "string",
        "protocol": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    cluster_name="string",
    bootstrap_servers="string")

    const streamConnectionFailoverResource = new mongodbatlas.StreamConnectionFailover("streamConnectionFailoverResource", {
    connectionName: "string",
    workspaceName: "string",
    type: "string",
    region: "string",
    projectId: "string",
    clusterProjectId: "string",
    dbRoleToExecute: {
        role: "string",
        type: "string",
    },
    deleteOnCreateTimeout: false,
    networking: {
        access: {
            connectionId: "string",
            name: "string",
            tgwRouteId: "string",
            type: "string",
        },
    },
    config: {
        string: "string",
    },
    authentication: {
        clientId: "string",
        clientSecret: "string",
        mechanism: "string",
        method: "string",
        password: "string",
        saslOauthbearerExtensions: "string",
        scope: "string",
        sslCertificate: "string",
        sslKey: "string",
        sslKeyPassword: "string",
        tokenEndpointUrl: "string",
        username: "string",
    },
    security: {
        brokerPublicCertificate: "string",
        protocol: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    clusterName: "string",
    bootstrapServers: "string",
});

    type: mongodbatlas:StreamConnectionFailover
properties:
    authentication:
        clientId: string
        clientSecret: string
        mechanism: string
        method: string
        password: string
        saslOauthbearerExtensions: string
        scope: string
        sslCertificate: string
        sslKey: string
        sslKeyPassword: string
        tokenEndpointUrl: string
        username: string
    bootstrapServers: string
    clusterName: string
    clusterProjectId: string
    config:
        string: string
    connectionName: string
    dbRoleToExecute:
        role: string
        type: string
    deleteOnCreateTimeout: false
    networking:
        access:
            connectionId: string
            name: string
            tgwRouteId: string
            type: string
    projectId: string
    region: string
    security:
        brokerPublicCertificate: string
        protocol: string
    timeouts:
        create: string
        delete: string
        update: string
    type: string
    workspaceName: string

    StreamConnectionFailover Resource Properties

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

    Inputs

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

    The StreamConnectionFailover resource accepts the following input properties:

    ConnectionName string
    Label that identifies the stream connection name.
    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.
    Type string
    Type of the connection.
    WorkspaceName string
    Label that identifies the stream workspace.
    Authentication StreamConnectionFailoverAuthentication
    Optional for 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
    Optional for type: Kafka. Comma separated list of server addresses.
    ClusterName string
    Optional for type: Cluster. Name of the cluster configured for this connection.
    ClusterProjectId string
    Optional for 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>
    Optional for type: Kafka. A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    DbRoleToExecute StreamConnectionFailoverDbRoleToExecute
    Optional for type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    DeleteOnCreateTimeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    Networking StreamConnectionFailoverNetworking
    Optional for type: Kafka. Networking configuration for Streams connections.
    Security StreamConnectionFailoverSecurity
    Optional for type: Kafka. Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.
    Timeouts StreamConnectionFailoverTimeouts
    ConnectionName string
    Label that identifies the stream connection name.
    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.
    Type string
    Type of the connection.
    WorkspaceName string
    Label that identifies the stream workspace.
    Authentication StreamConnectionFailoverAuthenticationArgs
    Optional for 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
    Optional for type: Kafka. Comma separated list of server addresses.
    ClusterName string
    Optional for type: Cluster. Name of the cluster configured for this connection.
    ClusterProjectId string
    Optional for 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
    Optional for type: Kafka. A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    DbRoleToExecute StreamConnectionFailoverDbRoleToExecuteArgs
    Optional for type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    DeleteOnCreateTimeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    Networking StreamConnectionFailoverNetworkingArgs
    Optional for type: Kafka. Networking configuration for Streams connections.
    Security StreamConnectionFailoverSecurityArgs
    Optional for type: Kafka. Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.
    Timeouts StreamConnectionFailoverTimeoutsArgs
    connection_name string
    Label that identifies the stream connection name.
    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.
    type string
    Type of the connection.
    workspace_name string
    Label that identifies the stream workspace.
    authentication object
    Optional for 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
    Optional for type: Kafka. Comma separated list of server addresses.
    cluster_name string
    Optional for type: Cluster. Name of the cluster configured for this connection.
    cluster_project_id string
    Optional for 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)
    Optional for 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
    Optional for type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    delete_on_create_timeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    networking object
    Optional for type: Kafka. Networking configuration for Streams connections.
    security object
    Optional for type: Kafka. Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.
    timeouts object
    connectionName String
    Label that identifies the stream connection name.
    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.
    type String
    Type of the connection.
    workspaceName String
    Label that identifies the stream workspace.
    authentication StreamConnectionFailoverAuthentication
    Optional for 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
    Optional for type: Kafka. Comma separated list of server addresses.
    clusterName String
    Optional for type: Cluster. Name of the cluster configured for this connection.
    clusterProjectId String
    Optional for 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>
    Optional for type: Kafka. A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    dbRoleToExecute StreamConnectionFailoverDbRoleToExecute
    Optional for type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    deleteOnCreateTimeout Boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    networking StreamConnectionFailoverNetworking
    Optional for type: Kafka. Networking configuration for Streams connections.
    security StreamConnectionFailoverSecurity
    Optional for type: Kafka. Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.
    timeouts StreamConnectionFailoverTimeouts
    connectionName string
    Label that identifies the stream connection name.
    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.
    type string
    Type of the connection.
    workspaceName string
    Label that identifies the stream workspace.
    authentication StreamConnectionFailoverAuthentication
    Optional for 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
    Optional for type: Kafka. Comma separated list of server addresses.
    clusterName string
    Optional for type: Cluster. Name of the cluster configured for this connection.
    clusterProjectId string
    Optional for 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}
    Optional for type: Kafka. A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    dbRoleToExecute StreamConnectionFailoverDbRoleToExecute
    Optional for type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    deleteOnCreateTimeout boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    networking StreamConnectionFailoverNetworking
    Optional for type: Kafka. Networking configuration for Streams connections.
    security StreamConnectionFailoverSecurity
    Optional for type: Kafka. Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.
    timeouts StreamConnectionFailoverTimeouts
    connection_name str
    Label that identifies the stream connection name.
    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.
    type str
    Type of the connection.
    workspace_name str
    Label that identifies the stream workspace.
    authentication StreamConnectionFailoverAuthenticationArgs
    Optional for 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
    Optional for type: Kafka. Comma separated list of server addresses.
    cluster_name str
    Optional for type: Cluster. Name of the cluster configured for this connection.
    cluster_project_id str
    Optional for 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]
    Optional for 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 StreamConnectionFailoverDbRoleToExecuteArgs
    Optional for type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    delete_on_create_timeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    networking StreamConnectionFailoverNetworkingArgs
    Optional for type: Kafka. Networking configuration for Streams connections.
    security StreamConnectionFailoverSecurityArgs
    Optional for type: Kafka. Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.
    timeouts StreamConnectionFailoverTimeoutsArgs
    connectionName String
    Label that identifies the stream connection name.
    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.
    type String
    Type of the connection.
    workspaceName String
    Label that identifies the stream workspace.
    authentication Property Map
    Optional for 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
    Optional for type: Kafka. Comma separated list of server addresses.
    clusterName String
    Optional for type: Cluster. Name of the cluster configured for this connection.
    clusterProjectId String
    Optional for 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>
    Optional for 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
    Optional for type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    deleteOnCreateTimeout Boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    networking Property Map
    Optional for type: Kafka. Networking configuration for Streams connections.
    security Property Map
    Optional for type: Kafka. Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.
    timeouts Property Map

    Outputs

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

    FailoverConnectionId string
    Unique identifier of the connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The state of the connection.
    FailoverConnectionId string
    Unique identifier of the connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The state of the connection.
    failover_connection_id string
    Unique identifier of the connection.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The state of the connection.
    failoverConnectionId String
    Unique identifier of the connection.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The state of the connection.
    failoverConnectionId string
    Unique identifier of the connection.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The state of the connection.
    failover_connection_id str
    Unique identifier of the connection.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The state of the connection.
    failoverConnectionId String
    Unique identifier of the connection.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The state of the connection.

    Look up Existing StreamConnectionFailover Resource

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

    public static get(name: string, id: Input<ID>, state?: StreamConnectionFailoverState, opts?: CustomResourceOptions): StreamConnectionFailover
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication: Optional[StreamConnectionFailoverAuthenticationArgs] = None,
        bootstrap_servers: Optional[str] = None,
        cluster_name: Optional[str] = None,
        cluster_project_id: Optional[str] = None,
        config: Optional[Mapping[str, str]] = None,
        connection_name: Optional[str] = None,
        db_role_to_execute: Optional[StreamConnectionFailoverDbRoleToExecuteArgs] = None,
        delete_on_create_timeout: Optional[bool] = None,
        failover_connection_id: Optional[str] = None,
        networking: Optional[StreamConnectionFailoverNetworkingArgs] = None,
        project_id: Optional[str] = None,
        region: Optional[str] = None,
        security: Optional[StreamConnectionFailoverSecurityArgs] = None,
        state: Optional[str] = None,
        timeouts: Optional[StreamConnectionFailoverTimeoutsArgs] = None,
        type: Optional[str] = None,
        workspace_name: Optional[str] = None) -> StreamConnectionFailover
    func GetStreamConnectionFailover(ctx *Context, name string, id IDInput, state *StreamConnectionFailoverState, opts ...ResourceOption) (*StreamConnectionFailover, error)
    public static StreamConnectionFailover Get(string name, Input<string> id, StreamConnectionFailoverState? state, CustomResourceOptions? opts = null)
    public static StreamConnectionFailover get(String name, Output<String> id, StreamConnectionFailoverState state, CustomResourceOptions options)
    resources:  _:    type: mongodbatlas:StreamConnectionFailover    get:      id: ${id}
    import {
  to = mongodbatlas_stream_connection_failover.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Authentication StreamConnectionFailoverAuthentication
    Optional for 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
    Optional for type: Kafka. Comma separated list of server addresses.
    ClusterName string
    Optional for type: Cluster. Name of the cluster configured for this connection.
    ClusterProjectId string
    Optional for 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>
    Optional for type: Kafka. A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    ConnectionName string
    Label that identifies the stream connection name.
    DbRoleToExecute StreamConnectionFailoverDbRoleToExecute
    Optional for type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    DeleteOnCreateTimeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    FailoverConnectionId string
    Unique identifier of the connection.
    Networking StreamConnectionFailoverNetworking
    Optional for type: Kafka. Networking configuration for Streams connections.
    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 StreamConnectionFailoverSecurity
    Optional for 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.
    Timeouts StreamConnectionFailoverTimeouts
    Type string
    Type of the connection.
    WorkspaceName string
    Label that identifies the stream workspace.
    Authentication StreamConnectionFailoverAuthenticationArgs
    Optional for 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
    Optional for type: Kafka. Comma separated list of server addresses.
    ClusterName string
    Optional for type: Cluster. Name of the cluster configured for this connection.
    ClusterProjectId string
    Optional for 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
    Optional for type: Kafka. A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    ConnectionName string
    Label that identifies the stream connection name.
    DbRoleToExecute StreamConnectionFailoverDbRoleToExecuteArgs
    Optional for type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    DeleteOnCreateTimeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    FailoverConnectionId string
    Unique identifier of the connection.
    Networking StreamConnectionFailoverNetworkingArgs
    Optional for type: Kafka. Networking configuration for Streams connections.
    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 StreamConnectionFailoverSecurityArgs
    Optional for 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.
    Timeouts StreamConnectionFailoverTimeoutsArgs
    Type string
    Type of the connection.
    WorkspaceName string
    Label that identifies the stream workspace.
    authentication object
    Optional for 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
    Optional for type: Kafka. Comma separated list of server addresses.
    cluster_name string
    Optional for type: Cluster. Name of the cluster configured for this connection.
    cluster_project_id string
    Optional for 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)
    Optional for type: Kafka. A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    connection_name string
    Label that identifies the stream connection name.
    db_role_to_execute object
    Optional for type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    delete_on_create_timeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    failover_connection_id string
    Unique identifier of the connection.
    networking object
    Optional for type: Kafka. Networking configuration for Streams connections.
    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
    Optional for 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.
    timeouts object
    type string
    Type of the connection.
    workspace_name string
    Label that identifies the stream workspace.
    authentication StreamConnectionFailoverAuthentication
    Optional for 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
    Optional for type: Kafka. Comma separated list of server addresses.
    clusterName String
    Optional for type: Cluster. Name of the cluster configured for this connection.
    clusterProjectId String
    Optional for 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>
    Optional for type: Kafka. A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    connectionName String
    Label that identifies the stream connection name.
    dbRoleToExecute StreamConnectionFailoverDbRoleToExecute
    Optional for type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    deleteOnCreateTimeout Boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    failoverConnectionId String
    Unique identifier of the connection.
    networking StreamConnectionFailoverNetworking
    Optional for type: Kafka. Networking configuration for Streams connections.
    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 StreamConnectionFailoverSecurity
    Optional for 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.
    timeouts StreamConnectionFailoverTimeouts
    type String
    Type of the connection.
    workspaceName String
    Label that identifies the stream workspace.
    authentication StreamConnectionFailoverAuthentication
    Optional for 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
    Optional for type: Kafka. Comma separated list of server addresses.
    clusterName string
    Optional for type: Cluster. Name of the cluster configured for this connection.
    clusterProjectId string
    Optional for 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}
    Optional for type: Kafka. A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    connectionName string
    Label that identifies the stream connection name.
    dbRoleToExecute StreamConnectionFailoverDbRoleToExecute
    Optional for type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    deleteOnCreateTimeout boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    failoverConnectionId string
    Unique identifier of the connection.
    networking StreamConnectionFailoverNetworking
    Optional for type: Kafka. Networking configuration for Streams connections.
    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 StreamConnectionFailoverSecurity
    Optional for 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.
    timeouts StreamConnectionFailoverTimeouts
    type string
    Type of the connection.
    workspaceName string
    Label that identifies the stream workspace.
    authentication StreamConnectionFailoverAuthenticationArgs
    Optional for 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
    Optional for type: Kafka. Comma separated list of server addresses.
    cluster_name str
    Optional for type: Cluster. Name of the cluster configured for this connection.
    cluster_project_id str
    Optional for 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]
    Optional for type: Kafka. A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    connection_name str
    Label that identifies the stream connection name.
    db_role_to_execute StreamConnectionFailoverDbRoleToExecuteArgs
    Optional for type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    delete_on_create_timeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    failover_connection_id str
    Unique identifier of the connection.
    networking StreamConnectionFailoverNetworkingArgs
    Optional for type: Kafka. Networking configuration for Streams connections.
    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 StreamConnectionFailoverSecurityArgs
    Optional for 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.
    timeouts StreamConnectionFailoverTimeoutsArgs
    type str
    Type of the connection.
    workspace_name str
    Label that identifies the stream workspace.
    authentication Property Map
    Optional for 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
    Optional for type: Kafka. Comma separated list of server addresses.
    clusterName String
    Optional for type: Cluster. Name of the cluster configured for this connection.
    clusterProjectId String
    Optional for 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>
    Optional for type: Kafka. A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    connectionName String
    Label that identifies the stream connection name.
    dbRoleToExecute Property Map
    Optional for type: Cluster. The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
    deleteOnCreateTimeout Boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    failoverConnectionId String
    Unique identifier of the connection.
    networking Property Map
    Optional for type: Kafka. Networking configuration for Streams connections.
    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
    Optional for 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.
    timeouts Property Map
    type String
    Type of the connection.
    workspaceName String
    Label that identifies the stream workspace.

    Supporting Types

    StreamConnectionFailoverAuthentication, StreamConnectionFailoverAuthenticationArgs

    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.

    StreamConnectionFailoverDbRoleToExecute, StreamConnectionFailoverDbRoleToExecuteArgs

    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.

    StreamConnectionFailoverNetworking, StreamConnectionFailoverNetworkingArgs

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

    StreamConnectionFailoverNetworkingAccess, StreamConnectionFailoverNetworkingAccessArgs

    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.

    StreamConnectionFailoverSecurity, StreamConnectionFailoverSecurityArgs

    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.

    StreamConnectionFailoverTimeouts, StreamConnectionFailoverTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

    Failover connection resource can be imported using the project ID, workspace name, connection name, and failover connection ID, separated by slashes, e.g.

    $ pulumi import mongodbatlas:index/streamConnectionFailover:StreamConnectionFailover test "6117ac2fe2a3d04ed27a9871/yourWorkspaceName/KafkaConnection/671f9c2fe2a3d04ed27a9880"

    For more information see: MongoDB Atlas API - Streams Failover Connection Documentation.

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

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    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