Cloudflare v6.1.1, Apr 21 25

Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi

cloudflare.getLoadBalancers

Explore with Pulumi AI

Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi

Example Usage

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

const exampleLoadBalancers = cloudflare.getLoadBalancers({
    zoneId: "699d98642c564d2e855e9661899b7252",
});

import pulumi
import pulumi_cloudflare as cloudflare

example_load_balancers = cloudflare.get_load_balancers(zone_id="699d98642c564d2e855e9661899b7252")

package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.LookupLoadBalancers(ctx, &cloudflare.LookupLoadBalancersArgs{
			ZoneId: "699d98642c564d2e855e9661899b7252",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var exampleLoadBalancers = Cloudflare.GetLoadBalancers.Invoke(new()
    {
        ZoneId = "699d98642c564d2e855e9661899b7252",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetLoadBalancersArgs;
import java.util.List;
import java.util.ArrayList;
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 exampleLoadBalancers = CloudflareFunctions.getLoadBalancers(GetLoadBalancersArgs.builder()
            .zoneId("699d98642c564d2e855e9661899b7252")
            .build());

    }
}

variables:
  exampleLoadBalancers:
    fn::invoke:
      function: cloudflare:getLoadBalancers
      arguments:
        zoneId: 699d98642c564d2e855e9661899b7252

Using getLoadBalancers

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 getLoadBalancers(args: GetLoadBalancersArgs, opts?: InvokeOptions): Promise<GetLoadBalancersResult>
function getLoadBalancersOutput(args: GetLoadBalancersOutputArgs, opts?: InvokeOptions): Output<GetLoadBalancersResult>

def get_load_balancers(max_items: Optional[int] = None,
                       zone_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetLoadBalancersResult
def get_load_balancers_output(max_items: Optional[pulumi.Input[int]] = None,
                       zone_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetLoadBalancersResult]

func LookupLoadBalancers(ctx *Context, args *LookupLoadBalancersArgs, opts ...InvokeOption) (*LookupLoadBalancersResult, error)
func LookupLoadBalancersOutput(ctx *Context, args *LookupLoadBalancersOutputArgs, opts ...InvokeOption) LookupLoadBalancersResultOutput

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

public static class GetLoadBalancers 
{
    public static Task<GetLoadBalancersResult> InvokeAsync(GetLoadBalancersArgs args, InvokeOptions? opts = null)
    public static Output<GetLoadBalancersResult> Invoke(GetLoadBalancersInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetLoadBalancersResult> getLoadBalancers(GetLoadBalancersArgs args, InvokeOptions options)
public static Output<GetLoadBalancersResult> getLoadBalancers(GetLoadBalancersArgs args, InvokeOptions options)

fn::invoke:
  function: cloudflare:index/getLoadBalancers:getLoadBalancers
  arguments:
    # arguments dictionary

The following arguments are supported:

ZoneId string
MaxItems int: Max items to fetch, default: 1000

ZoneId string
MaxItems int: Max items to fetch, default: 1000

zoneId String
maxItems Integer: Max items to fetch, default: 1000

zoneId string
maxItems number: Max items to fetch, default: 1000

zone_id str
max_items int: Max items to fetch, default: 1000

zoneId String
maxItems Number: Max items to fetch, default: 1000

getLoadBalancers Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Results List<GetLoadBalancersResult>: The items returned by the data source
ZoneId string
MaxItems int: Max items to fetch, default: 1000

Id string: The provider-assigned unique ID for this managed resource.
Results []GetLoadBalancersResult: The items returned by the data source
ZoneId string
MaxItems int: Max items to fetch, default: 1000

id String: The provider-assigned unique ID for this managed resource.
results List<GetLoadBalancersResult>: The items returned by the data source
zoneId String
maxItems Integer: Max items to fetch, default: 1000

id string: The provider-assigned unique ID for this managed resource.
results GetLoadBalancersResult[]: The items returned by the data source
zoneId string
maxItems number: Max items to fetch, default: 1000

id str: The provider-assigned unique ID for this managed resource.
results Sequence[GetLoadBalancersResult]: The items returned by the data source
zone_id str
max_items int: Max items to fetch, default: 1000

id String: The provider-assigned unique ID for this managed resource.
results List<Property Map>: The items returned by the data source
zoneId String
maxItems Number: Max items to fetch, default: 1000

Supporting Types

GetLoadBalancersResult

AdaptiveRouting GetLoadBalancersResultAdaptiveRouting: Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.
CountryPools Dictionary<string, ImmutableArray<string>>: A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding regionpool mapping if it exists else to defaultpools.
CreatedOn string
DefaultPools List<string>: A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
Description string: Object description.
Enabled bool: Whether to enable (the default) this load balancer.
FallbackPool string: The pool ID to use when all other pools are detected as unhealthy.
Id string
LocationStrategy GetLoadBalancersResultLocationStrategy: Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected.
ModifiedOn string
Name string: The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.
Networks List<string>: List of networks where Load Balancer or Pool is enabled.
PopPools Dictionary<string, ImmutableArray<string>>: (Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding countrypool, then regionpool mapping if it exists else to default_pools.
Proxied bool: Whether the hostname should be gray clouded (false) or orange clouded (true).
RandomSteering GetLoadBalancersResultRandomSteering: Configures pool weights.
RegionPools Dictionary<string, ImmutableArray<string>>: A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
Rules List<GetLoadBalancersResultRule>: BETA Field Not General Access: A list of rules for this load balancer to execute.
SessionAffinity string: Specifies the type of session affinity the load balancer should use unless specified as "none". The supported types are:
SessionAffinityAttributes GetLoadBalancersResultSessionAffinityAttributes: Configures attributes for session affinity.
SessionAffinityTtl double: Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per session_affinity policy are:
SteeringPolicy string: Steering Policy for this load balancer.
Ttl double: Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.
ZoneName string

AdaptiveRouting GetLoadBalancersResultAdaptiveRouting: Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.
CountryPools map[string][]string: A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding regionpool mapping if it exists else to defaultpools.
CreatedOn string
DefaultPools []string: A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
Description string: Object description.
Enabled bool: Whether to enable (the default) this load balancer.
FallbackPool string: The pool ID to use when all other pools are detected as unhealthy.
Id string
LocationStrategy GetLoadBalancersResultLocationStrategy: Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected.
ModifiedOn string
Name string: The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.
Networks []string: List of networks where Load Balancer or Pool is enabled.
PopPools map[string][]string: (Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding countrypool, then regionpool mapping if it exists else to default_pools.
Proxied bool: Whether the hostname should be gray clouded (false) or orange clouded (true).
RandomSteering GetLoadBalancersResultRandomSteering: Configures pool weights.
RegionPools map[string][]string: A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
Rules []GetLoadBalancersResultRule: BETA Field Not General Access: A list of rules for this load balancer to execute.
SessionAffinity string: Specifies the type of session affinity the load balancer should use unless specified as "none". The supported types are:
SessionAffinityAttributes GetLoadBalancersResultSessionAffinityAttributes: Configures attributes for session affinity.
SessionAffinityTtl float64: Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per session_affinity policy are:
SteeringPolicy string: Steering Policy for this load balancer.
Ttl float64: Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.
ZoneName string

adaptiveRouting GetLoadBalancersResultAdaptiveRouting: Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.
countryPools Map<String,List<String>>: A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding regionpool mapping if it exists else to defaultpools.
createdOn String
defaultPools List<String>: A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
description String: Object description.
enabled Boolean: Whether to enable (the default) this load balancer.
fallbackPool String: The pool ID to use when all other pools are detected as unhealthy.
id String
locationStrategy GetLoadBalancersResultLocationStrategy: Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected.
modifiedOn String
name String: The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.
networks List<String>: List of networks where Load Balancer or Pool is enabled.
popPools Map<String,List<String>>: (Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding countrypool, then regionpool mapping if it exists else to default_pools.
proxied Boolean: Whether the hostname should be gray clouded (false) or orange clouded (true).
randomSteering GetLoadBalancersResultRandomSteering: Configures pool weights.
regionPools Map<String,List<String>>: A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
rules List<GetLoadBalancersResultRule>: BETA Field Not General Access: A list of rules for this load balancer to execute.
sessionAffinity String: Specifies the type of session affinity the load balancer should use unless specified as "none". The supported types are:
sessionAffinityAttributes GetLoadBalancersResultSessionAffinityAttributes: Configures attributes for session affinity.
sessionAffinityTtl Double: Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per session_affinity policy are:
steeringPolicy String: Steering Policy for this load balancer.
ttl Double: Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.
zoneName String

adaptiveRouting GetLoadBalancersResultAdaptiveRouting: Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.
countryPools {[key: string]: string[]}: A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding regionpool mapping if it exists else to defaultpools.
createdOn string
defaultPools string[]: A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
description string: Object description.
enabled boolean: Whether to enable (the default) this load balancer.
fallbackPool string: The pool ID to use when all other pools are detected as unhealthy.
id string
locationStrategy GetLoadBalancersResultLocationStrategy: Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected.
modifiedOn string
name string: The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.
networks string[]: List of networks where Load Balancer or Pool is enabled.
popPools {[key: string]: string[]}: (Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding countrypool, then regionpool mapping if it exists else to default_pools.
proxied boolean: Whether the hostname should be gray clouded (false) or orange clouded (true).
randomSteering GetLoadBalancersResultRandomSteering: Configures pool weights.
regionPools {[key: string]: string[]}: A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
rules GetLoadBalancersResultRule[]: BETA Field Not General Access: A list of rules for this load balancer to execute.
sessionAffinity string: Specifies the type of session affinity the load balancer should use unless specified as "none". The supported types are:
sessionAffinityAttributes GetLoadBalancersResultSessionAffinityAttributes: Configures attributes for session affinity.
sessionAffinityTtl number: Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per session_affinity policy are:
steeringPolicy string: Steering Policy for this load balancer.
ttl number: Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.
zoneName string

adaptive_routing GetLoadBalancersResultAdaptiveRouting: Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.
country_pools Mapping[str, Sequence[str]]: A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding regionpool mapping if it exists else to defaultpools.
created_on str
default_pools Sequence[str]: A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
description str: Object description.
enabled bool: Whether to enable (the default) this load balancer.
fallback_pool str: The pool ID to use when all other pools are detected as unhealthy.
id str
location_strategy GetLoadBalancersResultLocationStrategy: Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected.
modified_on str
name str: The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.
networks Sequence[str]: List of networks where Load Balancer or Pool is enabled.
pop_pools Mapping[str, Sequence[str]]: (Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding countrypool, then regionpool mapping if it exists else to default_pools.
proxied bool: Whether the hostname should be gray clouded (false) or orange clouded (true).
random_steering GetLoadBalancersResultRandomSteering: Configures pool weights.
region_pools Mapping[str, Sequence[str]]: A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
rules Sequence[GetLoadBalancersResultRule]: BETA Field Not General Access: A list of rules for this load balancer to execute.
session_affinity str: Specifies the type of session affinity the load balancer should use unless specified as "none". The supported types are:
session_affinity_attributes GetLoadBalancersResultSessionAffinityAttributes: Configures attributes for session affinity.
session_affinity_ttl float: Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per session_affinity policy are:
steering_policy str: Steering Policy for this load balancer.
ttl float: Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.
zone_name str

adaptiveRouting Property Map: Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.
countryPools Map<List<String>>: A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding regionpool mapping if it exists else to defaultpools.
createdOn String
defaultPools List<String>: A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
description String: Object description.
enabled Boolean: Whether to enable (the default) this load balancer.
fallbackPool String: The pool ID to use when all other pools are detected as unhealthy.
id String
locationStrategy Property Map: Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected.
modifiedOn String
name String: The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.
networks List<String>: List of networks where Load Balancer or Pool is enabled.
popPools Map<List<String>>: (Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding countrypool, then regionpool mapping if it exists else to default_pools.
proxied Boolean: Whether the hostname should be gray clouded (false) or orange clouded (true).
randomSteering Property Map: Configures pool weights.
regionPools Map<List<String>>: A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
rules List<Property Map>: BETA Field Not General Access: A list of rules for this load balancer to execute.
sessionAffinity String: Specifies the type of session affinity the load balancer should use unless specified as "none". The supported types are:
sessionAffinityAttributes Property Map: Configures attributes for session affinity.
sessionAffinityTtl Number: Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per session_affinity policy are:
steeringPolicy String: Steering Policy for this load balancer.
ttl Number: Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.
zoneName String

GetLoadBalancersResultAdaptiveRouting

FailoverAcrossPools bool: Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See session_affinity_attributes for control over when sessions are broken or reassigned.

FailoverAcrossPools bool: Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See session_affinity_attributes for control over when sessions are broken or reassigned.

failoverAcrossPools Boolean: Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See session_affinity_attributes for control over when sessions are broken or reassigned.

failoverAcrossPools boolean: Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See session_affinity_attributes for control over when sessions are broken or reassigned.

failover_across_pools bool: Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See session_affinity_attributes for control over when sessions are broken or reassigned.

failoverAcrossPools Boolean: Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See session_affinity_attributes for control over when sessions are broken or reassigned.

GetLoadBalancersResultLocationStrategy

Mode string: Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful.
PreferEcs string: Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location.

Mode string: Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful.
PreferEcs string: Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location.

mode String: Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful.
preferEcs String: Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location.

mode string: Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful.
preferEcs string: Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location.

mode str: Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful.
prefer_ecs str: Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location.

mode String: Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful.
preferEcs String: Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location.

GetLoadBalancersResultRandomSteering

DefaultWeight double: The default weight for pools in the load balancer that are not specified in the pool_weights map.
PoolWeights Dictionary<string, double>: A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

DefaultWeight float64: The default weight for pools in the load balancer that are not specified in the pool_weights map.
PoolWeights map[string]float64: A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

defaultWeight Double: The default weight for pools in the load balancer that are not specified in the pool_weights map.
poolWeights Map<String,Double>: A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

defaultWeight number: The default weight for pools in the load balancer that are not specified in the pool_weights map.
poolWeights {[key: string]: number}: A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

default_weight float: The default weight for pools in the load balancer that are not specified in the pool_weights map.
pool_weights Mapping[str, float]: A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

defaultWeight Number: The default weight for pools in the load balancer that are not specified in the pool_weights map.
poolWeights Map<Number>: A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

GetLoadBalancersResultRule

Condition string: The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.
Disabled bool: Disable this specific rule. It will no longer be evaluated by this load balancer.
FixedResponse GetLoadBalancersResultRuleFixedResponse: A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed*response is supplied the rule will be marked as terminates.
Name string: Name of this rule. Only used for human readability.
Overrides GetLoadBalancersResultRuleOverrides: A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.
Priority int: The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.
Terminates bool: If this rule's condition is true, this causes rule evaluation to stop after processing this rule.

Condition string: The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.
Disabled bool: Disable this specific rule. It will no longer be evaluated by this load balancer.
FixedResponse GetLoadBalancersResultRuleFixedResponse: A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed*response is supplied the rule will be marked as terminates.
Name string: Name of this rule. Only used for human readability.
Overrides GetLoadBalancersResultRuleOverrides: A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.
Priority int: The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.
Terminates bool: If this rule's condition is true, this causes rule evaluation to stop after processing this rule.

condition String: The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.
disabled Boolean: Disable this specific rule. It will no longer be evaluated by this load balancer.
fixedResponse GetLoadBalancersResultRuleFixedResponse: A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed*response is supplied the rule will be marked as terminates.
name String: Name of this rule. Only used for human readability.
overrides GetLoadBalancersResultRuleOverrides: A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.
priority Integer: The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.
terminates Boolean: If this rule's condition is true, this causes rule evaluation to stop after processing this rule.

condition string: The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.
disabled boolean: Disable this specific rule. It will no longer be evaluated by this load balancer.
fixedResponse GetLoadBalancersResultRuleFixedResponse: A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed*response is supplied the rule will be marked as terminates.
name string: Name of this rule. Only used for human readability.
overrides GetLoadBalancersResultRuleOverrides: A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.
priority number: The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.
terminates boolean: If this rule's condition is true, this causes rule evaluation to stop after processing this rule.

condition str: The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.
disabled bool: Disable this specific rule. It will no longer be evaluated by this load balancer.
fixed_response GetLoadBalancersResultRuleFixedResponse: A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed*response is supplied the rule will be marked as terminates.
name str: Name of this rule. Only used for human readability.
overrides GetLoadBalancersResultRuleOverrides: A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.
priority int: The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.
terminates bool: If this rule's condition is true, this causes rule evaluation to stop after processing this rule.

condition String: The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.
disabled Boolean: Disable this specific rule. It will no longer be evaluated by this load balancer.
fixedResponse Property Map: A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed*response is supplied the rule will be marked as terminates.
name String: Name of this rule. Only used for human readability.
overrides Property Map: A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.
priority Number: The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.
terminates Boolean: If this rule's condition is true, this causes rule evaluation to stop after processing this rule.

GetLoadBalancersResultRuleFixedResponse

ContentType string: The http 'Content-Type' header to include in the response.
Location string: The http 'Location' header to include in the response.
MessageBody string: Text to include as the http body.
StatusCode int: The http status code to respond with.

ContentType string: The http 'Content-Type' header to include in the response.
Location string: The http 'Location' header to include in the response.
MessageBody string: Text to include as the http body.
StatusCode int: The http status code to respond with.

contentType String: The http 'Content-Type' header to include in the response.
location String: The http 'Location' header to include in the response.
messageBody String: Text to include as the http body.
statusCode Integer: The http status code to respond with.

contentType string: The http 'Content-Type' header to include in the response.
location string: The http 'Location' header to include in the response.
messageBody string: Text to include as the http body.
statusCode number: The http status code to respond with.

content_type str: The http 'Content-Type' header to include in the response.
location str: The http 'Location' header to include in the response.
message_body str: Text to include as the http body.
status_code int: The http status code to respond with.

contentType String: The http 'Content-Type' header to include in the response.
location String: The http 'Location' header to include in the response.
messageBody String: Text to include as the http body.
statusCode Number: The http status code to respond with.

GetLoadBalancersResultRuleOverrides

AdaptiveRouting GetLoadBalancersResultRuleOverridesAdaptiveRouting: Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.
CountryPools Dictionary<string, ImmutableArray<string>>: A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding regionpool mapping if it exists else to defaultpools.
DefaultPools List<string>: A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
FallbackPool string: The pool ID to use when all other pools are detected as unhealthy.
LocationStrategy GetLoadBalancersResultRuleOverridesLocationStrategy: Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected.
PopPools Dictionary<string, ImmutableArray<string>>: (Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding countrypool, then regionpool mapping if it exists else to default_pools.
RandomSteering GetLoadBalancersResultRuleOverridesRandomSteering: Configures pool weights.
RegionPools Dictionary<string, ImmutableArray<string>>: A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
SessionAffinity string: Specifies the type of session affinity the load balancer should use unless specified as "none". The supported types are:
SessionAffinityAttributes GetLoadBalancersResultRuleOverridesSessionAffinityAttributes: Configures attributes for session affinity.
SessionAffinityTtl double: Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per session_affinity policy are:
SteeringPolicy string: Steering Policy for this load balancer.
Ttl double: Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

AdaptiveRouting GetLoadBalancersResultRuleOverridesAdaptiveRouting: Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.
CountryPools map[string][]string: A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding regionpool mapping if it exists else to defaultpools.
DefaultPools []string: A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
FallbackPool string: The pool ID to use when all other pools are detected as unhealthy.
LocationStrategy GetLoadBalancersResultRuleOverridesLocationStrategy: Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected.
PopPools map[string][]string: (Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding countrypool, then regionpool mapping if it exists else to default_pools.
RandomSteering GetLoadBalancersResultRuleOverridesRandomSteering: Configures pool weights.
RegionPools map[string][]string: A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
SessionAffinity string: Specifies the type of session affinity the load balancer should use unless specified as "none". The supported types are:
SessionAffinityAttributes GetLoadBalancersResultRuleOverridesSessionAffinityAttributes: Configures attributes for session affinity.
SessionAffinityTtl float64: Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per session_affinity policy are:
SteeringPolicy string: Steering Policy for this load balancer.
Ttl float64: Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

adaptiveRouting GetLoadBalancersResultRuleOverridesAdaptiveRouting: Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.
countryPools Map<String,List<String>>: A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding regionpool mapping if it exists else to defaultpools.
defaultPools List<String>: A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
fallbackPool String: The pool ID to use when all other pools are detected as unhealthy.
locationStrategy GetLoadBalancersResultRuleOverridesLocationStrategy: Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected.
popPools Map<String,List<String>>: (Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding countrypool, then regionpool mapping if it exists else to default_pools.
randomSteering GetLoadBalancersResultRuleOverridesRandomSteering: Configures pool weights.
regionPools Map<String,List<String>>: A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
sessionAffinity String: Specifies the type of session affinity the load balancer should use unless specified as "none". The supported types are:
sessionAffinityAttributes GetLoadBalancersResultRuleOverridesSessionAffinityAttributes: Configures attributes for session affinity.
sessionAffinityTtl Double: Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per session_affinity policy are:
steeringPolicy String: Steering Policy for this load balancer.
ttl Double: Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

adaptiveRouting GetLoadBalancersResultRuleOverridesAdaptiveRouting: Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.
countryPools {[key: string]: string[]}: A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding regionpool mapping if it exists else to defaultpools.
defaultPools string[]: A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
fallbackPool string: The pool ID to use when all other pools are detected as unhealthy.
locationStrategy GetLoadBalancersResultRuleOverridesLocationStrategy: Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected.
popPools {[key: string]: string[]}: (Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding countrypool, then regionpool mapping if it exists else to default_pools.
randomSteering GetLoadBalancersResultRuleOverridesRandomSteering: Configures pool weights.
regionPools {[key: string]: string[]}: A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
sessionAffinity string: Specifies the type of session affinity the load balancer should use unless specified as "none". The supported types are:
sessionAffinityAttributes GetLoadBalancersResultRuleOverridesSessionAffinityAttributes: Configures attributes for session affinity.
sessionAffinityTtl number: Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per session_affinity policy are:
steeringPolicy string: Steering Policy for this load balancer.
ttl number: Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

adaptive_routing GetLoadBalancersResultRuleOverridesAdaptiveRouting: Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.
country_pools Mapping[str, Sequence[str]]: A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding regionpool mapping if it exists else to defaultpools.
default_pools Sequence[str]: A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
fallback_pool str: The pool ID to use when all other pools are detected as unhealthy.
location_strategy GetLoadBalancersResultRuleOverridesLocationStrategy: Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected.
pop_pools Mapping[str, Sequence[str]]: (Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding countrypool, then regionpool mapping if it exists else to default_pools.
random_steering GetLoadBalancersResultRuleOverridesRandomSteering: Configures pool weights.
region_pools Mapping[str, Sequence[str]]: A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
session_affinity str: Specifies the type of session affinity the load balancer should use unless specified as "none". The supported types are:
session_affinity_attributes GetLoadBalancersResultRuleOverridesSessionAffinityAttributes: Configures attributes for session affinity.
session_affinity_ttl float: Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per session_affinity policy are:
steering_policy str: Steering Policy for this load balancer.
ttl float: Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

adaptiveRouting Property Map: Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.
countryPools Map<List<String>>: A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding regionpool mapping if it exists else to defaultpools.
defaultPools List<String>: A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
fallbackPool String: The pool ID to use when all other pools are detected as unhealthy.
locationStrategy Property Map: Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected.
popPools Map<List<String>>: (Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding countrypool, then regionpool mapping if it exists else to default_pools.
randomSteering Property Map: Configures pool weights.
regionPools Map<List<String>>: A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
sessionAffinity String: Specifies the type of session affinity the load balancer should use unless specified as "none". The supported types are:
sessionAffinityAttributes Property Map: Configures attributes for session affinity.
sessionAffinityTtl Number: Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per session_affinity policy are:
steeringPolicy String: Steering Policy for this load balancer.
ttl Number: Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

GetLoadBalancersResultRuleOverridesAdaptiveRouting

FailoverAcrossPools bool: Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See session_affinity_attributes for control over when sessions are broken or reassigned.

FailoverAcrossPools bool: Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See session_affinity_attributes for control over when sessions are broken or reassigned.

failoverAcrossPools Boolean: Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See session_affinity_attributes for control over when sessions are broken or reassigned.

failoverAcrossPools boolean: Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See session_affinity_attributes for control over when sessions are broken or reassigned.

failover_across_pools bool: Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See session_affinity_attributes for control over when sessions are broken or reassigned.

failoverAcrossPools Boolean: Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See session_affinity_attributes for control over when sessions are broken or reassigned.

GetLoadBalancersResultRuleOverridesLocationStrategy

Mode string: Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful.
PreferEcs string: Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location.

Mode string: Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful.
PreferEcs string: Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location.

mode String: Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful.
preferEcs String: Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location.

mode string: Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful.
preferEcs string: Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location.

mode str: Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful.
prefer_ecs str: Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location.

mode String: Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful.
preferEcs String: Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location.

GetLoadBalancersResultRuleOverridesRandomSteering

DefaultWeight double: The default weight for pools in the load balancer that are not specified in the pool_weights map.
PoolWeights Dictionary<string, double>: A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

DefaultWeight float64: The default weight for pools in the load balancer that are not specified in the pool_weights map.
PoolWeights map[string]float64: A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

defaultWeight Double: The default weight for pools in the load balancer that are not specified in the pool_weights map.
poolWeights Map<String,Double>: A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

defaultWeight number: The default weight for pools in the load balancer that are not specified in the pool_weights map.
poolWeights {[key: string]: number}: A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

default_weight float: The default weight for pools in the load balancer that are not specified in the pool_weights map.
pool_weights Mapping[str, float]: A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

defaultWeight Number: The default weight for pools in the load balancer that are not specified in the pool_weights map.
poolWeights Map<Number>: A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

GetLoadBalancersResultRuleOverridesSessionAffinityAttributes

DrainDuration double: Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.
Headers List<string>: Configures the names of HTTP headers to base session affinity on when header session_affinity is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: "cookie:<cookie-name-1>,<cookie-name-2>" (example) where everything after the colon is a comma-separated list of cookie names. Providing only "cookie" will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.
RequireAllHeaders bool: When header session_affinity is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
Samesite string: Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never". Available values: "Auto", "Lax", "None", "Strict".
Secure string: Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled. Available values: "Auto", "Always", "Never".
ZeroDowntimeFailover string: Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:

DrainDuration float64: Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.
Headers []string: Configures the names of HTTP headers to base session affinity on when header session_affinity is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: "cookie:<cookie-name-1>,<cookie-name-2>" (example) where everything after the colon is a comma-separated list of cookie names. Providing only "cookie" will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.
RequireAllHeaders bool: When header session_affinity is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
Samesite string: Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never". Available values: "Auto", "Lax", "None", "Strict".
Secure string: Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled. Available values: "Auto", "Always", "Never".
ZeroDowntimeFailover string: Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:

drainDuration Double: Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.
headers List<String>: Configures the names of HTTP headers to base session affinity on when header session_affinity is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: "cookie:<cookie-name-1>,<cookie-name-2>" (example) where everything after the colon is a comma-separated list of cookie names. Providing only "cookie" will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.
requireAllHeaders Boolean: When header session_affinity is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
samesite String: Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never". Available values: "Auto", "Lax", "None", "Strict".
secure String: Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled. Available values: "Auto", "Always", "Never".
zeroDowntimeFailover String: Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:

drainDuration number: Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.
headers string[]: Configures the names of HTTP headers to base session affinity on when header session_affinity is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: "cookie:<cookie-name-1>,<cookie-name-2>" (example) where everything after the colon is a comma-separated list of cookie names. Providing only "cookie" will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.
requireAllHeaders boolean: When header session_affinity is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
samesite string: Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never". Available values: "Auto", "Lax", "None", "Strict".
secure string: Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled. Available values: "Auto", "Always", "Never".
zeroDowntimeFailover string: Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:

drain_duration float: Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.
headers Sequence[str]: Configures the names of HTTP headers to base session affinity on when header session_affinity is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: "cookie:<cookie-name-1>,<cookie-name-2>" (example) where everything after the colon is a comma-separated list of cookie names. Providing only "cookie" will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.
require_all_headers bool: When header session_affinity is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
samesite str: Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never". Available values: "Auto", "Lax", "None", "Strict".
secure str: Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled. Available values: "Auto", "Always", "Never".
zero_downtime_failover str: Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:

drainDuration Number: Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.
headers List<String>: Configures the names of HTTP headers to base session affinity on when header session_affinity is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: "cookie:<cookie-name-1>,<cookie-name-2>" (example) where everything after the colon is a comma-separated list of cookie names. Providing only "cookie" will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.
requireAllHeaders Boolean: When header session_affinity is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
samesite String: Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never". Available values: "Auto", "Lax", "None", "Strict".
secure String: Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled. Available values: "Auto", "Always", "Never".
zeroDowntimeFailover String: Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:

GetLoadBalancersResultSessionAffinityAttributes

DrainDuration double: Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.
Headers List<string>: Configures the names of HTTP headers to base session affinity on when header session_affinity is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: "cookie:<cookie-name-1>,<cookie-name-2>" (example) where everything after the colon is a comma-separated list of cookie names. Providing only "cookie" will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.
RequireAllHeaders bool: When header session_affinity is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
Samesite string: Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never". Available values: "Auto", "Lax", "None", "Strict".
Secure string: Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled. Available values: "Auto", "Always", "Never".
ZeroDowntimeFailover string: Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:

DrainDuration float64: Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.
Headers []string: Configures the names of HTTP headers to base session affinity on when header session_affinity is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: "cookie:<cookie-name-1>,<cookie-name-2>" (example) where everything after the colon is a comma-separated list of cookie names. Providing only "cookie" will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.
RequireAllHeaders bool: When header session_affinity is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
Samesite string: Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never". Available values: "Auto", "Lax", "None", "Strict".
Secure string: Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled. Available values: "Auto", "Always", "Never".
ZeroDowntimeFailover string: Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:

drainDuration Double: Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.
headers List<String>: Configures the names of HTTP headers to base session affinity on when header session_affinity is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: "cookie:<cookie-name-1>,<cookie-name-2>" (example) where everything after the colon is a comma-separated list of cookie names. Providing only "cookie" will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.
requireAllHeaders Boolean: When header session_affinity is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
samesite String: Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never". Available values: "Auto", "Lax", "None", "Strict".
secure String: Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled. Available values: "Auto", "Always", "Never".
zeroDowntimeFailover String: Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:

drainDuration number: Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.
headers string[]: Configures the names of HTTP headers to base session affinity on when header session_affinity is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: "cookie:<cookie-name-1>,<cookie-name-2>" (example) where everything after the colon is a comma-separated list of cookie names. Providing only "cookie" will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.
requireAllHeaders boolean: When header session_affinity is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
samesite string: Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never". Available values: "Auto", "Lax", "None", "Strict".
secure string: Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled. Available values: "Auto", "Always", "Never".
zeroDowntimeFailover string: Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:

drain_duration float: Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.
headers Sequence[str]: Configures the names of HTTP headers to base session affinity on when header session_affinity is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: "cookie:<cookie-name-1>,<cookie-name-2>" (example) where everything after the colon is a comma-separated list of cookie names. Providing only "cookie" will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.
require_all_headers bool: When header session_affinity is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
samesite str: Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never". Available values: "Auto", "Lax", "None", "Strict".
secure str: Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled. Available values: "Auto", "Always", "Never".
zero_downtime_failover str: Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:

drainDuration Number: Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.
headers List<String>: Configures the names of HTTP headers to base session affinity on when header session_affinity is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: "cookie:<cookie-name-1>,<cookie-name-2>" (example) where everything after the colon is a comma-separated list of cookie names. Providing only "cookie" will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.
requireAllHeaders Boolean: When header session_affinity is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:
samesite String: Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never". Available values: "Auto", "Lax", "None", "Strict".
secure String: Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled. Available values: "Auto", "Always", "Never".
zeroDowntimeFailover String: Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:

Package Details

Repository: Cloudflare pulumi/pulumi-cloudflare
License: Apache-2.0
Notes: This Pulumi package is based on the cloudflare Terraform Provider.

Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.getLoadBalancers

On this page

On this page

Example Usage

Using getLoadBalancers

getLoadBalancers Result

Supporting Types

GetLoadBalancersResult

GetLoadBalancersResultAdaptiveRouting

GetLoadBalancersResultLocationStrategy

GetLoadBalancersResultRandomSteering

GetLoadBalancersResultRule

GetLoadBalancersResultRuleFixedResponse

GetLoadBalancersResultRuleOverrides

GetLoadBalancersResultRuleOverridesAdaptiveRouting

GetLoadBalancersResultRuleOverridesLocationStrategy

GetLoadBalancersResultRuleOverridesRandomSteering

GetLoadBalancersResultRuleOverridesSessionAffinityAttributes

GetLoadBalancersResultSessionAffinityAttributes

Package Details

On this page

On this page