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

confluentcloud.SwitchoverEndpoint

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 provides a switchover endpoint resource that models a sticky disaster recovery (DR) endpoint bound to a confluentcloud.SwitchoverPair. The endpoint follows the pair’s active member so that clients keep a stable connection target across a failover.

    Deleting an endpoint is asynchronous on the API side; the resource waits until the endpoint is gone before completing, so a terraform destroy that removes the endpoint and its pair together succeeds in one run (the pair cannot be deleted while an endpoint still exists).

    The side the endpoint points at is owned by the Switchover service and reported in the computed target attribute: it starts on the side matching the pair’s active member, and a failover moves it without showing drift or forcing a replacement (which would hand clients a new hostname). Keep the endpoint in the same Terraform configuration as its pair. See the complete example.

    Note: For PrivateLink Attachment (Enterprise) clusters, use accessPointCrn in the form crn://confluent.cloud/organization=<org>/environment=<env>/gateway=<platt-id>/access-point=<plattc-id>. For Dedicated clusters on a Confluent-managed network, use networkCrn.

    Example Usage

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

const example = new confluentcloud.SwitchoverEndpoint("example", {
    displayName: "prod-kafka-dr-endpoint",
    parentResourceCrn: "crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123",
    endpoints: [
        {
            name: "west-platt",
            endpointFilter: {
                type: "private",
                networkCrn: "crn://confluent.cloud/organization=org-abc/environment=env-abc123/network=n-west01",
            },
        },
        {
            name: "east-platt",
            endpointFilter: {
                type: "private",
                networkCrn: "crn://confluent.cloud/organization=org-abc/environment=env-def456/network=n-east01",
            },
        },
    ],
});

    import pulumi
import pulumi_confluentcloud as confluentcloud

example = confluentcloud.SwitchoverEndpoint("example",
    display_name="prod-kafka-dr-endpoint",
    parent_resource_crn="crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123",
    endpoints=[
        {
            "name": "west-platt",
            "endpoint_filter": {
                "type": "private",
                "network_crn": "crn://confluent.cloud/organization=org-abc/environment=env-abc123/network=n-west01",
            },
        },
        {
            "name": "east-platt",
            "endpoint_filter": {
                "type": "private",
                "network_crn": "crn://confluent.cloud/organization=org-abc/environment=env-def456/network=n-east01",
            },
        },
    ])

    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 {
		_, err := confluentcloud.NewSwitchoverEndpoint(ctx, "example", &confluentcloud.SwitchoverEndpointArgs{
			DisplayName:       pulumi.String("prod-kafka-dr-endpoint"),
			ParentResourceCrn: pulumi.String("crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123"),
			Endpoints: confluentcloud.SwitchoverEndpointEndpointArray{
				&confluentcloud.SwitchoverEndpointEndpointArgs{
					Name: pulumi.String("west-platt"),
					EndpointFilter: &confluentcloud.SwitchoverEndpointEndpointEndpointFilterArgs{
						Type:       pulumi.String("private"),
						NetworkCrn: pulumi.String("crn://confluent.cloud/organization=org-abc/environment=env-abc123/network=n-west01"),
					},
				},
				&confluentcloud.SwitchoverEndpointEndpointArgs{
					Name: pulumi.String("east-platt"),
					EndpointFilter: &confluentcloud.SwitchoverEndpointEndpointEndpointFilterArgs{
						Type:       pulumi.String("private"),
						NetworkCrn: pulumi.String("crn://confluent.cloud/organization=org-abc/environment=env-def456/network=n-east01"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new ConfluentCloud.SwitchoverEndpoint("example", new()
    {
        DisplayName = "prod-kafka-dr-endpoint",
        ParentResourceCrn = "crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123",
        Endpoints = new[]
        {
            new ConfluentCloud.Inputs.SwitchoverEndpointEndpointArgs
            {
                Name = "west-platt",
                EndpointFilter = new ConfluentCloud.Inputs.SwitchoverEndpointEndpointEndpointFilterArgs
                {
                    Type = "private",
                    NetworkCrn = "crn://confluent.cloud/organization=org-abc/environment=env-abc123/network=n-west01",
                },
            },
            new ConfluentCloud.Inputs.SwitchoverEndpointEndpointArgs
            {
                Name = "east-platt",
                EndpointFilter = new ConfluentCloud.Inputs.SwitchoverEndpointEndpointEndpointFilterArgs
                {
                    Type = "private",
                    NetworkCrn = "crn://confluent.cloud/organization=org-abc/environment=env-def456/network=n-east01",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.SwitchoverEndpoint;
import com.pulumi.confluentcloud.SwitchoverEndpointArgs;
import com.pulumi.confluentcloud.inputs.SwitchoverEndpointEndpointArgs;
import com.pulumi.confluentcloud.inputs.SwitchoverEndpointEndpointEndpointFilterArgs;
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 SwitchoverEndpoint("example", SwitchoverEndpointArgs.builder()
            .displayName("prod-kafka-dr-endpoint")
            .parentResourceCrn("crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123")
            .endpoints(            
                SwitchoverEndpointEndpointArgs.builder()
                    .name("west-platt")
                    .endpointFilter(SwitchoverEndpointEndpointEndpointFilterArgs.builder()
                        .type("private")
                        .networkCrn("crn://confluent.cloud/organization=org-abc/environment=env-abc123/network=n-west01")
                        .build())
                    .build(),
                SwitchoverEndpointEndpointArgs.builder()
                    .name("east-platt")
                    .endpointFilter(SwitchoverEndpointEndpointEndpointFilterArgs.builder()
                        .type("private")
                        .networkCrn("crn://confluent.cloud/organization=org-abc/environment=env-def456/network=n-east01")
                        .build())
                    .build())
            .build());

    }
}

    resources:
  example:
    type: confluentcloud:SwitchoverEndpoint
    properties:
      displayName: prod-kafka-dr-endpoint
      parentResourceCrn: crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123
      endpoints:
        - name: west-platt
          endpointFilter:
            type: private
            networkCrn: crn://confluent.cloud/organization=org-abc/environment=env-abc123/network=n-west01
        - name: east-platt
          endpointFilter:
            type: private
            networkCrn: crn://confluent.cloud/organization=org-abc/environment=env-def456/network=n-east01

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

resource "confluentcloud_switchover_endpoint" "example" {
  lifecycle {
    create_before_destroy = true
  }
  display_name        = "prod-kafka-dr-endpoint"
  parent_resource_crn = "crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123"
  endpoints {
    name = "west-platt"
    endpoint_filter = {
      type        = "private"
      network_crn = "crn://confluent.cloud/organization=org-abc/environment=env-abc123/network=n-west01"
    }
  }
  endpoints {
    name = "east-platt"
    endpoint_filter = {
      type        = "private"
      network_crn = "crn://confluent.cloud/organization=org-abc/environment=env-def456/network=n-east01"
    }
  }
}

    Create SwitchoverEndpoint Resource

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

    Constructor syntax

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

@overload
def SwitchoverEndpoint(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       display_name: Optional[str] = None,
                       endpoints: Optional[Sequence[SwitchoverEndpointEndpointArgs]] = None,
                       parent_resource_crn: Optional[str] = None)
    func NewSwitchoverEndpoint(ctx *Context, name string, args SwitchoverEndpointArgs, opts ...ResourceOption) (*SwitchoverEndpoint, error)
    public SwitchoverEndpoint(string name, SwitchoverEndpointArgs args, CustomResourceOptions? opts = null)
    public SwitchoverEndpoint(String name, SwitchoverEndpointArgs args)
public SwitchoverEndpoint(String name, SwitchoverEndpointArgs args, CustomResourceOptions options)

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


    resource "confluentcloud_switchover_endpoint" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args SwitchoverEndpointArgs
    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 SwitchoverEndpointArgs
    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 SwitchoverEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SwitchoverEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SwitchoverEndpointArgs
    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 switchoverEndpointResource = new ConfluentCloud.SwitchoverEndpoint("switchoverEndpointResource", new()
{
    DisplayName = "string",
    Endpoints = new[]
    {
        new ConfluentCloud.Inputs.SwitchoverEndpointEndpointArgs
        {
            EndpointFilter = new ConfluentCloud.Inputs.SwitchoverEndpointEndpointEndpointFilterArgs
            {
                Type = "string",
                AccessPointCrn = "string",
                NetworkCrn = "string",
            },
            Name = "string",
            Cloud = "string",
            ConnectionType = "string",
            Hostname = "string",
            Region = "string",
        },
    },
    ParentResourceCrn = "string",
});

    example, err := confluentcloud.NewSwitchoverEndpoint(ctx, "switchoverEndpointResource", &confluentcloud.SwitchoverEndpointArgs{
	DisplayName: pulumi.String("string"),
	Endpoints: confluentcloud.SwitchoverEndpointEndpointArray{
		&confluentcloud.SwitchoverEndpointEndpointArgs{
			EndpointFilter: &confluentcloud.SwitchoverEndpointEndpointEndpointFilterArgs{
				Type:           pulumi.String("string"),
				AccessPointCrn: pulumi.String("string"),
				NetworkCrn:     pulumi.String("string"),
			},
			Name:           pulumi.String("string"),
			Cloud:          pulumi.String("string"),
			ConnectionType: pulumi.String("string"),
			Hostname:       pulumi.String("string"),
			Region:         pulumi.String("string"),
		},
	},
	ParentResourceCrn: pulumi.String("string"),
})

    resource "confluentcloud_switchover_endpoint" "switchoverEndpointResource" {
  lifecycle {
    create_before_destroy = true
  }
  display_name = "string"
  endpoints {
    endpoint_filter = {
      type             = "string"
      access_point_crn = "string"
      network_crn      = "string"
    }
    name            = "string"
    cloud           = "string"
    connection_type = "string"
    hostname        = "string"
    region          = "string"
  }
  parent_resource_crn = "string"
}

    var switchoverEndpointResource = new SwitchoverEndpoint("switchoverEndpointResource", SwitchoverEndpointArgs.builder()
    .displayName("string")
    .endpoints(SwitchoverEndpointEndpointArgs.builder()
        .endpointFilter(SwitchoverEndpointEndpointEndpointFilterArgs.builder()
            .type("string")
            .accessPointCrn("string")
            .networkCrn("string")
            .build())
        .name("string")
        .cloud("string")
        .connectionType("string")
        .hostname("string")
        .region("string")
        .build())
    .parentResourceCrn("string")
    .build());

    switchover_endpoint_resource = confluentcloud.SwitchoverEndpoint("switchoverEndpointResource",
    display_name="string",
    endpoints=[{
        "endpoint_filter": {
            "type": "string",
            "access_point_crn": "string",
            "network_crn": "string",
        },
        "name": "string",
        "cloud": "string",
        "connection_type": "string",
        "hostname": "string",
        "region": "string",
    }],
    parent_resource_crn="string")

    const switchoverEndpointResource = new confluentcloud.SwitchoverEndpoint("switchoverEndpointResource", {
    displayName: "string",
    endpoints: [{
        endpointFilter: {
            type: "string",
            accessPointCrn: "string",
            networkCrn: "string",
        },
        name: "string",
        cloud: "string",
        connectionType: "string",
        hostname: "string",
        region: "string",
    }],
    parentResourceCrn: "string",
});

    type: confluentcloud:SwitchoverEndpoint
properties:
    displayName: string
    endpoints:
        - cloud: string
          connectionType: string
          endpointFilter:
            accessPointCrn: string
            networkCrn: string
            type: string
          hostname: string
          name: string
          region: string
    parentResourceCrn: string

    SwitchoverEndpoint 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 SwitchoverEndpoint resource accepts the following input properties:

    DisplayName string
    A human-readable name for the switchover endpoint.
    Endpoints List<Pulumi.ConfluentCloud.Inputs.SwitchoverEndpointEndpoint>
    (Required Configuration Block) In addition to the arguments above, each endpoint exports the following:
    ParentResourceCrn string
    The CRN of the switchover pair this endpoint is bound to, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123. The CRN carries the pair's environment.
    DisplayName string
    A human-readable name for the switchover endpoint.
    Endpoints []SwitchoverEndpointEndpointArgs
    (Required Configuration Block) In addition to the arguments above, each endpoint exports the following:
    ParentResourceCrn string
    The CRN of the switchover pair this endpoint is bound to, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123. The CRN carries the pair's environment.
    display_name string
    A human-readable name for the switchover endpoint.
    endpoints list(object)
    (Required Configuration Block) In addition to the arguments above, each endpoint exports the following:
    parent_resource_crn string
    The CRN of the switchover pair this endpoint is bound to, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123. The CRN carries the pair's environment.
    displayName String
    A human-readable name for the switchover endpoint.
    endpoints List<SwitchoverEndpointEndpoint>
    (Required Configuration Block) In addition to the arguments above, each endpoint exports the following:
    parentResourceCrn String
    The CRN of the switchover pair this endpoint is bound to, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123. The CRN carries the pair's environment.
    displayName string
    A human-readable name for the switchover endpoint.
    endpoints SwitchoverEndpointEndpoint[]
    (Required Configuration Block) In addition to the arguments above, each endpoint exports the following:
    parentResourceCrn string
    The CRN of the switchover pair this endpoint is bound to, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123. The CRN carries the pair's environment.
    display_name str
    A human-readable name for the switchover endpoint.
    endpoints Sequence[SwitchoverEndpointEndpointArgs]
    (Required Configuration Block) In addition to the arguments above, each endpoint exports the following:
    parent_resource_crn str
    The CRN of the switchover pair this endpoint is bound to, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123. The CRN carries the pair's environment.
    displayName String
    A human-readable name for the switchover endpoint.
    endpoints List<Property Map>
    (Required Configuration Block) In addition to the arguments above, each endpoint exports the following:
    parentResourceCrn String
    The CRN of the switchover pair this endpoint is bound to, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123. The CRN carries the pair's environment.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Phase string
    (Required String) The lifecycle phase of the switchover endpoint.
    Target string
    (Required String) Read-only. The name of the endpoint that is currently active. The Switchover service derives it from the pair's active member at create time and moves it on every failover; it cannot be set (the API marks it readOnly).
    Id string
    The provider-assigned unique ID for this managed resource.
    Phase string
    (Required String) The lifecycle phase of the switchover endpoint.
    Target string
    (Required String) Read-only. The name of the endpoint that is currently active. The Switchover service derives it from the pair's active member at create time and moves it on every failover; it cannot be set (the API marks it readOnly).
    id string
    The provider-assigned unique ID for this managed resource.
    phase string
    (Required String) The lifecycle phase of the switchover endpoint.
    target string
    (Required String) Read-only. The name of the endpoint that is currently active. The Switchover service derives it from the pair's active member at create time and moves it on every failover; it cannot be set (the API marks it readOnly).
    id String
    The provider-assigned unique ID for this managed resource.
    phase String
    (Required String) The lifecycle phase of the switchover endpoint.
    target String
    (Required String) Read-only. The name of the endpoint that is currently active. The Switchover service derives it from the pair's active member at create time and moves it on every failover; it cannot be set (the API marks it readOnly).
    id string
    The provider-assigned unique ID for this managed resource.
    phase string
    (Required String) The lifecycle phase of the switchover endpoint.
    target string
    (Required String) Read-only. The name of the endpoint that is currently active. The Switchover service derives it from the pair's active member at create time and moves it on every failover; it cannot be set (the API marks it readOnly).
    id str
    The provider-assigned unique ID for this managed resource.
    phase str
    (Required String) The lifecycle phase of the switchover endpoint.
    target str
    (Required String) Read-only. The name of the endpoint that is currently active. The Switchover service derives it from the pair's active member at create time and moves it on every failover; it cannot be set (the API marks it readOnly).
    id String
    The provider-assigned unique ID for this managed resource.
    phase String
    (Required String) The lifecycle phase of the switchover endpoint.
    target String
    (Required String) Read-only. The name of the endpoint that is currently active. The Switchover service derives it from the pair's active member at create time and moves it on every failover; it cannot be set (the API marks it readOnly).

    Look up Existing SwitchoverEndpoint Resource

    Get an existing SwitchoverEndpoint 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?: SwitchoverEndpointState, opts?: CustomResourceOptions): SwitchoverEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        display_name: Optional[str] = None,
        endpoints: Optional[Sequence[SwitchoverEndpointEndpointArgs]] = None,
        parent_resource_crn: Optional[str] = None,
        phase: Optional[str] = None,
        target: Optional[str] = None) -> SwitchoverEndpoint
    func GetSwitchoverEndpoint(ctx *Context, name string, id IDInput, state *SwitchoverEndpointState, opts ...ResourceOption) (*SwitchoverEndpoint, error)
    public static SwitchoverEndpoint Get(string name, Input<string> id, SwitchoverEndpointState? state, CustomResourceOptions? opts = null)
    public static SwitchoverEndpoint get(String name, Output<String> id, SwitchoverEndpointState state, CustomResourceOptions options)
    resources:  _:    type: confluentcloud:SwitchoverEndpoint    get:      id: ${id}
    import {
  to = confluentcloud_switchover_endpoint.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:
    DisplayName string
    A human-readable name for the switchover endpoint.
    Endpoints List<Pulumi.ConfluentCloud.Inputs.SwitchoverEndpointEndpoint>
    (Required Configuration Block) In addition to the arguments above, each endpoint exports the following:
    ParentResourceCrn string
    The CRN of the switchover pair this endpoint is bound to, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123. The CRN carries the pair's environment.
    Phase string
    (Required String) The lifecycle phase of the switchover endpoint.
    Target string
    (Required String) Read-only. The name of the endpoint that is currently active. The Switchover service derives it from the pair's active member at create time and moves it on every failover; it cannot be set (the API marks it readOnly).
    DisplayName string
    A human-readable name for the switchover endpoint.
    Endpoints []SwitchoverEndpointEndpointArgs
    (Required Configuration Block) In addition to the arguments above, each endpoint exports the following:
    ParentResourceCrn string
    The CRN of the switchover pair this endpoint is bound to, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123. The CRN carries the pair's environment.
    Phase string
    (Required String) The lifecycle phase of the switchover endpoint.
    Target string
    (Required String) Read-only. The name of the endpoint that is currently active. The Switchover service derives it from the pair's active member at create time and moves it on every failover; it cannot be set (the API marks it readOnly).
    display_name string
    A human-readable name for the switchover endpoint.
    endpoints list(object)
    (Required Configuration Block) In addition to the arguments above, each endpoint exports the following:
    parent_resource_crn string
    The CRN of the switchover pair this endpoint is bound to, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123. The CRN carries the pair's environment.
    phase string
    (Required String) The lifecycle phase of the switchover endpoint.
    target string
    (Required String) Read-only. The name of the endpoint that is currently active. The Switchover service derives it from the pair's active member at create time and moves it on every failover; it cannot be set (the API marks it readOnly).
    displayName String
    A human-readable name for the switchover endpoint.
    endpoints List<SwitchoverEndpointEndpoint>
    (Required Configuration Block) In addition to the arguments above, each endpoint exports the following:
    parentResourceCrn String
    The CRN of the switchover pair this endpoint is bound to, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123. The CRN carries the pair's environment.
    phase String
    (Required String) The lifecycle phase of the switchover endpoint.
    target String
    (Required String) Read-only. The name of the endpoint that is currently active. The Switchover service derives it from the pair's active member at create time and moves it on every failover; it cannot be set (the API marks it readOnly).
    displayName string
    A human-readable name for the switchover endpoint.
    endpoints SwitchoverEndpointEndpoint[]
    (Required Configuration Block) In addition to the arguments above, each endpoint exports the following:
    parentResourceCrn string
    The CRN of the switchover pair this endpoint is bound to, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123. The CRN carries the pair's environment.
    phase string
    (Required String) The lifecycle phase of the switchover endpoint.
    target string
    (Required String) Read-only. The name of the endpoint that is currently active. The Switchover service derives it from the pair's active member at create time and moves it on every failover; it cannot be set (the API marks it readOnly).
    display_name str
    A human-readable name for the switchover endpoint.
    endpoints Sequence[SwitchoverEndpointEndpointArgs]
    (Required Configuration Block) In addition to the arguments above, each endpoint exports the following:
    parent_resource_crn str
    The CRN of the switchover pair this endpoint is bound to, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123. The CRN carries the pair's environment.
    phase str
    (Required String) The lifecycle phase of the switchover endpoint.
    target str
    (Required String) Read-only. The name of the endpoint that is currently active. The Switchover service derives it from the pair's active member at create time and moves it on every failover; it cannot be set (the API marks it readOnly).
    displayName String
    A human-readable name for the switchover endpoint.
    endpoints List<Property Map>
    (Required Configuration Block) In addition to the arguments above, each endpoint exports the following:
    parentResourceCrn String
    The CRN of the switchover pair this endpoint is bound to, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123. The CRN carries the pair's environment.
    phase String
    (Required String) The lifecycle phase of the switchover endpoint.
    target String
    (Required String) Read-only. The name of the endpoint that is currently active. The Switchover service derives it from the pair's active member at create time and moves it on every failover; it cannot be set (the API marks it readOnly).

    Supporting Types

    SwitchoverEndpointEndpoint, SwitchoverEndpointEndpointArgs

    EndpointFilter Pulumi.ConfluentCloud.Inputs.SwitchoverEndpointEndpointEndpointFilter
    Filter criteria that identify a network endpoint for this side of the pair. Supports the following:
    Name string
    A logical name for this endpoint side (for example, west-platt), unique within the resource.
    Cloud string
    (Required String) The cloud provider this endpoint resolves to.
    ConnectionType string
    (Required String) The connection type this endpoint resolves to.
    Hostname string
    (Required String) The resolved hostname for this endpoint.
    Region string
    (Required String) The cloud region this endpoint resolves to.
    EndpointFilter SwitchoverEndpointEndpointEndpointFilter
    Filter criteria that identify a network endpoint for this side of the pair. Supports the following:
    Name string
    A logical name for this endpoint side (for example, west-platt), unique within the resource.
    Cloud string
    (Required String) The cloud provider this endpoint resolves to.
    ConnectionType string
    (Required String) The connection type this endpoint resolves to.
    Hostname string
    (Required String) The resolved hostname for this endpoint.
    Region string
    (Required String) The cloud region this endpoint resolves to.
    endpoint_filter object
    Filter criteria that identify a network endpoint for this side of the pair. Supports the following:
    name string
    A logical name for this endpoint side (for example, west-platt), unique within the resource.
    cloud string
    (Required String) The cloud provider this endpoint resolves to.
    connection_type string
    (Required String) The connection type this endpoint resolves to.
    hostname string
    (Required String) The resolved hostname for this endpoint.
    region string
    (Required String) The cloud region this endpoint resolves to.
    endpointFilter SwitchoverEndpointEndpointEndpointFilter
    Filter criteria that identify a network endpoint for this side of the pair. Supports the following:
    name String
    A logical name for this endpoint side (for example, west-platt), unique within the resource.
    cloud String
    (Required String) The cloud provider this endpoint resolves to.
    connectionType String
    (Required String) The connection type this endpoint resolves to.
    hostname String
    (Required String) The resolved hostname for this endpoint.
    region String
    (Required String) The cloud region this endpoint resolves to.
    endpointFilter SwitchoverEndpointEndpointEndpointFilter
    Filter criteria that identify a network endpoint for this side of the pair. Supports the following:
    name string
    A logical name for this endpoint side (for example, west-platt), unique within the resource.
    cloud string
    (Required String) The cloud provider this endpoint resolves to.
    connectionType string
    (Required String) The connection type this endpoint resolves to.
    hostname string
    (Required String) The resolved hostname for this endpoint.
    region string
    (Required String) The cloud region this endpoint resolves to.
    endpoint_filter SwitchoverEndpointEndpointEndpointFilter
    Filter criteria that identify a network endpoint for this side of the pair. Supports the following:
    name str
    A logical name for this endpoint side (for example, west-platt), unique within the resource.
    cloud str
    (Required String) The cloud provider this endpoint resolves to.
    connection_type str
    (Required String) The connection type this endpoint resolves to.
    hostname str
    (Required String) The resolved hostname for this endpoint.
    region str
    (Required String) The cloud region this endpoint resolves to.
    endpointFilter Property Map
    Filter criteria that identify a network endpoint for this side of the pair. Supports the following:
    name String
    A logical name for this endpoint side (for example, west-platt), unique within the resource.
    cloud String
    (Required String) The cloud provider this endpoint resolves to.
    connectionType String
    (Required String) The connection type this endpoint resolves to.
    hostname String
    (Required String) The resolved hostname for this endpoint.
    region String
    (Required String) The cloud region this endpoint resolves to.

    SwitchoverEndpointEndpointEndpointFilter, SwitchoverEndpointEndpointEndpointFilterArgs

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

    Import

    Note: CONFLUENT_CLOUD_API_KEY and CONFLUENT_CLOUD_API_SECRET environment variables must be set before importing a switchover endpoint.

    You can import a switchover endpoint by using the parent resource CRN and switchover endpoint ID, in the format <Parent Resource CRN>/<Switchover Endpoint ID>. The following example shows how to import a switchover endpoint:

    $ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"
$ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"
$ pulumi import confluentcloud:index/switchoverEndpoint:SwitchoverEndpoint example crn://confluent.cloud/organization=org-abc/environment=env-abc123/switchover-pair=sw-abc123/se-abc123

    Warning: Do not forget to delete terminal command history afterwards for security purposes.

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

    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