GetLoadBalancerResult

data class GetLoadBalancerResult(val adaptiveRouting: GetLoadBalancerAdaptiveRouting, val countryPools: Map<String, List<String>>, val createdOn: String, val defaultPools: List<String>, val description: String, val enabled: Boolean, val fallbackPool: String, val id: String, val loadBalancerId: String? = null, val locationStrategy: GetLoadBalancerLocationStrategy, val modifiedOn: String, val name: String, val networks: List<String>, val popPools: Map<String, List<String>>, val proxied: Boolean, val randomSteering: GetLoadBalancerRandomSteering, val regionPools: Map<String, List<String>>, val rules: List<GetLoadBalancerRule>, val sessionAffinity: String, val sessionAffinityAttributes: GetLoadBalancerSessionAffinityAttributes, val sessionAffinityTtl: Double, val steeringPolicy: String, val ttl: Double, val zoneId: String)

A collection of values returned by getLoadBalancer.

Constructors

Link copied to clipboard
constructor(adaptiveRouting: GetLoadBalancerAdaptiveRouting, countryPools: Map<String, List<String>>, createdOn: String, defaultPools: List<String>, description: String, enabled: Boolean, fallbackPool: String, id: String, loadBalancerId: String? = null, locationStrategy: GetLoadBalancerLocationStrategy, modifiedOn: String, name: String, networks: List<String>, popPools: Map<String, List<String>>, proxied: Boolean, randomSteering: GetLoadBalancerRandomSteering, regionPools: Map<String, List<String>>, rules: List<GetLoadBalancerRule>, sessionAffinity: String, sessionAffinityAttributes: GetLoadBalancerSessionAffinityAttributes, sessionAffinityTtl: Double, steeringPolicy: String, ttl: Double, zoneId: String)

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. 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.

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

Object description.

Link copied to clipboard

Whether to enable (the default) this load balancer.

Link copied to clipboard

The pool ID to use when all other pools are detected as unhealthy.

Link copied to clipboard
val id: String

The ID of this resource.

Link copied to clipboard
val loadBalancerId: String? = null
Link copied to clipboard

Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

List of networks where Load Balancer or Pool is enabled.

Link copied to clipboard

(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.

Link copied to clipboard

Whether the hostname should be gray clouded (false) or orange clouded (true).

Link copied to clipboard

Configures pool weights.

Link copied to clipboard

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.

Link copied to clipboard

BETA Field Not General Access: A list of rules for this load balancer to execute.

Link copied to clipboard

Specifies the type of session affinity the load balancer should use unless specified as "none". The supported types are:

Link copied to clipboard

Configures attributes for session affinity.

Link copied to clipboard

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:

Link copied to clipboard

Steering Policy for this load balancer.

Link copied to clipboard
val 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.

Link copied to clipboard