Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Civo Provider
  4. API Docs
  5. getVpcLoadbalancer
Viewing docs for civo 1.3.1
published on Thursday, Aug 6, 2026 by civo
Schema (JSON)
civo/terraform-provider-civo

civo.getVpcLoadbalancer

civo logo
Viewing docs for civo 1.3.1
published on Thursday, Aug 6, 2026 by civo
Schema (JSON)
civo/terraform-provider-civo

    Get information on a load balancer for use in other resources. This data source provides all of the load balancers properties as configured on your Civo account.

    An error will be raised if the provided load balancer name does not exist in your Civo account.

    Using getVpcLoadbalancer

    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 getVpcLoadbalancer(args: GetVpcLoadbalancerArgs, opts?: InvokeOptions): Promise<GetVpcLoadbalancerResult>
function getVpcLoadbalancerOutput(args: GetVpcLoadbalancerOutputArgs, opts?: InvokeOptions): Output<GetVpcLoadbalancerResult>
    def get_vpc_loadbalancer(id: Optional[str] = None,
                         name: Optional[str] = None,
                         region: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetVpcLoadbalancerResult
def get_vpc_loadbalancer_output(id: pulumi.Input[Optional[str]] = None,
                         name: pulumi.Input[Optional[str]] = None,
                         region: pulumi.Input[Optional[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetVpcLoadbalancerResult]
    func GetVpcLoadbalancer(ctx *Context, args *GetVpcLoadbalancerArgs, opts ...InvokeOption) (*GetVpcLoadbalancerResult, error)
func GetVpcLoadbalancerOutput(ctx *Context, args *GetVpcLoadbalancerOutputArgs, opts ...InvokeOption) GetVpcLoadbalancerResultOutput

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

    public static class GetVpcLoadbalancer 
{
    public static Task<GetVpcLoadbalancerResult> InvokeAsync(GetVpcLoadbalancerArgs args, InvokeOptions? opts = null)
    public static Output<GetVpcLoadbalancerResult> Invoke(GetVpcLoadbalancerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVpcLoadbalancerResult> getVpcLoadbalancer(GetVpcLoadbalancerArgs args, InvokeOptions options)
public static Output<GetVpcLoadbalancerResult> getVpcLoadbalancer(GetVpcLoadbalancerArgs args, InvokeOptions options)

    fn::invoke:
  function: civo:index/getVpcLoadbalancer:getVpcLoadbalancer
  arguments:
    # arguments dictionary
    data "civo_get_vpc_loadbalancer" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    The id of the load balancer to retrieve (You can find this id from service annotations 'kubernetes.civo.com/loadbalancer-id')
    Name string
    The name of the load balancer (You can find this name from service annotations 'kubernetes.civo.com/loadbalancer-name')
    Region string
    The region of the load balancer, if you declare this field, the datasource will use this value instead of the one defined in the provider
    Id string
    The id of the load balancer to retrieve (You can find this id from service annotations 'kubernetes.civo.com/loadbalancer-id')
    Name string
    The name of the load balancer (You can find this name from service annotations 'kubernetes.civo.com/loadbalancer-name')
    Region string
    The region of the load balancer, if you declare this field, the datasource will use this value instead of the one defined in the provider
    id string
    The id of the load balancer to retrieve (You can find this id from service annotations 'kubernetes.civo.com/loadbalancer-id')
    name string
    The name of the load balancer (You can find this name from service annotations 'kubernetes.civo.com/loadbalancer-name')
    region string
    The region of the load balancer, if you declare this field, the datasource will use this value instead of the one defined in the provider
    id String
    The id of the load balancer to retrieve (You can find this id from service annotations 'kubernetes.civo.com/loadbalancer-id')
    name String
    The name of the load balancer (You can find this name from service annotations 'kubernetes.civo.com/loadbalancer-name')
    region String
    The region of the load balancer, if you declare this field, the datasource will use this value instead of the one defined in the provider
    id string
    The id of the load balancer to retrieve (You can find this id from service annotations 'kubernetes.civo.com/loadbalancer-id')
    name string
    The name of the load balancer (You can find this name from service annotations 'kubernetes.civo.com/loadbalancer-name')
    region string
    The region of the load balancer, if you declare this field, the datasource will use this value instead of the one defined in the provider
    id str
    The id of the load balancer to retrieve (You can find this id from service annotations 'kubernetes.civo.com/loadbalancer-id')
    name str
    The name of the load balancer (You can find this name from service annotations 'kubernetes.civo.com/loadbalancer-name')
    region str
    The region of the load balancer, if you declare this field, the datasource will use this value instead of the one defined in the provider
    id String
    The id of the load balancer to retrieve (You can find this id from service annotations 'kubernetes.civo.com/loadbalancer-id')
    name String
    The name of the load balancer (You can find this name from service annotations 'kubernetes.civo.com/loadbalancer-name')
    region String
    The region of the load balancer, if you declare this field, the datasource will use this value instead of the one defined in the provider

    getVpcLoadbalancer Result

    The following output properties are available:

    Algorithm string
    The algorithm used by the load balancer
    Backends List<GetVpcLoadbalancerBackend>
    ClusterId string
    The cluster id of the load balancer
    EnableProxyProtocol string
    The enabled proxy protocol of the load balancer
    ExternalTrafficPolicy string
    The external traffic policy of the load balancer
    FirewallId string
    The firewall id of the load balancer
    PrivateIp string
    The private ip of the load balancer
    PublicIp string
    The public ip of the load balancer
    SessionAffinity string
    The session affinity of the load balancer
    SessionAffinityConfigTimeout double
    The session affinity config timeout of the load balancer
    State string
    The state of the load balancer
    Id string
    The id of the load balancer to retrieve (You can find this id from service annotations 'kubernetes.civo.com/loadbalancer-id')
    Name string
    The name of the load balancer (You can find this name from service annotations 'kubernetes.civo.com/loadbalancer-name')
    Region string
    The region of the load balancer, if you declare this field, the datasource will use this value instead of the one defined in the provider
    Algorithm string
    The algorithm used by the load balancer
    Backends []GetVpcLoadbalancerBackend
    ClusterId string
    The cluster id of the load balancer
    EnableProxyProtocol string
    The enabled proxy protocol of the load balancer
    ExternalTrafficPolicy string
    The external traffic policy of the load balancer
    FirewallId string
    The firewall id of the load balancer
    PrivateIp string
    The private ip of the load balancer
    PublicIp string
    The public ip of the load balancer
    SessionAffinity string
    The session affinity of the load balancer
    SessionAffinityConfigTimeout float64
    The session affinity config timeout of the load balancer
    State string
    The state of the load balancer
    Id string
    The id of the load balancer to retrieve (You can find this id from service annotations 'kubernetes.civo.com/loadbalancer-id')
    Name string
    The name of the load balancer (You can find this name from service annotations 'kubernetes.civo.com/loadbalancer-name')
    Region string
    The region of the load balancer, if you declare this field, the datasource will use this value instead of the one defined in the provider
    algorithm string
    The algorithm used by the load balancer
    backends list(object)
    cluster_id string
    The cluster id of the load balancer
    enable_proxy_protocol string
    The enabled proxy protocol of the load balancer
    external_traffic_policy string
    The external traffic policy of the load balancer
    firewall_id string
    The firewall id of the load balancer
    private_ip string
    The private ip of the load balancer
    public_ip string
    The public ip of the load balancer
    session_affinity string
    The session affinity of the load balancer
    session_affinity_config_timeout number
    The session affinity config timeout of the load balancer
    state string
    The state of the load balancer
    id string
    The id of the load balancer to retrieve (You can find this id from service annotations 'kubernetes.civo.com/loadbalancer-id')
    name string
    The name of the load balancer (You can find this name from service annotations 'kubernetes.civo.com/loadbalancer-name')
    region string
    The region of the load balancer, if you declare this field, the datasource will use this value instead of the one defined in the provider
    algorithm String
    The algorithm used by the load balancer
    backends List<GetVpcLoadbalancerBackend>
    clusterId String
    The cluster id of the load balancer
    enableProxyProtocol String
    The enabled proxy protocol of the load balancer
    externalTrafficPolicy String
    The external traffic policy of the load balancer
    firewallId String
    The firewall id of the load balancer
    privateIp String
    The private ip of the load balancer
    publicIp String
    The public ip of the load balancer
    sessionAffinity String
    The session affinity of the load balancer
    sessionAffinityConfigTimeout Double
    The session affinity config timeout of the load balancer
    state String
    The state of the load balancer
    id String
    The id of the load balancer to retrieve (You can find this id from service annotations 'kubernetes.civo.com/loadbalancer-id')
    name String
    The name of the load balancer (You can find this name from service annotations 'kubernetes.civo.com/loadbalancer-name')
    region String
    The region of the load balancer, if you declare this field, the datasource will use this value instead of the one defined in the provider
    algorithm string
    The algorithm used by the load balancer
    backends GetVpcLoadbalancerBackend[]
    clusterId string
    The cluster id of the load balancer
    enableProxyProtocol string
    The enabled proxy protocol of the load balancer
    externalTrafficPolicy string
    The external traffic policy of the load balancer
    firewallId string
    The firewall id of the load balancer
    privateIp string
    The private ip of the load balancer
    publicIp string
    The public ip of the load balancer
    sessionAffinity string
    The session affinity of the load balancer
    sessionAffinityConfigTimeout number
    The session affinity config timeout of the load balancer
    state string
    The state of the load balancer
    id string
    The id of the load balancer to retrieve (You can find this id from service annotations 'kubernetes.civo.com/loadbalancer-id')
    name string
    The name of the load balancer (You can find this name from service annotations 'kubernetes.civo.com/loadbalancer-name')
    region string
    The region of the load balancer, if you declare this field, the datasource will use this value instead of the one defined in the provider
    algorithm str
    The algorithm used by the load balancer
    backends Sequence[GetVpcLoadbalancerBackend]
    cluster_id str
    The cluster id of the load balancer
    enable_proxy_protocol str
    The enabled proxy protocol of the load balancer
    external_traffic_policy str
    The external traffic policy of the load balancer
    firewall_id str
    The firewall id of the load balancer
    private_ip str
    The private ip of the load balancer
    public_ip str
    The public ip of the load balancer
    session_affinity str
    The session affinity of the load balancer
    session_affinity_config_timeout float
    The session affinity config timeout of the load balancer
    state str
    The state of the load balancer
    id str
    The id of the load balancer to retrieve (You can find this id from service annotations 'kubernetes.civo.com/loadbalancer-id')
    name str
    The name of the load balancer (You can find this name from service annotations 'kubernetes.civo.com/loadbalancer-name')
    region str
    The region of the load balancer, if you declare this field, the datasource will use this value instead of the one defined in the provider
    algorithm String
    The algorithm used by the load balancer
    backends List<Property Map>
    clusterId String
    The cluster id of the load balancer
    enableProxyProtocol String
    The enabled proxy protocol of the load balancer
    externalTrafficPolicy String
    The external traffic policy of the load balancer
    firewallId String
    The firewall id of the load balancer
    privateIp String
    The private ip of the load balancer
    publicIp String
    The public ip of the load balancer
    sessionAffinity String
    The session affinity of the load balancer
    sessionAffinityConfigTimeout Number
    The session affinity config timeout of the load balancer
    state String
    The state of the load balancer
    id String
    The id of the load balancer to retrieve (You can find this id from service annotations 'kubernetes.civo.com/loadbalancer-id')
    name String
    The name of the load balancer (You can find this name from service annotations 'kubernetes.civo.com/loadbalancer-name')
    region String
    The region of the load balancer, if you declare this field, the datasource will use this value instead of the one defined in the provider

    Supporting Types

    GetVpcLoadbalancerBackend

    HealthCheckPort double
    Ip string
    Protocol string
    SourcePort double
    TargetPort double
    HealthCheckPort float64
    Ip string
    Protocol string
    SourcePort float64
    TargetPort float64
    health_check_port number
    ip string
    protocol string
    source_port number
    target_port number
    healthCheckPort Double
    ip String
    protocol String
    sourcePort Double
    targetPort Double
    healthCheckPort number
    ip string
    protocol string
    sourcePort number
    targetPort number
    healthCheckPort Number
    ip String
    protocol String
    sourcePort Number
    targetPort Number

    Package Details

    Repository
    Civo civo/terraform-provider-civo
    License
    Notes
    This Pulumi package is based on the civo Terraform Provider.
    civo logo
    Viewing docs for civo 1.3.1
    published on Thursday, Aug 6, 2026 by civo
    Schema (JSON)
    civo/terraform-provider-civo

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial