pulumi-cloudflare-kotlin/com.pulumi.cloudflare.kotlin/LoadBalancerPoolArgs

LoadBalancerPoolArgs

data class LoadBalancerPoolArgs(val accountId: Output<String>? = null, val checkRegions: Output<List<String>>? = null, val description: Output<String>? = null, val enabled: Output<Boolean>? = null, val latitude: Output<Double>? = null, val loadShedding: Output<LoadBalancerPoolLoadSheddingArgs>? = null, val longitude: Output<Double>? = null, val minimumOrigins: Output<Int>? = null, val monitor: Output<String>? = null, val name: Output<String>? = null, val notificationEmail: Output<String>? = null, val notificationFilter: Output<LoadBalancerPoolNotificationFilterArgs>? = null, val originSteering: Output<LoadBalancerPoolOriginSteeringArgs>? = null, val origins: Output<List<LoadBalancerPoolOriginArgs>>? = null) : ConvertibleToJava<LoadBalancerPoolArgs>

Example Usage

resources:
  exampleLoadBalancerPool:
    type: cloudflare:LoadBalancerPool
    name: example_load_balancer_pool
    properties:
      accountId: 023e105f4ecef8ad9ca31a8372d0c353
      name: primary-dc-1
      origins:
        - address: 0.0.0.0
          enabled: true
          header:
            host:
              - example.com
          name: app-server-1
          port: 0
          virtual_network_id: a5624d4e-044a-4ff0-b3e1-e2465353d4b4
          weight: 0.6
      description: Primary data center - Provider XYZ
      enabled: false
      latitude: 0
      loadShedding:
        default_percent: 0
        default_policy: random
        session_percent: 0
        session_policy: hash
      longitude: 0
      minimumOrigins: 0
      monitor: monitor
      notificationEmail: someone@example.com,sometwo@example.com
      notificationFilter:
        origin:
          disable: true
          healthy: true
        pool:
          disable: true
          healthy: false
      originSteering:
        policy: random

Import

$ pulumi import cloudflare:index/loadBalancerPool:LoadBalancerPool example '<account_id>/<pool_id>'

Constructors

LoadBalancerPoolArgs

constructor(accountId: Output<String>? = null, checkRegions: Output<List<String>>? = null, description: Output<String>? = null, enabled: Output<Boolean>? = null, latitude: Output<Double>? = null, loadShedding: Output<LoadBalancerPoolLoadSheddingArgs>? = null, longitude: Output<Double>? = null, minimumOrigins: Output<Int>? = null, monitor: Output<String>? = null, name: Output<String>? = null, notificationEmail: Output<String>? = null, notificationFilter: Output<LoadBalancerPoolNotificationFilterArgs>? = null, originSteering: Output<LoadBalancerPoolOriginSteeringArgs>? = null, origins: Output<List<LoadBalancerPoolOriginArgs>>? = null)

Properties

accountId

val accountId: Output<String>? = null

Identifier

checkRegions

val checkRegions: Output<List<String>>? = null

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

description

val description: Output<String>? = null

A human-readable description of the pool.

enabled

val enabled: Output<Boolean>? = null

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

latitude

val latitude: Output<Double>? = null

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.

loadShedding

val loadShedding: Output<LoadBalancerPoolLoadSheddingArgs>? = null

Configures load shedding policies and percentages for the pool.

longitude

val longitude: Output<Double>? = null

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.

minimumOrigins

val minimumOrigins: Output<Int>? = null

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.

monitor

val monitor: Output<String>? = null

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

name

val name: Output<String>? = null

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

notificationEmail

val notificationEmail: Output<String>? = null

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.

notificationFilter

val notificationFilter: Output<LoadBalancerPoolNotificationFilterArgs>? = null

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

origins

val origins: Output<List<LoadBalancerPoolOriginArgs>>? = null

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.

originSteering

val originSteering: Output<LoadBalancerPoolOriginSteeringArgs>? = null

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

Functions

toJava

open override fun toJava(): LoadBalancerPoolArgs