cloudflare.LoadBalancerPool
Provides a Cloudflare Load Balancer pool resource. This provides a pool of origins that can be used by a Cloudflare Load Balancer.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;
return await Deployment.RunAsync(() =>
{
var example = new Cloudflare.LoadBalancerPool("example", new()
{
AccountId = "f037e56e89293a057740de681ac9abbe",
Description = "example load balancer pool",
Enabled = false,
Latitude = 55,
LoadSheddings = new[]
{
new Cloudflare.Inputs.LoadBalancerPoolLoadSheddingArgs
{
DefaultPercent = 55,
DefaultPolicy = "random",
SessionPercent = 12,
SessionPolicy = "hash",
},
},
Longitude = -12,
MinimumOrigins = 1,
Name = "example-pool",
NotificationEmail = "someone@example.com",
OriginSteerings = new[]
{
new Cloudflare.Inputs.LoadBalancerPoolOriginSteeringArgs
{
Policy = "random",
},
},
Origins = new[]
{
new Cloudflare.Inputs.LoadBalancerPoolOriginArgs
{
Address = "192.0.2.1",
Enabled = false,
Headers = new[]
{
new Cloudflare.Inputs.LoadBalancerPoolOriginHeaderArgs
{
Header = "Host",
Values = new[]
{
"example-1",
},
},
},
Name = "example-1",
},
new Cloudflare.Inputs.LoadBalancerPoolOriginArgs
{
Address = "192.0.2.2",
Headers = new[]
{
new Cloudflare.Inputs.LoadBalancerPoolOriginHeaderArgs
{
Header = "Host",
Values = new[]
{
"example-2",
},
},
},
Name = "example-2",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudflare.NewLoadBalancerPool(ctx, "example", &cloudflare.LoadBalancerPoolArgs{
AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
Description: pulumi.String("example load balancer pool"),
Enabled: pulumi.Bool(false),
Latitude: pulumi.Float64(55),
LoadSheddings: cloudflare.LoadBalancerPoolLoadSheddingArray{
&cloudflare.LoadBalancerPoolLoadSheddingArgs{
DefaultPercent: pulumi.Float64(55),
DefaultPolicy: pulumi.String("random"),
SessionPercent: pulumi.Float64(12),
SessionPolicy: pulumi.String("hash"),
},
},
Longitude: -12,
MinimumOrigins: pulumi.Int(1),
Name: pulumi.String("example-pool"),
NotificationEmail: pulumi.String("someone@example.com"),
OriginSteerings: cloudflare.LoadBalancerPoolOriginSteeringArray{
&cloudflare.LoadBalancerPoolOriginSteeringArgs{
Policy: pulumi.String("random"),
},
},
Origins: cloudflare.LoadBalancerPoolOriginArray{
&cloudflare.LoadBalancerPoolOriginArgs{
Address: pulumi.String("192.0.2.1"),
Enabled: pulumi.Bool(false),
Headers: cloudflare.LoadBalancerPoolOriginHeaderArray{
&cloudflare.LoadBalancerPoolOriginHeaderArgs{
Header: pulumi.String("Host"),
Values: pulumi.StringArray{
pulumi.String("example-1"),
},
},
},
Name: pulumi.String("example-1"),
},
&cloudflare.LoadBalancerPoolOriginArgs{
Address: pulumi.String("192.0.2.2"),
Headers: cloudflare.LoadBalancerPoolOriginHeaderArray{
&cloudflare.LoadBalancerPoolOriginHeaderArgs{
Header: pulumi.String("Host"),
Values: pulumi.StringArray{
pulumi.String("example-2"),
},
},
},
Name: pulumi.String("example-2"),
},
},
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_cloudflare as cloudflare
example = cloudflare.LoadBalancerPool("example",
account_id="f037e56e89293a057740de681ac9abbe",
description="example load balancer pool",
enabled=False,
latitude=55,
load_sheddings=[cloudflare.LoadBalancerPoolLoadSheddingArgs(
default_percent=55,
default_policy="random",
session_percent=12,
session_policy="hash",
)],
longitude=-12,
minimum_origins=1,
name="example-pool",
notification_email="someone@example.com",
origin_steerings=[cloudflare.LoadBalancerPoolOriginSteeringArgs(
policy="random",
)],
origins=[
cloudflare.LoadBalancerPoolOriginArgs(
address="192.0.2.1",
enabled=False,
headers=[cloudflare.LoadBalancerPoolOriginHeaderArgs(
header="Host",
values=["example-1"],
)],
name="example-1",
),
cloudflare.LoadBalancerPoolOriginArgs(
address="192.0.2.2",
headers=[cloudflare.LoadBalancerPoolOriginHeaderArgs(
header="Host",
values=["example-2"],
)],
name="example-2",
),
])
import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
const example = new cloudflare.LoadBalancerPool("example", {
accountId: "f037e56e89293a057740de681ac9abbe",
description: "example load balancer pool",
enabled: false,
latitude: 55,
loadSheddings: [{
defaultPercent: 55,
defaultPolicy: "random",
sessionPercent: 12,
sessionPolicy: "hash",
}],
longitude: -12,
minimumOrigins: 1,
name: "example-pool",
notificationEmail: "someone@example.com",
originSteerings: [{
policy: "random",
}],
origins: [
{
address: "192.0.2.1",
enabled: false,
headers: [{
header: "Host",
values: ["example-1"],
}],
name: "example-1",
},
{
address: "192.0.2.2",
headers: [{
header: "Host",
values: ["example-2"],
}],
name: "example-2",
},
],
});
Coming soon!
Create LoadBalancerPool Resource
new LoadBalancerPool(name: string, args: LoadBalancerPoolArgs, opts?: CustomResourceOptions);@overload
def LoadBalancerPool(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
check_regions: Optional[Sequence[str]] = None,
description: Optional[str] = None,
enabled: Optional[bool] = None,
latitude: Optional[float] = None,
load_sheddings: Optional[Sequence[LoadBalancerPoolLoadSheddingArgs]] = None,
longitude: Optional[float] = None,
minimum_origins: Optional[int] = None,
monitor: Optional[str] = None,
name: Optional[str] = None,
notification_email: Optional[str] = None,
origin_steerings: Optional[Sequence[LoadBalancerPoolOriginSteeringArgs]] = None,
origins: Optional[Sequence[LoadBalancerPoolOriginArgs]] = None)
@overload
def LoadBalancerPool(resource_name: str,
args: LoadBalancerPoolArgs,
opts: Optional[ResourceOptions] = None)func NewLoadBalancerPool(ctx *Context, name string, args LoadBalancerPoolArgs, opts ...ResourceOption) (*LoadBalancerPool, error)public LoadBalancerPool(string name, LoadBalancerPoolArgs args, CustomResourceOptions? opts = null)
public LoadBalancerPool(String name, LoadBalancerPoolArgs args)
public LoadBalancerPool(String name, LoadBalancerPoolArgs args, CustomResourceOptions options)
type: cloudflare:LoadBalancerPool
properties: # The arguments to resource properties.
options: # 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.
- 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.
LoadBalancerPool Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The LoadBalancerPool resource accepts the following input properties:
- Account
Id string The account identifier to target for the resource.
- Name string
A short name (tag) for the pool.
- Origins
List<Load
Balancer Pool Origin Args> 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 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.
- Load
Sheddings List<LoadBalancer Pool Load Shedding Args> Setting for controlling load shedding for this pool.
- Longitude double
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 string
The ID of the Monitor to use for health checking origins within this pool.
- Notification
Email 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.
- Origin
Steerings List<LoadBalancer Pool Origin Steering Args> Set an origin steering policy to control origin selection within a pool.
- Account
Id string The account identifier to target for the resource.
- Name string
A short name (tag) for the pool.
- Origins
[]Load
Balancer Pool Origin Args 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 []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.
- Load
Sheddings []LoadBalancer Pool Load Shedding Args Setting for controlling load shedding for this pool.
- Longitude float64
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 string
The ID of the Monitor to use for health checking origins within this pool.
- Notification
Email 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.
- Origin
Steerings []LoadBalancer Pool Origin Steering Args Set an origin steering policy to control origin selection within a pool.
- account
Id String The account identifier to target for the resource.
- name String
A short name (tag) for the pool.
- origins
List<Load
Balancer Pool Origin Args> 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 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.
- load
Sheddings List<LoadBalancer Pool Load Shedding Args> Setting for controlling load shedding for this pool.
- longitude Double
The longitude this pool is physically located at; used for proximity steering.
- minimum
Origins 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.
- notification
Email 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.
- origin
Steerings List<LoadBalancer Pool Origin Steering Args> Set an origin steering policy to control origin selection within a pool.
- account
Id string The account identifier to target for the resource.
- name string
A short name (tag) for the pool.
- origins
Load
Balancer Pool Origin Args[] 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 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.
- load
Sheddings LoadBalancer Pool Load Shedding Args[] Setting for controlling load shedding for this pool.
- longitude number
The longitude this pool is physically located at; used for proximity steering.
- minimum
Origins 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.
- notification
Email 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.
- origin
Steerings LoadBalancer Pool Origin Steering Args[] 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[Load
Balancer Pool Origin Args] 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[LoadBalancer Pool Load Shedding Args] 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[LoadBalancer Pool Origin Steering Args] Set an origin steering policy to control origin selection within a pool.
- account
Id 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.
- check
Regions 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.
- load
Sheddings 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.
- minimum
Origins 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.
- notification
Email 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.
- origin
Steerings List<Property Map> Set an origin steering policy to control origin selection within a pool.
Outputs
All input properties are implicitly available as output properties. Additionally, the LoadBalancerPool resource produces the following output properties:
- Created
On string The RFC3339 timestamp of when the load balancer was created.
- Id string
The provider-assigned unique ID for this managed resource.
- Modified
On string The RFC3339 timestamp of when the load balancer was last modified.
- Created
On string The RFC3339 timestamp of when the load balancer was created.
- Id string
The provider-assigned unique ID for this managed resource.
- Modified
On string The RFC3339 timestamp of when the load balancer was last modified.
- created
On String The RFC3339 timestamp of when the load balancer was created.
- id String
The provider-assigned unique ID for this managed resource.
- modified
On String The RFC3339 timestamp of when the load balancer was last modified.
- created
On string The RFC3339 timestamp of when the load balancer was created.
- id string
The provider-assigned unique ID for this managed resource.
- modified
On 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.
- created
On String The RFC3339 timestamp of when the load balancer was created.
- id String
The provider-assigned unique ID for this managed resource.
- modified
On String The RFC3339 timestamp of when the load balancer was last modified.
Look up Existing LoadBalancerPool Resource
Get an existing LoadBalancerPool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: LoadBalancerPoolState, opts?: CustomResourceOptions): LoadBalancerPool@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
check_regions: Optional[Sequence[str]] = None,
created_on: Optional[str] = None,
description: Optional[str] = None,
enabled: Optional[bool] = None,
latitude: Optional[float] = None,
load_sheddings: Optional[Sequence[LoadBalancerPoolLoadSheddingArgs]] = None,
longitude: Optional[float] = None,
minimum_origins: Optional[int] = None,
modified_on: Optional[str] = None,
monitor: Optional[str] = None,
name: Optional[str] = None,
notification_email: Optional[str] = None,
origin_steerings: Optional[Sequence[LoadBalancerPoolOriginSteeringArgs]] = None,
origins: Optional[Sequence[LoadBalancerPoolOriginArgs]] = None) -> LoadBalancerPoolfunc GetLoadBalancerPool(ctx *Context, name string, id IDInput, state *LoadBalancerPoolState, opts ...ResourceOption) (*LoadBalancerPool, error)public static LoadBalancerPool Get(string name, Input<string> id, LoadBalancerPoolState? state, CustomResourceOptions? opts = null)public static LoadBalancerPool get(String name, Output<String> id, LoadBalancerPoolState state, CustomResourceOptions options)Resource lookup is not supported in YAML- 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.
- Account
Id string The account identifier to target for the resource.
- Check
Regions 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.
- Created
On string The RFC3339 timestamp of when the load balancer was created.
- 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.
- Load
Sheddings List<LoadBalancer Pool Load Shedding Args> Setting for controlling load shedding for this pool.
- Longitude double
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.- Modified
On string The RFC3339 timestamp of when the load balancer was last modified.
- Monitor string
The ID of the Monitor to use for health checking origins within this pool.
- Name string
A short name (tag) for the pool.
- Notification
Email 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.
- Origin
Steerings List<LoadBalancer Pool Origin Steering Args> Set an origin steering policy to control origin selection within a pool.
- Origins
List<Load
Balancer Pool Origin Args> 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.
- Account
Id string The account identifier to target for the resource.
- Check
Regions []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.
- Created
On string The RFC3339 timestamp of when the load balancer was created.
- 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.
- Load
Sheddings []LoadBalancer Pool Load Shedding Args Setting for controlling load shedding for this pool.
- Longitude float64
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.- Modified
On string The RFC3339 timestamp of when the load balancer was last modified.
- Monitor string
The ID of the Monitor to use for health checking origins within this pool.
- Name string
A short name (tag) for the pool.
- Notification
Email 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.
- Origin
Steerings []LoadBalancer Pool Origin Steering Args Set an origin steering policy to control origin selection within a pool.
- Origins
[]Load
Balancer Pool Origin Args 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.
- account
Id String The account identifier to target for the resource.
- check
Regions 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.
- created
On String The RFC3339 timestamp of when the load balancer was created.
- 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.
- load
Sheddings List<LoadBalancer Pool Load Shedding Args> Setting for controlling load shedding for this pool.
- longitude Double
The longitude this pool is physically located at; used for proximity steering.
- minimum
Origins 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.- modified
On String The RFC3339 timestamp of when the load balancer was last modified.
- monitor String
The ID of the Monitor to use for health checking origins within this pool.
- name String
A short name (tag) for the pool.
- notification
Email 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.
- origin
Steerings List<LoadBalancer Pool Origin Steering Args> Set an origin steering policy to control origin selection within a pool.
- origins
List<Load
Balancer Pool Origin Args> 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.
- account
Id string The account identifier to target for the resource.
- check
Regions 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.
- created
On string The RFC3339 timestamp of when the load balancer was created.
- 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.
- load
Sheddings LoadBalancer Pool Load Shedding Args[] Setting for controlling load shedding for this pool.
- longitude number
The longitude this pool is physically located at; used for proximity steering.
- minimum
Origins 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.- modified
On string The RFC3339 timestamp of when the load balancer was last modified.
- monitor string
The ID of the Monitor to use for health checking origins within this pool.
- name string
A short name (tag) for the pool.
- notification
Email 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.
- origin
Steerings LoadBalancer Pool Origin Steering Args[] Set an origin steering policy to control origin selection within a pool.
- origins
Load
Balancer Pool Origin Args[] 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.
- account_
id str The account identifier to target for the resource.
- 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.
- created_
on str The RFC3339 timestamp of when the load balancer was created.
- 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[LoadBalancer Pool Load Shedding Args] 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.- modified_
on str The RFC3339 timestamp of when the load balancer was last modified.
- monitor str
The ID of the Monitor to use for health checking origins within this pool.
- name str
A short name (tag) for the 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[LoadBalancer Pool Origin Steering Args] Set an origin steering policy to control origin selection within a pool.
- origins
Sequence[Load
Balancer Pool Origin Args] 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.
- account
Id String The account identifier to target for the resource.
- check
Regions 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.
- created
On String The RFC3339 timestamp of when the load balancer was created.
- 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.
- load
Sheddings 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.
- minimum
Origins 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.- modified
On String The RFC3339 timestamp of when the load balancer was last modified.
- monitor String
The ID of the Monitor to use for health checking origins within this pool.
- name String
A short name (tag) for the pool.
- notification
Email 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.
- origin
Steerings List<Property Map> Set an origin steering policy to control origin selection within a 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.
Supporting Types
LoadBalancerPoolLoadShedding
- Default
Percent double Percent of traffic to shed 0 - 100. Defaults to
0.- Default
Policy string Method of shedding traffic. Available values: ``,
hash,random. Defaults to"".- Session
Percent double Percent of session traffic to shed 0 - 100. Defaults to
0.- Session
Policy string Method of shedding traffic. Available values: ``,
hash. Defaults to"".
- Default
Percent float64 Percent of traffic to shed 0 - 100. Defaults to
0.- Default
Policy string Method of shedding traffic. Available values: ``,
hash,random. Defaults to"".- Session
Percent float64 Percent of session traffic to shed 0 - 100. Defaults to
0.- Session
Policy string Method of shedding traffic. Available values: ``,
hash. Defaults to"".
- default
Percent Double Percent of traffic to shed 0 - 100. Defaults to
0.- default
Policy String Method of shedding traffic. Available values: ``,
hash,random. Defaults to"".- session
Percent Double Percent of session traffic to shed 0 - 100. Defaults to
0.- session
Policy String Method of shedding traffic. Available values: ``,
hash. Defaults to"".
- default
Percent number Percent of traffic to shed 0 - 100. Defaults to
0.- default
Policy string Method of shedding traffic. Available values: ``,
hash,random. Defaults to"".- session
Percent number Percent of session traffic to shed 0 - 100. Defaults to
0.- session
Policy 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"".
- default
Percent Number Percent of traffic to shed 0 - 100. Defaults to
0.- default
Policy String Method of shedding traffic. Available values: ``,
hash,random. Defaults to"".- session
Percent Number Percent of session traffic to shed 0 - 100. Defaults to
0.- session
Policy String Method of shedding traffic. Available values: ``,
hash. Defaults to"".
LoadBalancerPoolOrigin
- 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<Load
Balancer Pool Origin Header> HTTP request headers.
- 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. 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
[]Load
Balancer Pool Origin Header HTTP request headers.
- 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. 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<Load
Balancer Pool Origin Header> HTTP request headers.
- 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. 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
Load
Balancer Pool Origin Header[] HTTP request headers.
- 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. 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[Load
Balancer Pool Origin Header] HTTP request headers.
- 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. 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.
- 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. Defaults to
1.
LoadBalancerPoolOriginHeader
LoadBalancerPoolOriginSteering
- Policy string
Origin steering policy to be used. Available values: ``,
hash,random. Defaults torandom.
- Policy string
Origin steering policy to be used. Available values: ``,
hash,random. Defaults torandom.
- policy String
Origin steering policy to be used. Available values: ``,
hash,random. Defaults torandom.
- policy string
Origin steering policy to be used. Available values: ``,
hash,random. Defaults torandom.
- policy str
Origin steering policy to be used. Available values: ``,
hash,random. Defaults torandom.
- policy String
Origin steering policy to be used. Available values: ``,
hash,random. Defaults torandom.
Package Details
- Repository
- Cloudflare pulumi/pulumi-cloudflare
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
cloudflareTerraform Provider.