cloudflare.LoadBalancerPool

Coming soon!

name string

The unique name of the resource.

args LoadBalancerPoolArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

resource_name str

The unique name of the resource.

args LoadBalancerPoolArgs

The arguments to resource properties.

opts ResourceOptions

Bag of options to control resource's behavior.

ctx Context

Context object for the current deployment.

name string

The unique name of the resource.

args LoadBalancerPoolArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args LoadBalancerPoolArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args LoadBalancerPoolArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

AccountId string

The account identifier to target for the resource.

Name string

A short name (tag) for the pool.

Origins List<LoadBalancerPoolOrigin>

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.

CheckRegions List<string>

A list of regions (specified by region code) from which to run health checks. Empty means every Cloudflare data center (the default), but requires an Enterprise plan. Region codes can be found here.

Description string

Free text description.

Enabled bool

Whether to enable (the default) 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). Defaults to true.

Latitude double

The latitude this pool is physically located at; used for proximity steering.

LoadSheddings List<LoadBalancerPoolLoadShedding>

Setting for controlling load shedding for this pool.

Longitude double

The longitude this pool is physically located at; used for proximity steering.

MinimumOrigins int

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 we will failover to the next available pool. Defaults to 1.

Monitor string

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

NotificationEmail string

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.

OriginSteerings List<LoadBalancerPoolOriginSteering>

Set an origin steering policy to control origin selection within a pool.

AccountId string

The account identifier to target for the resource.

Name string

A short name (tag) for the pool.

Origins []LoadBalancerPoolOriginArgs

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.

CheckRegions []string

A list of regions (specified by region code) from which to run health checks. Empty means every Cloudflare data center (the default), but requires an Enterprise plan. Region codes can be found here.

Description string

Free text description.

Enabled bool

Whether to enable (the default) 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). Defaults to true.

Latitude float64

The latitude this pool is physically located at; used for proximity steering.

LoadSheddings []LoadBalancerPoolLoadSheddingArgs

Setting for controlling load shedding for this pool.

Longitude float64

The longitude this pool is physically located at; used for proximity steering.

MinimumOrigins int

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 we will failover to the next available pool. Defaults to 1.

Monitor string

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

NotificationEmail string

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.

OriginSteerings []LoadBalancerPoolOriginSteeringArgs

Set an origin steering policy to control origin selection within a pool.

accountId String

The account identifier to target for the resource.

name String

A short name (tag) for the pool.

origins List<LoadBalancerPoolOrigin>

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.

checkRegions List<String>

A list of regions (specified by region code) from which to run health checks. Empty means every Cloudflare data center (the default), but requires an Enterprise plan. Region codes can be found here.

description String

Free text description.

enabled Boolean

Whether to enable (the default) 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). Defaults to true.

latitude Double

The latitude this pool is physically located at; used for proximity steering.

loadSheddings List<LoadBalancerPoolLoadShedding>

Setting for controlling load shedding for this pool.

longitude Double

The longitude this pool is physically located at; used for proximity steering.

minimumOrigins Integer

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 we will failover to the next available pool. Defaults to 1.

monitor String

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

notificationEmail String

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.

originSteerings List<LoadBalancerPoolOriginSteering>

Set an origin steering policy to control origin selection within a pool.

accountId string

The account identifier to target for the resource.

name string

A short name (tag) for the pool.

origins LoadBalancerPoolOrigin[]

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.

checkRegions string[]

A list of regions (specified by region code) from which to run health checks. Empty means every Cloudflare data center (the default), but requires an Enterprise plan. Region codes can be found here.

description string

Free text description.

enabled boolean

Whether to enable (the default) 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). Defaults to true.

latitude number

The latitude this pool is physically located at; used for proximity steering.

loadSheddings LoadBalancerPoolLoadShedding[]

Setting for controlling load shedding for this pool.

longitude number

The longitude this pool is physically located at; used for proximity steering.

minimumOrigins number

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 we will failover to the next available pool. Defaults to 1.

monitor string

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

notificationEmail string

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.

originSteerings LoadBalancerPoolOriginSteering[]

Set an origin steering policy to control origin selection within a pool.

account_id str

The account identifier to target for the resource.

name str

A short name (tag) for the pool.

origins Sequence[LoadBalancerPoolOriginArgs]

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.

check_regions Sequence[str]

A list of regions (specified by region code) from which to run health checks. Empty means every Cloudflare data center (the default), but requires an Enterprise plan. Region codes can be found here.

description str

Free text description.

enabled bool

Whether to enable (the default) 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). Defaults to true.

latitude float

The latitude this pool is physically located at; used for proximity steering.

load_sheddings Sequence[LoadBalancerPoolLoadSheddingArgs]

Setting for controlling load shedding for this pool.

longitude float

The longitude this pool is physically located at; used for proximity steering.

minimum_origins int

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 we will failover to the next available pool. Defaults to 1.

monitor str

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

notification_email str

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.

origin_steerings Sequence[LoadBalancerPoolOriginSteeringArgs]

Set an origin steering policy to control origin selection within a pool.

accountId String

The account identifier to target for the resource.

name String

A short name (tag) for the pool.

origins List<Property Map>

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.

checkRegions List<String>

A list of regions (specified by region code) from which to run health checks. Empty means every Cloudflare data center (the default), but requires an Enterprise plan. Region codes can be found here.

description String

Free text description.

enabled Boolean

Whether to enable (the default) 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). Defaults to true.

latitude Number

The latitude this pool is physically located at; used for proximity steering.

loadSheddings List<Property Map>

Setting for controlling load shedding for this pool.

longitude Number

The longitude this pool is physically located at; used for proximity steering.

minimumOrigins Number

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 we will failover to the next available pool. Defaults to 1.

monitor String

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

notificationEmail String

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.

originSteerings List<Property Map>

Set an origin steering policy to control origin selection within a pool.

CreatedOn string

The RFC3339 timestamp of when the load balancer was created.

Id string

The provider-assigned unique ID for this managed resource.

ModifiedOn string

The RFC3339 timestamp of when the load balancer was last modified.

CreatedOn string

The RFC3339 timestamp of when the load balancer was created.

Id string

The provider-assigned unique ID for this managed resource.

ModifiedOn string

The RFC3339 timestamp of when the load balancer was last modified.

createdOn String

The RFC3339 timestamp of when the load balancer was created.

id String

The provider-assigned unique ID for this managed resource.

modifiedOn String

The RFC3339 timestamp of when the load balancer was last modified.

createdOn string

The RFC3339 timestamp of when the load balancer was created.

id string

The provider-assigned unique ID for this managed resource.

modifiedOn string

The RFC3339 timestamp of when the load balancer was last modified.

created_on str

The RFC3339 timestamp of when the load balancer was created.

id str

The provider-assigned unique ID for this managed resource.

modified_on str

The RFC3339 timestamp of when the load balancer was last modified.

createdOn String

The RFC3339 timestamp of when the load balancer was created.

id String

The provider-assigned unique ID for this managed resource.

modifiedOn String

The RFC3339 timestamp of when the load balancer was last modified.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

resource_name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

DefaultPercent double

Percent of traffic to shed 0 - 100. Defaults to 0.

DefaultPolicy string

Method of shedding traffic. Available values: "", hash, random. Defaults to "".

SessionPercent double

Percent of session traffic to shed 0 - 100. Defaults to 0.

SessionPolicy string

Method of shedding traffic. Available values: "", hash. Defaults to "".

DefaultPercent float64

Percent of traffic to shed 0 - 100. Defaults to 0.

DefaultPolicy string

Method of shedding traffic. Available values: "", hash, random. Defaults to "".

SessionPercent float64

Percent of session traffic to shed 0 - 100. Defaults to 0.

SessionPolicy string

Method of shedding traffic. Available values: "", hash. Defaults to "".

defaultPercent Double

Percent of traffic to shed 0 - 100. Defaults to 0.

defaultPolicy String

Method of shedding traffic. Available values: "", hash, random. Defaults to "".

sessionPercent Double

Percent of session traffic to shed 0 - 100. Defaults to 0.

sessionPolicy String

Method of shedding traffic. Available values: "", hash. Defaults to "".

defaultPercent number

Percent of traffic to shed 0 - 100. Defaults to 0.

defaultPolicy string

Method of shedding traffic. Available values: "", hash, random. Defaults to "".

sessionPercent number

Percent of session traffic to shed 0 - 100. Defaults to 0.

sessionPolicy string

Method of shedding traffic. Available values: "", hash. Defaults to "".

default_percent float

Percent of traffic to shed 0 - 100. Defaults to 0.

default_policy str

Method of shedding traffic. Available values: "", hash, random. Defaults to "".

session_percent float

Percent of session traffic to shed 0 - 100. Defaults to 0.

session_policy str

Method of shedding traffic. Available values: "", hash. Defaults to "".

defaultPercent Number

Percent of traffic to shed 0 - 100. Defaults to 0.

defaultPolicy String

Method of shedding traffic. Available values: "", hash, random. Defaults to "".

sessionPercent Number

Percent of session traffic to shed 0 - 100. Defaults to 0.

sessionPolicy String

Method of shedding traffic. Available values: "", hash. Defaults to "".

Address string

The IP address (IPv4 or IPv6) of the origin, or the publicly addressable hostname.

Name string

A human-identifiable name for the origin.

Enabled bool

Whether this origin is enabled. Disabled origins will not receive traffic and are excluded from health checks. Defaults to true.

Headers List<LoadBalancerPoolOriginHeader>

HTTP request headers.

VirtualNetworkId string

The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.

Weight double

The weight (0.01 - 1.00) of this origin, relative to other origins in the pool. Equal values mean equal weighting. A weight of 0 means traffic will not be sent to this origin, but health is still checked. When origin_steering.policy="least_outstanding_requests", weight is used to scale the origin's outstanding requests. When origin_steering.policy="least_connections", weight is used to scale the origin's open connections. Defaults to 1.

Address string

The IP address (IPv4 or IPv6) of the origin, or the publicly addressable hostname.

Name string

A human-identifiable name for the origin.

Enabled bool

Whether this origin is enabled. Disabled origins will not receive traffic and are excluded from health checks. Defaults to true.

Headers []LoadBalancerPoolOriginHeader

HTTP request headers.

VirtualNetworkId string

The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.

Weight float64

The weight (0.01 - 1.00) of this origin, relative to other origins in the pool. Equal values mean equal weighting. A weight of 0 means traffic will not be sent to this origin, but health is still checked. When origin_steering.policy="least_outstanding_requests", weight is used to scale the origin's outstanding requests. When origin_steering.policy="least_connections", weight is used to scale the origin's open connections. Defaults to 1.

address String

The IP address (IPv4 or IPv6) of the origin, or the publicly addressable hostname.

name String

A human-identifiable name for the origin.

enabled Boolean

Whether this origin is enabled. Disabled origins will not receive traffic and are excluded from health checks. Defaults to true.

headers List<LoadBalancerPoolOriginHeader>

HTTP request headers.

virtualNetworkId String

The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.

weight Double

The weight (0.01 - 1.00) of this origin, relative to other origins in the pool. Equal values mean equal weighting. A weight of 0 means traffic will not be sent to this origin, but health is still checked. When origin_steering.policy="least_outstanding_requests", weight is used to scale the origin's outstanding requests. When origin_steering.policy="least_connections", weight is used to scale the origin's open connections. Defaults to 1.

address string

The IP address (IPv4 or IPv6) of the origin, or the publicly addressable hostname.

name string

A human-identifiable name for the origin.

enabled boolean

Whether this origin is enabled. Disabled origins will not receive traffic and are excluded from health checks. Defaults to true.

headers LoadBalancerPoolOriginHeader[]

HTTP request headers.

virtualNetworkId string

The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.

weight number

The weight (0.01 - 1.00) of this origin, relative to other origins in the pool. Equal values mean equal weighting. A weight of 0 means traffic will not be sent to this origin, but health is still checked. When origin_steering.policy="least_outstanding_requests", weight is used to scale the origin's outstanding requests. When origin_steering.policy="least_connections", weight is used to scale the origin's open connections. Defaults to 1.

address str

The IP address (IPv4 or IPv6) of the origin, or the publicly addressable hostname.

name str

A human-identifiable name for the origin.

enabled bool

Whether this origin is enabled. Disabled origins will not receive traffic and are excluded from health checks. Defaults to true.

headers Sequence[LoadBalancerPoolOriginHeader]

HTTP request headers.

virtual_network_id str

The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.

weight float

The weight (0.01 - 1.00) of this origin, relative to other origins in the pool. Equal values mean equal weighting. A weight of 0 means traffic will not be sent to this origin, but health is still checked. When origin_steering.policy="least_outstanding_requests", weight is used to scale the origin's outstanding requests. When origin_steering.policy="least_connections", weight is used to scale the origin's open connections. Defaults to 1.

address String

The IP address (IPv4 or IPv6) of the origin, or the publicly addressable hostname.

name String

A human-identifiable name for the origin.

enabled Boolean

Whether this origin is enabled. Disabled origins will not receive traffic and are excluded from health checks. Defaults to true.

headers List<Property Map>

HTTP request headers.

virtualNetworkId String

The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.

weight Number

The weight (0.01 - 1.00) of this origin, relative to other origins in the pool. Equal values mean equal weighting. A weight of 0 means traffic will not be sent to this origin, but health is still checked. When origin_steering.policy="least_outstanding_requests", weight is used to scale the origin's outstanding requests. When origin_steering.policy="least_connections", weight is used to scale the origin's open connections. Defaults to 1.

Header string

HTTP Header name.

Values List<string>

Values for the HTTP headers.

Header string

HTTP Header name.

Values []string

Values for the HTTP headers.

header String

HTTP Header name.

values List<String>

Values for the HTTP headers.

header string

HTTP Header name.

values string[]

Values for the HTTP headers.

header str

HTTP Header name.

values Sequence[str]

Values for the HTTP headers.

header String

HTTP Header name.

values List<String>

Values for the HTTP headers.

Policy string

Origin steering policy to be used. Value random selects an origin randomly. Value hash selects an origin by computing a hash over the CF-Connecting-IP address. Value least_outstanding_requests selects an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others. Value least_connections selects an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections. Available values: "", hash, random, least_outstanding_requests, least_connections. Defaults to random.

Policy string

Origin steering policy to be used. Value random selects an origin randomly. Value hash selects an origin by computing a hash over the CF-Connecting-IP address. Value least_outstanding_requests selects an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others. Value least_connections selects an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections. Available values: "", hash, random, least_outstanding_requests, least_connections. Defaults to random.

policy String

Origin steering policy to be used. Value random selects an origin randomly. Value hash selects an origin by computing a hash over the CF-Connecting-IP address. Value least_outstanding_requests selects an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others. Value least_connections selects an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections. Available values: "", hash, random, least_outstanding_requests, least_connections. Defaults to random.

policy string

Origin steering policy to be used. Value random selects an origin randomly. Value hash selects an origin by computing a hash over the CF-Connecting-IP address. Value least_outstanding_requests selects an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others. Value least_connections selects an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections. Available values: "", hash, random, least_outstanding_requests, least_connections. Defaults to random.

policy str

Origin steering policy to be used. Value random selects an origin randomly. Value hash selects an origin by computing a hash over the CF-Connecting-IP address. Value least_outstanding_requests selects an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others. Value least_connections selects an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections. Available values: "", hash, random, least_outstanding_requests, least_connections. Defaults to random.

policy String

Origin steering policy to be used. Value random selects an origin randomly. Value hash selects an origin by computing a hash over the CF-Connecting-IP address. Value least_outstanding_requests selects an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others. Value least_connections selects an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections. Available values: "", hash, random, least_outstanding_requests, least_connections. Defaults to random.