1. Registry
  2. Packages
  3. Confluent Provider
  4. API Docs
  5. getSwitchoverEndpoints
Viewing docs for Confluent v2.87.0
published on Friday, Oct 16, 2026 by Pulumi
confluentcloud logo
Viewing docs for Confluent v2.87.0
published on Friday, Oct 16, 2026 by Pulumi

    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.getSwitchoverEndpoints lists the switchover endpoints in an environment, optionally only those bound to one switchover pair.

    Using getSwitchoverEndpoints

    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 getSwitchoverEndpoints(args: GetSwitchoverEndpointsArgs, opts?: InvokeOptions): Promise<GetSwitchoverEndpointsResult>
    function getSwitchoverEndpointsOutput(args: GetSwitchoverEndpointsOutputArgs, opts?: InvokeOutputOptions): Output<GetSwitchoverEndpointsResult>
    def get_switchover_endpoints(environment_crn: Optional[str] = None,
                                 switchover_pair_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetSwitchoverEndpointsResult
    def get_switchover_endpoints_output(environment_crn: pulumi.Input[Optional[str]] = None,
                                 switchover_pair_id: pulumi.Input[Optional[str]] = None,
                                 opts: Optional[InvokeOutputOptions] = None) -> Output[GetSwitchoverEndpointsResult]
    func GetSwitchoverEndpoints(ctx *Context, args *GetSwitchoverEndpointsArgs, opts ...InvokeOption) (*GetSwitchoverEndpointsResult, error)
    func GetSwitchoverEndpointsOutput(ctx *Context, args *GetSwitchoverEndpointsOutputArgs, opts ...InvokeOption) GetSwitchoverEndpointsResultOutput

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

    public static class GetSwitchoverEndpoints 
    {
        public static Task<GetSwitchoverEndpointsResult> InvokeAsync(GetSwitchoverEndpointsArgs args, InvokeOptions? opts = null)
        public static Output<GetSwitchoverEndpointsResult> Invoke(GetSwitchoverEndpointsInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetSwitchoverEndpointsResult> Invoke(GetSwitchoverEndpointsInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetSwitchoverEndpointsResult> getSwitchoverEndpoints(GetSwitchoverEndpointsArgs args, InvokeOptions options)
    public static Output<GetSwitchoverEndpointsResult> getSwitchoverEndpoints(GetSwitchoverEndpointsArgs args, InvokeOptions options)
    public static Output<GetSwitchoverEndpointsResult> getSwitchoverEndpoints(GetSwitchoverEndpointsArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: confluentcloud:index/getSwitchoverEndpoints:getSwitchoverEndpoints
      arguments:
        # arguments dictionary
    data "confluentcloud_get_switchover_endpoints" "name" {
        # arguments
    }

    The following arguments are supported:

    EnvironmentCrn string
    The CRN of the environment whose switchover endpoints to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    SwitchoverPairId string
    Only list endpoints bound to this switchover pair, for example, sw-abc123.
    EnvironmentCrn string
    The CRN of the environment whose switchover endpoints to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    SwitchoverPairId string
    Only list endpoints bound to this switchover pair, for example, sw-abc123.
    environment_crn string
    The CRN of the environment whose switchover endpoints to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    switchover_pair_id string
    Only list endpoints bound to this switchover pair, for example, sw-abc123.
    environmentCrn String
    The CRN of the environment whose switchover endpoints to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    switchoverPairId String
    Only list endpoints bound to this switchover pair, for example, sw-abc123.
    environmentCrn string
    The CRN of the environment whose switchover endpoints to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    switchoverPairId string
    Only list endpoints bound to this switchover pair, for example, sw-abc123.
    environment_crn str
    The CRN of the environment whose switchover endpoints to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    switchover_pair_id str
    Only list endpoints bound to this switchover pair, for example, sw-abc123.
    environmentCrn String
    The CRN of the environment whose switchover endpoints to list, for example, crn://confluent.cloud/organization=org-abc/environment=env-abc123.
    switchoverPairId String
    Only list endpoints bound to this switchover pair, for example, sw-abc123.

    getSwitchoverEndpoints Result

    The following output properties are available:

    EnvironmentCrn string
    Id string
    The provider-assigned unique ID for this managed resource.
    SwitchoverEndpoints List<Pulumi.ConfluentCloud.Outputs.GetSwitchoverEndpointsSwitchoverEndpoint>
    (Required List of Object) The matching switchover endpoints. Each object exports the same attributes as the confluentcloud.SwitchoverEndpoint data source:
    SwitchoverPairId string
    EnvironmentCrn string
    Id string
    The provider-assigned unique ID for this managed resource.
    SwitchoverEndpoints []GetSwitchoverEndpointsSwitchoverEndpoint
    (Required List of Object) The matching switchover endpoints. Each object exports the same attributes as the confluentcloud.SwitchoverEndpoint data source:
    SwitchoverPairId string
    environment_crn string
    id string
    The provider-assigned unique ID for this managed resource.
    switchover_endpoints list(object)
    (Required List of Object) The matching switchover endpoints. Each object exports the same attributes as the confluentcloud.SwitchoverEndpoint data source:
    switchover_pair_id string
    environmentCrn String
    id String
    The provider-assigned unique ID for this managed resource.
    switchoverEndpoints List<GetSwitchoverEndpointsSwitchoverEndpoint>
    (Required List of Object) The matching switchover endpoints. Each object exports the same attributes as the confluentcloud.SwitchoverEndpoint data source:
    switchoverPairId String
    environmentCrn string
    id string
    The provider-assigned unique ID for this managed resource.
    switchoverEndpoints GetSwitchoverEndpointsSwitchoverEndpoint[]
    (Required List of Object) The matching switchover endpoints. Each object exports the same attributes as the confluentcloud.SwitchoverEndpoint data source:
    switchoverPairId string
    environment_crn str
    id str
    The provider-assigned unique ID for this managed resource.
    switchover_endpoints Sequence[GetSwitchoverEndpointsSwitchoverEndpoint]
    (Required List of Object) The matching switchover endpoints. Each object exports the same attributes as the confluentcloud.SwitchoverEndpoint data source:
    switchover_pair_id str
    environmentCrn String
    id String
    The provider-assigned unique ID for this managed resource.
    switchoverEndpoints List<Property Map>
    (Required List of Object) The matching switchover endpoints. Each object exports the same attributes as the confluentcloud.SwitchoverEndpoint data source:
    switchoverPairId String

    Supporting Types

    GetSwitchoverEndpointsSwitchoverEndpoint

    DisplayName string
    (Required String) A human-readable name for the switchover endpoint.
    Endpoints List<Pulumi.ConfluentCloud.Inputs.GetSwitchoverEndpointsSwitchoverEndpointEndpoint>
    (Required List of Object) The endpoint definitions, one per side. Each exports name, hostname, cloud, region, connectionType, and an endpointFilter object with type, networkCrn, and accessPointCrn.
    Id string
    (Required String) The ID of the switchover endpoint, for example, se-abc123.
    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, for example, READY.
    Target string
    (Required String) The name of the endpoint side that is currently active; follows the pair's active member.
    DisplayName string
    (Required String) A human-readable name for the switchover endpoint.
    Endpoints []GetSwitchoverEndpointsSwitchoverEndpointEndpoint
    (Required List of Object) The endpoint definitions, one per side. Each exports name, hostname, cloud, region, connectionType, and an endpointFilter object with type, networkCrn, and accessPointCrn.
    Id string
    (Required String) The ID of the switchover endpoint, for example, se-abc123.
    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, for example, READY.
    Target string
    (Required String) The name of the endpoint side that is currently active; follows the pair's active member.
    display_name string
    (Required String) A human-readable name for the switchover endpoint.
    endpoints list(object)
    (Required List of Object) The endpoint definitions, one per side. Each exports name, hostname, cloud, region, connectionType, and an endpointFilter object with type, networkCrn, and accessPointCrn.
    id string
    (Required String) The ID of the switchover endpoint, for example, se-abc123.
    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, for example, READY.
    target string
    (Required String) The name of the endpoint side that is currently active; follows the pair's active member.
    displayName String
    (Required String) A human-readable name for the switchover endpoint.
    endpoints List<GetSwitchoverEndpointsSwitchoverEndpointEndpoint>
    (Required List of Object) The endpoint definitions, one per side. Each exports name, hostname, cloud, region, connectionType, and an endpointFilter object with type, networkCrn, and accessPointCrn.
    id String
    (Required String) The ID of the switchover endpoint, for example, se-abc123.
    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, for example, READY.
    target String
    (Required String) The name of the endpoint side that is currently active; follows the pair's active member.
    displayName string
    (Required String) A human-readable name for the switchover endpoint.
    endpoints GetSwitchoverEndpointsSwitchoverEndpointEndpoint[]
    (Required List of Object) The endpoint definitions, one per side. Each exports name, hostname, cloud, region, connectionType, and an endpointFilter object with type, networkCrn, and accessPointCrn.
    id string
    (Required String) The ID of the switchover endpoint, for example, se-abc123.
    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, for example, READY.
    target string
    (Required String) The name of the endpoint side that is currently active; follows the pair's active member.
    display_name str
    (Required String) A human-readable name for the switchover endpoint.
    endpoints Sequence[GetSwitchoverEndpointsSwitchoverEndpointEndpoint]
    (Required List of Object) The endpoint definitions, one per side. Each exports name, hostname, cloud, region, connectionType, and an endpointFilter object with type, networkCrn, and accessPointCrn.
    id str
    (Required String) The ID of the switchover endpoint, for example, se-abc123.
    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, for example, READY.
    target str
    (Required String) The name of the endpoint side that is currently active; follows the pair's active member.
    displayName String
    (Required String) A human-readable name for the switchover endpoint.
    endpoints List<Property Map>
    (Required List of Object) The endpoint definitions, one per side. Each exports name, hostname, cloud, region, connectionType, and an endpointFilter object with type, networkCrn, and accessPointCrn.
    id String
    (Required String) The ID of the switchover endpoint, for example, se-abc123.
    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, for example, READY.
    target String
    (Required String) The name of the endpoint side that is currently active; follows the pair's active member.

    GetSwitchoverEndpointsSwitchoverEndpointEndpoint

    GetSwitchoverEndpointsSwitchoverEndpointEndpointEndpointFilter

    AccessPointCrn string
    NetworkCrn string
    Type string
    AccessPointCrn string
    NetworkCrn string
    Type string
    access_point_crn string
    network_crn string
    type string
    accessPointCrn String
    networkCrn String
    type String
    accessPointCrn string
    networkCrn string
    type string
    accessPointCrn String
    networkCrn String
    type 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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial