Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Confluent Provider
  4. API Docs
  5. getSwitchoverPair
Viewing docs for Confluent v2.87.0
published on Friday, Oct 16, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-confluentcloud

confluentcloud.getSwitchoverPair

confluentcloud logo
Viewing docs for Confluent v2.87.0
published on Friday, Oct 16, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-confluentcloud

    Preview

    Warning: Switchover is a preview feature. Preview features are introduced to gather customer feedback and may change based on that feedback. They are intended for evaluation and non-production use only, and are not covered by Confluent SLAs. Preview features may be discontinued at any time.

    confluentcloud.SwitchoverPair describes a switchover pair data source.

    Example Usage

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

const example = confluentcloud.getSwitchoverPair({
    id: "sw-abc123",
    environmentCrn: "crn://confluent.cloud/organization=org-abc/environment=env-abc123",
});
export const switchoverPair = example;

    import pulumi
import pulumi_confluentcloud as confluentcloud

example = confluentcloud.get_switchover_pair(id="sw-abc123",
    environment_crn="crn://confluent.cloud/organization=org-abc/environment=env-abc123")
pulumi.export("switchoverPair", example)

    package main

import (
	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := confluentcloud.GetSwitchoverPair(ctx, &confluentcloud.LookupSwitchoverPairArgs{
			Id:             "sw-abc123",
			EnvironmentCrn: "crn://confluent.cloud/organization=org-abc/environment=env-abc123",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("switchoverPair", example)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = ConfluentCloud.GetSwitchoverPair.Invoke(new()
    {
        Id = "sw-abc123",
        EnvironmentCrn = "crn://confluent.cloud/organization=org-abc/environment=env-abc123",
    });

    return new Dictionary<string, object?>
    {
        ["switchoverPair"] = example,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ConfluentcloudFunctions;
import com.pulumi.confluentcloud.inputs.GetSwitchoverPairArgs;
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) {
        final var example = ConfluentcloudFunctions.getSwitchoverPair(GetSwitchoverPairArgs.builder()
            .id("sw-abc123")
            .environmentCrn("crn://confluent.cloud/organization=org-abc/environment=env-abc123")
            .build());

        ctx.export("switchoverPair", example);
    }
}

    variables:
  example:
    fn::invoke:
      function: confluentcloud:getSwitchoverPair
      arguments:
        id: sw-abc123
        environmentCrn: crn://confluent.cloud/organization=org-abc/environment=env-abc123
outputs:
  switchoverPair: ${example}

    terraform {
  required_providers {
    confluentcloud = {
      source = "pulumi/confluentcloud"
    }
  }
}

data "confluentcloud_switchover_pair" "example" {
  id              = "sw-abc123"
  environment_crn = "crn://confluent.cloud/organization=org-abc/environment=env-abc123"
}

output "switchoverPair" {
  value = data.confluentcloud_switchover_pair.example
}

    Using getSwitchoverPair

    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 getSwitchoverPair(args: GetSwitchoverPairArgs, opts?: InvokeOptions): Promise<GetSwitchoverPairResult>
function getSwitchoverPairOutput(args: GetSwitchoverPairOutputArgs, opts?: InvokeOutputOptions): Output<GetSwitchoverPairResult>
    def get_switchover_pair(environment_crn: Optional[str] = None,
                        id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetSwitchoverPairResult
def get_switchover_pair_output(environment_crn: pulumi.Input[Optional[str]] = None,
                        id: pulumi.Input[Optional[str]] = None,
                        opts: Optional[InvokeOutputOptions] = None) -> Output[GetSwitchoverPairResult]
    func LookupSwitchoverPair(ctx *Context, args *LookupSwitchoverPairArgs, opts ...InvokeOption) (*LookupSwitchoverPairResult, error)
func LookupSwitchoverPairOutput(ctx *Context, args *LookupSwitchoverPairOutputArgs, opts ...InvokeOption) LookupSwitchoverPairResultOutput

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

    public static class GetSwitchoverPair 
{
    public static Task<GetSwitchoverPairResult> InvokeAsync(GetSwitchoverPairArgs args, InvokeOptions? opts = null)
    public static Output<GetSwitchoverPairResult> Invoke(GetSwitchoverPairInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetSwitchoverPairResult> Invoke(GetSwitchoverPairInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetSwitchoverPairResult> getSwitchoverPair(GetSwitchoverPairArgs args, InvokeOptions options)
public static Output<GetSwitchoverPairResult> getSwitchoverPair(GetSwitchoverPairArgs args, InvokeOptions options)
public static Output<GetSwitchoverPairResult> getSwitchoverPair(GetSwitchoverPairArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: confluentcloud:index/getSwitchoverPair:getSwitchoverPair
  arguments:
    # arguments dictionary
    data "confluentcloud_get_switchover_pair" "name" {
    # arguments
}

    The following arguments are supported:

    EnvironmentCrn string
    The CRN of the environment that owns this switchover pair, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    Id string
    The ID of the switchover pair, for example, sw-abc123.
    EnvironmentCrn string
    The CRN of the environment that owns this switchover pair, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    Id string
    The ID of the switchover pair, for example, sw-abc123.
    environment_crn string
    The CRN of the environment that owns this switchover pair, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    id string
    The ID of the switchover pair, for example, sw-abc123.
    environmentCrn String
    The CRN of the environment that owns this switchover pair, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    id String
    The ID of the switchover pair, for example, sw-abc123.
    environmentCrn string
    The CRN of the environment that owns this switchover pair, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    id string
    The ID of the switchover pair, for example, sw-abc123.
    environment_crn str
    The CRN of the environment that owns this switchover pair, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    id str
    The ID of the switchover pair, for example, sw-abc123.
    environmentCrn String
    The CRN of the environment that owns this switchover pair, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    id String
    The ID of the switchover pair, for example, sw-abc123.

    getSwitchoverPair Result

    The following output properties are available:

    ActiveMember string
    (Required String) The name of the member that is currently active.
    DisplayName string
    (Required String) A human-readable name for the switchover pair.
    EnvironmentCrn string
    FailoverType string
    (Required String) The failover semantics most recently applied to this pair.
    FirstActive string
    (Required String) The name of the member that was active when the pair was first created.
    Id string
    Members List<Pulumi.ConfluentCloud.Outputs.GetSwitchoverPairMember>
    (Required Configuration Block) The two clusters participating in this switchover pair. Each block exports the following:
    Phase string
    (Required String) The lifecycle phase of the switchover pair.
    ActiveMember string
    (Required String) The name of the member that is currently active.
    DisplayName string
    (Required String) A human-readable name for the switchover pair.
    EnvironmentCrn string
    FailoverType string
    (Required String) The failover semantics most recently applied to this pair.
    FirstActive string
    (Required String) The name of the member that was active when the pair was first created.
    Id string
    Members []GetSwitchoverPairMember
    (Required Configuration Block) The two clusters participating in this switchover pair. Each block exports the following:
    Phase string
    (Required String) The lifecycle phase of the switchover pair.
    active_member string
    (Required String) The name of the member that is currently active.
    display_name string
    (Required String) A human-readable name for the switchover pair.
    environment_crn string
    failover_type string
    (Required String) The failover semantics most recently applied to this pair.
    first_active string
    (Required String) The name of the member that was active when the pair was first created.
    id string
    members list(object)
    (Required Configuration Block) The two clusters participating in this switchover pair. Each block exports the following:
    phase string
    (Required String) The lifecycle phase of the switchover pair.
    activeMember String
    (Required String) The name of the member that is currently active.
    displayName String
    (Required String) A human-readable name for the switchover pair.
    environmentCrn String
    failoverType String
    (Required String) The failover semantics most recently applied to this pair.
    firstActive String
    (Required String) The name of the member that was active when the pair was first created.
    id String
    members List<GetSwitchoverPairMember>
    (Required Configuration Block) The two clusters participating in this switchover pair. Each block exports the following:
    phase String
    (Required String) The lifecycle phase of the switchover pair.
    activeMember string
    (Required String) The name of the member that is currently active.
    displayName string
    (Required String) A human-readable name for the switchover pair.
    environmentCrn string
    failoverType string
    (Required String) The failover semantics most recently applied to this pair.
    firstActive string
    (Required String) The name of the member that was active when the pair was first created.
    id string
    members GetSwitchoverPairMember[]
    (Required Configuration Block) The two clusters participating in this switchover pair. Each block exports the following:
    phase string
    (Required String) The lifecycle phase of the switchover pair.
    active_member str
    (Required String) The name of the member that is currently active.
    display_name str
    (Required String) A human-readable name for the switchover pair.
    environment_crn str
    failover_type str
    (Required String) The failover semantics most recently applied to this pair.
    first_active str
    (Required String) The name of the member that was active when the pair was first created.
    id str
    members Sequence[GetSwitchoverPairMember]
    (Required Configuration Block) The two clusters participating in this switchover pair. Each block exports the following:
    phase str
    (Required String) The lifecycle phase of the switchover pair.
    activeMember String
    (Required String) The name of the member that is currently active.
    displayName String
    (Required String) A human-readable name for the switchover pair.
    environmentCrn String
    failoverType String
    (Required String) The failover semantics most recently applied to this pair.
    firstActive String
    (Required String) The name of the member that was active when the pair was first created.
    id String
    members List<Property Map>
    (Required Configuration Block) The two clusters participating in this switchover pair. Each block exports the following:
    phase String
    (Required String) The lifecycle phase of the switchover pair.

    Supporting Types

    GetSwitchoverPairMember

    Cloud string
    (Required String) The cloud provider of the member's cluster.
    MemberCrn string
    (Required String) The CRN of the cluster this member represents.
    Name string
    (Required String) A logical name for this member, unique within the pair.
    Region string
    (Required String) The cloud region of the member's cluster.
    Cloud string
    (Required String) The cloud provider of the member's cluster.
    MemberCrn string
    (Required String) The CRN of the cluster this member represents.
    Name string
    (Required String) A logical name for this member, unique within the pair.
    Region string
    (Required String) The cloud region of the member's cluster.
    cloud string
    (Required String) The cloud provider of the member's cluster.
    member_crn string
    (Required String) The CRN of the cluster this member represents.
    name string
    (Required String) A logical name for this member, unique within the pair.
    region string
    (Required String) The cloud region of the member's cluster.
    cloud String
    (Required String) The cloud provider of the member's cluster.
    memberCrn String
    (Required String) The CRN of the cluster this member represents.
    name String
    (Required String) A logical name for this member, unique within the pair.
    region String
    (Required String) The cloud region of the member's cluster.
    cloud string
    (Required String) The cloud provider of the member's cluster.
    memberCrn string
    (Required String) The CRN of the cluster this member represents.
    name string
    (Required String) A logical name for this member, unique within the pair.
    region string
    (Required String) The cloud region of the member's cluster.
    cloud str
    (Required String) The cloud provider of the member's cluster.
    member_crn str
    (Required String) The CRN of the cluster this member represents.
    name str
    (Required String) A logical name for this member, unique within the pair.
    region str
    (Required String) The cloud region of the member's cluster.
    cloud String
    (Required String) The cloud provider of the member's cluster.
    memberCrn String
    (Required String) The CRN of the cluster this member represents.
    name String
    (Required String) A logical name for this member, unique within the pair.
    region String
    (Required String) The cloud region of the member's cluster.

    Package Details

    Repository
    Confluent Cloud pulumi/pulumi-confluentcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the confluent Terraform Provider.
    confluentcloud logo
    Viewing docs for Confluent v2.87.0
    published on Friday, Oct 16, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-confluentcloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial