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

confluentcloud.getSwitchoverPairs

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.getSwitchoverPairs lists every switchover pair in an environment. Use it to discover pairs without knowing their IDs — for example, to find the pair for a given cluster, or to see which pairs are currently failed over, from a configuration that did not create them.

    Using getSwitchoverPairs

    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 getSwitchoverPairs(args: GetSwitchoverPairsArgs, opts?: InvokeOptions): Promise<GetSwitchoverPairsResult>
function getSwitchoverPairsOutput(args: GetSwitchoverPairsOutputArgs, opts?: InvokeOutputOptions): Output<GetSwitchoverPairsResult>
    def get_switchover_pairs(environment_crn: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetSwitchoverPairsResult
def get_switchover_pairs_output(environment_crn: pulumi.Input[Optional[str]] = None,
                         opts: Optional[InvokeOutputOptions] = None) -> Output[GetSwitchoverPairsResult]
    func GetSwitchoverPairs(ctx *Context, args *GetSwitchoverPairsArgs, opts ...InvokeOption) (*GetSwitchoverPairsResult, error)
func GetSwitchoverPairsOutput(ctx *Context, args *GetSwitchoverPairsOutputArgs, opts ...InvokeOption) GetSwitchoverPairsResultOutput

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

    public static class GetSwitchoverPairs 
{
    public static Task<GetSwitchoverPairsResult> InvokeAsync(GetSwitchoverPairsArgs args, InvokeOptions? opts = null)
    public static Output<GetSwitchoverPairsResult> Invoke(GetSwitchoverPairsInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetSwitchoverPairsResult> Invoke(GetSwitchoverPairsInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetSwitchoverPairsResult> getSwitchoverPairs(GetSwitchoverPairsArgs args, InvokeOptions options)
public static Output<GetSwitchoverPairsResult> getSwitchoverPairs(GetSwitchoverPairsArgs args, InvokeOptions options)
public static Output<GetSwitchoverPairsResult> getSwitchoverPairs(GetSwitchoverPairsArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: confluentcloud:index/getSwitchoverPairs:getSwitchoverPairs
  arguments:
    # arguments dictionary
    data "confluentcloud_get_switchover_pairs" "name" {
    # arguments
}

    The following arguments are supported:

    EnvironmentCrn string
    The CRN of the environment whose switchover pairs to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    EnvironmentCrn string
    The CRN of the environment whose switchover pairs to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    environment_crn string
    The CRN of the environment whose switchover pairs to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    environmentCrn String
    The CRN of the environment whose switchover pairs to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    environmentCrn string
    The CRN of the environment whose switchover pairs to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    environment_crn str
    The CRN of the environment whose switchover pairs to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    environmentCrn String
    The CRN of the environment whose switchover pairs to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.

    getSwitchoverPairs Result

    The following output properties are available:

    EnvironmentCrn string
    (Required String) The CRN of the environment that owns the pair.
    Id string
    The provider-assigned unique ID for this managed resource.
    SwitchoverPairs List<Pulumi.ConfluentCloud.Outputs.GetSwitchoverPairsSwitchoverPair>
    (Required List of Object) The switchover pairs in the environment. Each object exports the same attributes as the confluentcloud.SwitchoverPair data source:
    EnvironmentCrn string
    (Required String) The CRN of the environment that owns the pair.
    Id string
    The provider-assigned unique ID for this managed resource.
    SwitchoverPairs []GetSwitchoverPairsSwitchoverPair
    (Required List of Object) The switchover pairs in the environment. Each object exports the same attributes as the confluentcloud.SwitchoverPair data source:
    environment_crn string
    (Required String) The CRN of the environment that owns the pair.
    id string
    The provider-assigned unique ID for this managed resource.
    switchover_pairs list(object)
    (Required List of Object) The switchover pairs in the environment. Each object exports the same attributes as the confluentcloud.SwitchoverPair data source:
    environmentCrn String
    (Required String) The CRN of the environment that owns the pair.
    id String
    The provider-assigned unique ID for this managed resource.
    switchoverPairs List<GetSwitchoverPairsSwitchoverPair>
    (Required List of Object) The switchover pairs in the environment. Each object exports the same attributes as the confluentcloud.SwitchoverPair data source:
    environmentCrn string
    (Required String) The CRN of the environment that owns the pair.
    id string
    The provider-assigned unique ID for this managed resource.
    switchoverPairs GetSwitchoverPairsSwitchoverPair[]
    (Required List of Object) The switchover pairs in the environment. Each object exports the same attributes as the confluentcloud.SwitchoverPair data source:
    environment_crn str
    (Required String) The CRN of the environment that owns the pair.
    id str
    The provider-assigned unique ID for this managed resource.
    switchover_pairs Sequence[GetSwitchoverPairsSwitchoverPair]
    (Required List of Object) The switchover pairs in the environment. Each object exports the same attributes as the confluentcloud.SwitchoverPair data source:
    environmentCrn String
    (Required String) The CRN of the environment that owns the pair.
    id String
    The provider-assigned unique ID for this managed resource.
    switchoverPairs List<Property Map>
    (Required List of Object) The switchover pairs in the environment. Each object exports the same attributes as the confluentcloud.SwitchoverPair data source:

    Supporting Types

    GetSwitchoverPairsSwitchoverPair

    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
    The CRN of the environment whose switchover pairs to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    FailoverType string
    (Required String) The failover semantics most recently applied (PLANNED, UNPLANNED, or RESTORE); empty until a failover has been triggered.
    FirstActive string
    (Required String) The name of the member that was active when the pair was first created. Differs from activeMember while the pair is failed over.
    Id string
    (Required String) The ID of the switchover pair, for example, sw-abc123.
    Members List<Pulumi.ConfluentCloud.Inputs.GetSwitchoverPairsSwitchoverPairMember>
    (Required List of Object) The two clusters participating in the pair. Each member exports name, memberCrn, cloud, and region.
    Phase string
    (Required String) The lifecycle phase of the switchover pair, for example, READY_TO_FAILOVER.
    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
    The CRN of the environment whose switchover pairs to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    FailoverType string
    (Required String) The failover semantics most recently applied (PLANNED, UNPLANNED, or RESTORE); empty until a failover has been triggered.
    FirstActive string
    (Required String) The name of the member that was active when the pair was first created. Differs from activeMember while the pair is failed over.
    Id string
    (Required String) The ID of the switchover pair, for example, sw-abc123.
    Members []GetSwitchoverPairsSwitchoverPairMember
    (Required List of Object) The two clusters participating in the pair. Each member exports name, memberCrn, cloud, and region.
    Phase string
    (Required String) The lifecycle phase of the switchover pair, for example, READY_TO_FAILOVER.
    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
    The CRN of the environment whose switchover pairs to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    failover_type string
    (Required String) The failover semantics most recently applied (PLANNED, UNPLANNED, or RESTORE); empty until a failover has been triggered.
    first_active string
    (Required String) The name of the member that was active when the pair was first created. Differs from activeMember while the pair is failed over.
    id string
    (Required String) The ID of the switchover pair, for example, sw-abc123.
    members list(object)
    (Required List of Object) The two clusters participating in the pair. Each member exports name, memberCrn, cloud, and region.
    phase string
    (Required String) The lifecycle phase of the switchover pair, for example, READY_TO_FAILOVER.
    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
    The CRN of the environment whose switchover pairs to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    failoverType String
    (Required String) The failover semantics most recently applied (PLANNED, UNPLANNED, or RESTORE); empty until a failover has been triggered.
    firstActive String
    (Required String) The name of the member that was active when the pair was first created. Differs from activeMember while the pair is failed over.
    id String
    (Required String) The ID of the switchover pair, for example, sw-abc123.
    members List<GetSwitchoverPairsSwitchoverPairMember>
    (Required List of Object) The two clusters participating in the pair. Each member exports name, memberCrn, cloud, and region.
    phase String
    (Required String) The lifecycle phase of the switchover pair, for example, READY_TO_FAILOVER.
    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
    The CRN of the environment whose switchover pairs to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    failoverType string
    (Required String) The failover semantics most recently applied (PLANNED, UNPLANNED, or RESTORE); empty until a failover has been triggered.
    firstActive string
    (Required String) The name of the member that was active when the pair was first created. Differs from activeMember while the pair is failed over.
    id string
    (Required String) The ID of the switchover pair, for example, sw-abc123.
    members GetSwitchoverPairsSwitchoverPairMember[]
    (Required List of Object) The two clusters participating in the pair. Each member exports name, memberCrn, cloud, and region.
    phase string
    (Required String) The lifecycle phase of the switchover pair, for example, READY_TO_FAILOVER.
    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
    The CRN of the environment whose switchover pairs to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    failover_type str
    (Required String) The failover semantics most recently applied (PLANNED, UNPLANNED, or RESTORE); empty until a failover has been triggered.
    first_active str
    (Required String) The name of the member that was active when the pair was first created. Differs from activeMember while the pair is failed over.
    id str
    (Required String) The ID of the switchover pair, for example, sw-abc123.
    members Sequence[GetSwitchoverPairsSwitchoverPairMember]
    (Required List of Object) The two clusters participating in the pair. Each member exports name, memberCrn, cloud, and region.
    phase str
    (Required String) The lifecycle phase of the switchover pair, for example, READY_TO_FAILOVER.
    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
    The CRN of the environment whose switchover pairs to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    failoverType String
    (Required String) The failover semantics most recently applied (PLANNED, UNPLANNED, or RESTORE); empty until a failover has been triggered.
    firstActive String
    (Required String) The name of the member that was active when the pair was first created. Differs from activeMember while the pair is failed over.
    id String
    (Required String) The ID of the switchover pair, for example, sw-abc123.
    members List<Property Map>
    (Required List of Object) The two clusters participating in the pair. Each member exports name, memberCrn, cloud, and region.
    phase String
    (Required String) The lifecycle phase of the switchover pair, for example, READY_TO_FAILOVER.

    GetSwitchoverPairsSwitchoverPairMember

    Cloud string
    MemberCrn string
    Name string
    Region string
    Cloud string
    MemberCrn string
    Name string
    Region string
    cloud string
    member_crn string
    name string
    region string
    cloud String
    memberCrn String
    name String
    region String
    cloud string
    memberCrn string
    name string
    region string
    cloud String
    memberCrn String
    name String
    region String

    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