LoadBalancerRuleOverride

data class LoadBalancerRuleOverride(val adaptiveRoutings: List<LoadBalancerRuleOverrideAdaptiveRouting>? = null, val countryPools: List<LoadBalancerRuleOverrideCountryPool>? = null, val defaultPools: List<String>? = null, val fallbackPool: String? = null, val locationStrategies: List<LoadBalancerRuleOverrideLocationStrategy>? = null, val popPools: List<LoadBalancerRuleOverridePopPool>? = null, val randomSteerings: List<LoadBalancerRuleOverrideRandomSteering>? = null, val regionPools: List<LoadBalancerRuleOverrideRegionPool>? = null, val sessionAffinity: String? = null, val sessionAffinityAttributes: Map<String, String>? = null, val sessionAffinityTtl: Int? = null, val steeringPolicy: String? = null, val ttl: Int? = null)

Constructors

Link copied to clipboard
constructor(adaptiveRoutings: List<LoadBalancerRuleOverrideAdaptiveRouting>? = null, countryPools: List<LoadBalancerRuleOverrideCountryPool>? = null, defaultPools: List<String>? = null, fallbackPool: String? = null, locationStrategies: List<LoadBalancerRuleOverrideLocationStrategy>? = null, popPools: List<LoadBalancerRuleOverridePopPool>? = null, randomSteerings: List<LoadBalancerRuleOverrideRandomSteering>? = null, regionPools: List<LoadBalancerRuleOverrideRegionPool>? = null, sessionAffinity: String? = null, sessionAffinityAttributes: Map<String, String>? = null, sessionAffinityTtl: Int? = null, steeringPolicy: String? = null, ttl: Int? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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.

Link copied to clipboard

A set containing mappings of country codes to a list of pool IDs (ordered by their failover priority) for the given country.

Link copied to clipboard
val defaultPools: List<String>? = null
Link copied to clipboard
val fallbackPool: String? = null
Link copied to clipboard

Controls location-based steering for non-proxied requests.

Link copied to clipboard

A set containing mappings of Cloudflare Point-of-Presence (PoP) identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). This feature is only available to enterprise customers.

Link copied to clipboard

Configures pool weights for random steering. When the steering_policy="random", a random pool is selected with probability proportional to these pool weights.

Link copied to clipboard

A set containing mappings of region codes to a list of pool IDs (ordered by their failover priority) for the given region.

Link copied to clipboard
val sessionAffinity: String? = null

Specifies the type of session affinity the load balancer should use unless specified as none or "" (default). With value cookie, on the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy then a new origin server is calculated and used. Value ip_cookie behaves the same as cookie except the initial origin selection is stable and based on the client's IP address. Available values: "", none, cookie, ip_cookie. Defaults to none.

Link copied to clipboard

See session_affinity_attributes.

Link copied to clipboard
val sessionAffinityTtl: Int? = null

Time, in seconds, until this load balancer's session affinity cookie expires after being created. This parameter is ignored unless a supported session affinity policy is set. The current default of 82800 (23 hours) will be used unless session_affinity_ttl is explicitly set. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. Valid values are between 1800 and 604800.

Link copied to clipboard
val steeringPolicy: String? = null

The method the load balancer uses to determine the route to your origin. Value off uses default_pool_ids. Value geo uses pop_pools/country_pools/region_pools. For non-proxied requests, the country for country_pools is determined by location_strategy. Value random selects a pool randomly. Value dynamic_latency uses round trip time to select the closest pool in default_pool_ids (requires pool health checks). Value proximity uses the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by location_strategy for non-proxied requests. Value "" maps to geo if you use pop_pools/country_pools/region_pools otherwise off. Available values: off, geo, dynamic_latency, random, proximity, "" Defaults to "".

Link copied to clipboard
val ttl: Int? = null

Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This cannot be set for proxied load balancers. Defaults to 30. Conflicts with proxied.