published on Friday, Oct 16, 2026 by Pulumi
published on Friday, Oct 16, 2026 by Pulumi
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 dictionarydata "confluentcloud_get_switchover_endpoints" "name" {
# arguments
}The following arguments are supported:
- 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 stringId - 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 stringId - 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_ stringid - 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 StringId - 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 stringId - 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_ strid - 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 StringId - Only list endpoints bound to this switchover pair, for example,
sw-abc123.
getSwitchoverEndpoints Result
The following output properties are available:
- Environment
Crn string - Id string
- The provider-assigned unique ID for this managed resource.
- Switchover
Endpoints List<Pulumi.Confluent Cloud. Outputs. Get Switchover Endpoints Switchover Endpoint> - (Required List of Object) The matching switchover endpoints. Each object exports the same attributes as the
confluentcloud.SwitchoverEndpointdata source: - Switchover
Pair stringId
- Environment
Crn string - Id string
- The provider-assigned unique ID for this managed resource.
- Switchover
Endpoints []GetSwitchover Endpoints Switchover Endpoint - (Required List of Object) The matching switchover endpoints. Each object exports the same attributes as the
confluentcloud.SwitchoverEndpointdata source: - Switchover
Pair stringId
- 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.SwitchoverEndpointdata source: - switchover_
pair_ stringid
- environment
Crn String - id String
- The provider-assigned unique ID for this managed resource.
- switchover
Endpoints List<GetSwitchover Endpoints Switchover Endpoint> - (Required List of Object) The matching switchover endpoints. Each object exports the same attributes as the
confluentcloud.SwitchoverEndpointdata source: - switchover
Pair StringId
- environment
Crn string - id string
- The provider-assigned unique ID for this managed resource.
- switchover
Endpoints GetSwitchover Endpoints Switchover Endpoint[] - (Required List of Object) The matching switchover endpoints. Each object exports the same attributes as the
confluentcloud.SwitchoverEndpointdata source: - switchover
Pair stringId
- environment_
crn str - id str
- The provider-assigned unique ID for this managed resource.
- switchover_
endpoints Sequence[GetSwitchover Endpoints Switchover Endpoint] - (Required List of Object) The matching switchover endpoints. Each object exports the same attributes as the
confluentcloud.SwitchoverEndpointdata source: - switchover_
pair_ strid
- environment
Crn String - id String
- The provider-assigned unique ID for this managed resource.
- switchover
Endpoints List<Property Map> - (Required List of Object) The matching switchover endpoints. Each object exports the same attributes as the
confluentcloud.SwitchoverEndpointdata source: - switchover
Pair StringId
Supporting Types
GetSwitchoverEndpointsSwitchoverEndpoint
- Display
Name string - (Required String) A human-readable name for the switchover endpoint.
- Endpoints
List<Pulumi.
Confluent Cloud. Inputs. Get Switchover Endpoints Switchover Endpoint Endpoint> - (Required List of Object) The endpoint definitions, one per side. Each exports
name,hostname,cloud,region,connectionType, and anendpointFilterobject withtype,networkCrn, andaccessPointCrn. - Id string
- (Required String) The ID of the switchover endpoint, for example,
se-abc123. - Parent
Resource stringCrn - (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
[]Get
Switchover Endpoints Switchover Endpoint Endpoint - (Required List of Object) The endpoint definitions, one per side. Each exports
name,hostname,cloud,region,connectionType, and anendpointFilterobject withtype,networkCrn, andaccessPointCrn. - Id string
- (Required String) The ID of the switchover endpoint, for example,
se-abc123. - Parent
Resource stringCrn - (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 anendpointFilterobject withtype,networkCrn, andaccessPointCrn. - id string
- (Required String) The ID of the switchover endpoint, for example,
se-abc123. - parent_
resource_ stringcrn - (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<Get
Switchover Endpoints Switchover Endpoint Endpoint> - (Required List of Object) The endpoint definitions, one per side. Each exports
name,hostname,cloud,region,connectionType, and anendpointFilterobject withtype,networkCrn, andaccessPointCrn. - id String
- (Required String) The ID of the switchover endpoint, for example,
se-abc123. - parent
Resource StringCrn - (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
Get
Switchover Endpoints Switchover Endpoint Endpoint[] - (Required List of Object) The endpoint definitions, one per side. Each exports
name,hostname,cloud,region,connectionType, and anendpointFilterobject withtype,networkCrn, andaccessPointCrn. - id string
- (Required String) The ID of the switchover endpoint, for example,
se-abc123. - parent
Resource stringCrn - (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[Get
Switchover Endpoints Switchover Endpoint Endpoint] - (Required List of Object) The endpoint definitions, one per side. Each exports
name,hostname,cloud,region,connectionType, and anendpointFilterobject withtype,networkCrn, andaccessPointCrn. - id str
- (Required String) The ID of the switchover endpoint, for example,
se-abc123. - parent_
resource_ strcrn - (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.
- display
Name 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 anendpointFilterobject withtype,networkCrn, andaccessPointCrn. - id String
- (Required String) The ID of the switchover endpoint, for example,
se-abc123. - parent
Resource StringCrn - (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
- Cloud string
- Connection
Type string - Endpoint
Filters []GetSwitchover Endpoints Switchover Endpoint Endpoint Endpoint Filter - Hostname string
- Name string
- Region string
- cloud string
- connection_
type string - endpoint_
filters list(object) - hostname string
- name string
- region string
- cloud String
- connection
Type String - endpoint
Filters List<GetSwitchover Endpoints Switchover Endpoint Endpoint Endpoint Filter> - hostname String
- name String
- region String
- cloud string
- connection
Type string - endpoint
Filters GetSwitchover Endpoints Switchover Endpoint Endpoint Endpoint Filter[] - hostname string
- name string
- region string
- cloud String
- connection
Type String - endpoint
Filters List<Property Map> - hostname String
- name String
- region String
GetSwitchoverEndpointsSwitchoverEndpointEndpointEndpointFilter
- Access
Point stringCrn - Network
Crn string - Type string
- Access
Point stringCrn - Network
Crn string - Type string
- access_
point_ stringcrn - network_
crn string - type string
- access
Point StringCrn - network
Crn String - type String
- access
Point stringCrn - network
Crn string - type string
- access_
point_ strcrn - network_
crn str - type str
- access
Point StringCrn - network
Crn String - type String
Package Details
- Repository
- Confluent Cloud pulumi/pulumi-confluentcloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
confluentTerraform Provider.
published on Friday, Oct 16, 2026 by Pulumi