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

confluentcloud.getSwitchoverEndpoint

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.SwitchoverEndpoint describes a switchover endpoint data source.

    Example Usage

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

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

    import pulumi
import pulumi_confluentcloud as confluentcloud

example = confluentcloud.get_switchover_endpoint(id="se-abc123",
    environment_crn="crn://confluent.cloud/organization=org-abc/environment=env-abc123")
pulumi.export("switchoverEndpoint", 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.GetSwitchoverEndpoint(ctx, &confluentcloud.LookupSwitchoverEndpointArgs{
			Id:             "se-abc123",
			EnvironmentCrn: "crn://confluent.cloud/organization=org-abc/environment=env-abc123",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("switchoverEndpoint", example)
		return nil
	})
}

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

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

    return new Dictionary<string, object?>
    {
        ["switchoverEndpoint"] = 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.GetSwitchoverEndpointArgs;
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.getSwitchoverEndpoint(GetSwitchoverEndpointArgs.builder()
            .id("se-abc123")
            .environmentCrn("crn://confluent.cloud/organization=org-abc/environment=env-abc123")
            .build());

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

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

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

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

output "switchoverEndpoint" {
  value = data.confluentcloud_switchover_endpoint.example
}

    Using getSwitchoverEndpoint

    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 getSwitchoverEndpoint(args: GetSwitchoverEndpointArgs, opts?: InvokeOptions): Promise<GetSwitchoverEndpointResult>
function getSwitchoverEndpointOutput(args: GetSwitchoverEndpointOutputArgs, opts?: InvokeOutputOptions): Output<GetSwitchoverEndpointResult>
    def get_switchover_endpoint(environment_crn: Optional[str] = None,
                            id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetSwitchoverEndpointResult
def get_switchover_endpoint_output(environment_crn: pulumi.Input[Optional[str]] = None,
                            id: pulumi.Input[Optional[str]] = None,
                            opts: Optional[InvokeOutputOptions] = None) -> Output[GetSwitchoverEndpointResult]
    func LookupSwitchoverEndpoint(ctx *Context, args *LookupSwitchoverEndpointArgs, opts ...InvokeOption) (*LookupSwitchoverEndpointResult, error)
func LookupSwitchoverEndpointOutput(ctx *Context, args *LookupSwitchoverEndpointOutputArgs, opts ...InvokeOption) LookupSwitchoverEndpointResultOutput

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

    public static class GetSwitchoverEndpoint 
{
    public static Task<GetSwitchoverEndpointResult> InvokeAsync(GetSwitchoverEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetSwitchoverEndpointResult> Invoke(GetSwitchoverEndpointInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetSwitchoverEndpointResult> Invoke(GetSwitchoverEndpointInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetSwitchoverEndpointResult> getSwitchoverEndpoint(GetSwitchoverEndpointArgs args, InvokeOptions options)
public static Output<GetSwitchoverEndpointResult> getSwitchoverEndpoint(GetSwitchoverEndpointArgs args, InvokeOptions options)
public static Output<GetSwitchoverEndpointResult> getSwitchoverEndpoint(GetSwitchoverEndpointArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: confluentcloud:index/getSwitchoverEndpoint:getSwitchoverEndpoint
  arguments:
    # arguments dictionary
    data "confluentcloud_get_switchover_endpoint" "name" {
    # arguments
}

    The following arguments are supported:

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

    getSwitchoverEndpoint Result

    The following output properties are available:

    DisplayName string
    (Required String) A human-readable name for the switchover endpoint.
    Endpoints List<Pulumi.ConfluentCloud.Outputs.GetSwitchoverEndpointEndpoint>
    (Required Configuration Block) The endpoint definitions, one per side. Each block exports the following:
    EnvironmentCrn string
    Id string
    ParentResourceCrn string
    (Required String) The CRN of the switchover pair this endpoint is bound to.
    Phase string
    (Required String) The lifecycle phase of the switchover endpoint.
    Target string
    (Required String) The name of the endpoint that is currently active.
    DisplayName string
    (Required String) A human-readable name for the switchover endpoint.
    Endpoints []GetSwitchoverEndpointEndpoint
    (Required Configuration Block) The endpoint definitions, one per side. Each block exports the following:
    EnvironmentCrn string
    Id string
    ParentResourceCrn string
    (Required String) The CRN of the switchover pair this endpoint is bound to.
    Phase string
    (Required String) The lifecycle phase of the switchover endpoint.
    Target string
    (Required String) The name of the endpoint that is currently active.
    display_name string
    (Required String) A human-readable name for the switchover endpoint.
    endpoints list(object)
    (Required Configuration Block) The endpoint definitions, one per side. Each block exports the following:
    environment_crn string
    id string
    parent_resource_crn string
    (Required String) The CRN of the switchover pair this endpoint is bound to.
    phase string
    (Required String) The lifecycle phase of the switchover endpoint.
    target string
    (Required String) The name of the endpoint that is currently active.
    displayName String
    (Required String) A human-readable name for the switchover endpoint.
    endpoints List<GetSwitchoverEndpointEndpoint>
    (Required Configuration Block) The endpoint definitions, one per side. Each block exports the following:
    environmentCrn String
    id String
    parentResourceCrn String
    (Required String) The CRN of the switchover pair this endpoint is bound to.
    phase String
    (Required String) The lifecycle phase of the switchover endpoint.
    target String
    (Required String) The name of the endpoint that is currently active.
    displayName string
    (Required String) A human-readable name for the switchover endpoint.
    endpoints GetSwitchoverEndpointEndpoint[]
    (Required Configuration Block) The endpoint definitions, one per side. Each block exports the following:
    environmentCrn string
    id string
    parentResourceCrn string
    (Required String) The CRN of the switchover pair this endpoint is bound to.
    phase string
    (Required String) The lifecycle phase of the switchover endpoint.
    target string
    (Required String) The name of the endpoint that is currently active.
    display_name str
    (Required String) A human-readable name for the switchover endpoint.
    endpoints Sequence[GetSwitchoverEndpointEndpoint]
    (Required Configuration Block) The endpoint definitions, one per side. Each block exports the following:
    environment_crn str
    id str
    parent_resource_crn str
    (Required String) The CRN of the switchover pair this endpoint is bound to.
    phase str
    (Required String) The lifecycle phase of the switchover endpoint.
    target str
    (Required String) The name of the endpoint that is currently active.
    displayName String
    (Required String) A human-readable name for the switchover endpoint.
    endpoints List<Property Map>
    (Required Configuration Block) The endpoint definitions, one per side. Each block exports the following:
    environmentCrn String
    id String
    parentResourceCrn String
    (Required String) The CRN of the switchover pair this endpoint is bound to.
    phase String
    (Required String) The lifecycle phase of the switchover endpoint.
    target String
    (Required String) The name of the endpoint that is currently active.

    Supporting Types

    GetSwitchoverEndpointEndpoint

    Cloud string
    (Required String) The cloud provider this endpoint resolves to.
    ConnectionType string
    (Required String) The connection type this endpoint resolves to.
    EndpointFilters List<Pulumi.ConfluentCloud.Inputs.GetSwitchoverEndpointEndpointEndpointFilter>
    (Required Configuration Block) Supports the following:
    Hostname string
    (Required String) The resolved hostname for this endpoint.
    Name string
    (Required String) A logical name for this endpoint side.
    Region string
    (Required String) The cloud region this endpoint resolves to.
    Cloud string
    (Required String) The cloud provider this endpoint resolves to.
    ConnectionType string
    (Required String) The connection type this endpoint resolves to.
    EndpointFilters []GetSwitchoverEndpointEndpointEndpointFilter
    (Required Configuration Block) Supports the following:
    Hostname string
    (Required String) The resolved hostname for this endpoint.
    Name string
    (Required String) A logical name for this endpoint side.
    Region string
    (Required String) The cloud region this endpoint resolves to.
    cloud string
    (Required String) The cloud provider this endpoint resolves to.
    connection_type string
    (Required String) The connection type this endpoint resolves to.
    endpoint_filters list(object)
    (Required Configuration Block) Supports the following:
    hostname string
    (Required String) The resolved hostname for this endpoint.
    name string
    (Required String) A logical name for this endpoint side.
    region string
    (Required String) The cloud region this endpoint resolves to.
    cloud String
    (Required String) The cloud provider this endpoint resolves to.
    connectionType String
    (Required String) The connection type this endpoint resolves to.
    endpointFilters List<GetSwitchoverEndpointEndpointEndpointFilter>
    (Required Configuration Block) Supports the following:
    hostname String
    (Required String) The resolved hostname for this endpoint.
    name String
    (Required String) A logical name for this endpoint side.
    region String
    (Required String) The cloud region this endpoint resolves to.
    cloud string
    (Required String) The cloud provider this endpoint resolves to.
    connectionType string
    (Required String) The connection type this endpoint resolves to.
    endpointFilters GetSwitchoverEndpointEndpointEndpointFilter[]
    (Required Configuration Block) Supports the following:
    hostname string
    (Required String) The resolved hostname for this endpoint.
    name string
    (Required String) A logical name for this endpoint side.
    region string
    (Required String) The cloud region this endpoint resolves to.
    cloud str
    (Required String) The cloud provider this endpoint resolves to.
    connection_type str
    (Required String) The connection type this endpoint resolves to.
    endpoint_filters Sequence[GetSwitchoverEndpointEndpointEndpointFilter]
    (Required Configuration Block) Supports the following:
    hostname str
    (Required String) The resolved hostname for this endpoint.
    name str
    (Required String) A logical name for this endpoint side.
    region str
    (Required String) The cloud region this endpoint resolves to.
    cloud String
    (Required String) The cloud provider this endpoint resolves to.
    connectionType String
    (Required String) The connection type this endpoint resolves to.
    endpointFilters List<Property Map>
    (Required Configuration Block) Supports the following:
    hostname String
    (Required String) The resolved hostname for this endpoint.
    name String
    (Required String) A logical name for this endpoint side.
    region String
    (Required String) The cloud region this endpoint resolves to.

    GetSwitchoverEndpointEndpointEndpointFilter

    AccessPointCrn string
    (Required String) The CRN of the network access point, for access-point (PNI) endpoints.
    NetworkCrn string
    (Required String) The CRN of the network, for network-based private endpoints.
    Type string
    (Required String) Whether the endpoint is private or public.
    AccessPointCrn string
    (Required String) The CRN of the network access point, for access-point (PNI) endpoints.
    NetworkCrn string
    (Required String) The CRN of the network, for network-based private endpoints.
    Type string
    (Required String) Whether the endpoint is private or public.
    access_point_crn string
    (Required String) The CRN of the network access point, for access-point (PNI) endpoints.
    network_crn string
    (Required String) The CRN of the network, for network-based private endpoints.
    type string
    (Required String) Whether the endpoint is private or public.
    accessPointCrn String
    (Required String) The CRN of the network access point, for access-point (PNI) endpoints.
    networkCrn String
    (Required String) The CRN of the network, for network-based private endpoints.
    type String
    (Required String) Whether the endpoint is private or public.
    accessPointCrn string
    (Required String) The CRN of the network access point, for access-point (PNI) endpoints.
    networkCrn string
    (Required String) The CRN of the network, for network-based private endpoints.
    type string
    (Required String) Whether the endpoint is private or public.
    access_point_crn str
    (Required String) The CRN of the network access point, for access-point (PNI) endpoints.
    network_crn str
    (Required String) The CRN of the network, for network-based private endpoints.
    type str
    (Required String) Whether the endpoint is private or public.
    accessPointCrn String
    (Required String) The CRN of the network access point, for access-point (PNI) endpoints.
    networkCrn String
    (Required String) The CRN of the network, for network-based private endpoints.
    type String
    (Required String) Whether the endpoint is private or public.

    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