GetLoadBalancerPoolsResult

data class GetLoadBalancerPoolsResult(val checkRegions: List<String>, val createdOn: String, val description: String, val disabledAt: String, val enabled: Boolean, val id: String, val latitude: Double, val loadShedding: GetLoadBalancerPoolsResultLoadShedding, val longitude: Double, val minimumOrigins: Int, val modifiedOn: String, val monitor: String, val name: String, val networks: List<String>, val notificationEmail: String, val notificationFilter: GetLoadBalancerPoolsResultNotificationFilter, val originSteering: GetLoadBalancerPoolsResultOriginSteering, val origins: List<GetLoadBalancerPoolsResultOrigin>)

Constructors

Link copied to clipboard
constructor(checkRegions: List<String>, createdOn: String, description: String, disabledAt: String, enabled: Boolean, id: String, latitude: Double, loadShedding: GetLoadBalancerPoolsResultLoadShedding, longitude: Double, minimumOrigins: Int, modifiedOn: String, monitor: String, name: String, networks: List<String>, notificationEmail: String, notificationFilter: GetLoadBalancerPoolsResultNotificationFilter, originSteering: GetLoadBalancerPoolsResultOriginSteering, origins: List<GetLoadBalancerPoolsResultOrigin>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

A list of regions from which to run health checks. Null means every Cloudflare data center.

Link copied to clipboard
Link copied to clipboard

A human-readable description of the pool.

Link copied to clipboard

This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.

Link copied to clipboard

Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).

Link copied to clipboard
val id: String
Link copied to clipboard

The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.

Link copied to clipboard

Configures load shedding policies and percentages for the pool.

Link copied to clipboard

The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.

Link copied to clipboard

The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.

Link copied to clipboard
Link copied to clipboard

The ID of the Monitor to use for checking the health of origins within this pool.

Link copied to clipboard

A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.

Link copied to clipboard

List of networks where Load Balancer or Pool is enabled.

Link copied to clipboard

This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.

Link copied to clipboard

Filter pool and origin health notifications by resource type or health status. Use null to reset.

Link copied to clipboard

The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

Link copied to clipboard

Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.