Cloudflare v5.49.1, Feb 18 25

Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi

cloudflare.getLoadBalancerPools

Explore with Pulumi AI

Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const example = cloudflare.getLoadBalancerPools({
    accountId: "f037e56e89293a057740de681ac9abbe",
    filter: {
        name: "example-lb-pool",
    },
});

import pulumi
import pulumi_cloudflare as cloudflare

example = cloudflare.get_load_balancer_pools(account_id="f037e56e89293a057740de681ac9abbe",
    filter={
        "name": "example-lb-pool",
    })

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.GetLoadBalancerPools(ctx, &cloudflare.GetLoadBalancerPoolsArgs{
			AccountId: "f037e56e89293a057740de681ac9abbe",
			Filter: cloudflare.GetLoadBalancerPoolsFilter{
				Name: pulumi.StringRef("example-lb-pool"),
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var example = Cloudflare.GetLoadBalancerPools.Invoke(new()
    {
        AccountId = "f037e56e89293a057740de681ac9abbe",
        Filter = new Cloudflare.Inputs.GetLoadBalancerPoolsFilterInputArgs
        {
            Name = "example-lb-pool",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetLoadBalancerPoolsArgs;
import com.pulumi.cloudflare.inputs.GetLoadBalancerPoolsFilterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = CloudflareFunctions.getLoadBalancerPools(GetLoadBalancerPoolsArgs.builder()
            .accountId("f037e56e89293a057740de681ac9abbe")
            .filter(GetLoadBalancerPoolsFilterArgs.builder()
                .name("example-lb-pool")
                .build())
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: cloudflare:getLoadBalancerPools
      arguments:
        accountId: f037e56e89293a057740de681ac9abbe
        filter:
          name: example-lb-pool

Using getLoadBalancerPools

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getLoadBalancerPools(args: GetLoadBalancerPoolsArgs, opts?: InvokeOptions): Promise<GetLoadBalancerPoolsResult>
function getLoadBalancerPoolsOutput(args: GetLoadBalancerPoolsOutputArgs, opts?: InvokeOptions): Output<GetLoadBalancerPoolsResult>

def get_load_balancer_pools(account_id: Optional[str] = None,
                            filter: Optional[GetLoadBalancerPoolsFilter] = None,
                            pools: Optional[Sequence[GetLoadBalancerPoolsPool]] = None,
                            opts: Optional[InvokeOptions] = None) -> GetLoadBalancerPoolsResult
def get_load_balancer_pools_output(account_id: Optional[pulumi.Input[str]] = None,
                            filter: Optional[pulumi.Input[GetLoadBalancerPoolsFilterArgs]] = None,
                            pools: Optional[pulumi.Input[Sequence[pulumi.Input[GetLoadBalancerPoolsPoolArgs]]]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetLoadBalancerPoolsResult]

func GetLoadBalancerPools(ctx *Context, args *GetLoadBalancerPoolsArgs, opts ...InvokeOption) (*GetLoadBalancerPoolsResult, error)
func GetLoadBalancerPoolsOutput(ctx *Context, args *GetLoadBalancerPoolsOutputArgs, opts ...InvokeOption) GetLoadBalancerPoolsResultOutput

> Note: This function is named GetLoadBalancerPools in the Go SDK.

public static class GetLoadBalancerPools 
{
    public static Task<GetLoadBalancerPoolsResult> InvokeAsync(GetLoadBalancerPoolsArgs args, InvokeOptions? opts = null)
    public static Output<GetLoadBalancerPoolsResult> Invoke(GetLoadBalancerPoolsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetLoadBalancerPoolsResult> getLoadBalancerPools(GetLoadBalancerPoolsArgs args, InvokeOptions options)
public static Output<GetLoadBalancerPoolsResult> getLoadBalancerPools(GetLoadBalancerPoolsArgs args, InvokeOptions options)

fn::invoke:
  function: cloudflare:index/getLoadBalancerPools:getLoadBalancerPools
  arguments:
    # arguments dictionary

The following arguments are supported:

AccountId string: The account identifier to target for the datasource lookups.
Filter GetLoadBalancerPoolsFilter: One or more values used to look up Load Balancer pools. If more than one value is given all values must match in order to be included.
Pools List<GetLoadBalancerPoolsPool>: A list of Load Balancer Pools details.

AccountId string: The account identifier to target for the datasource lookups.
Filter GetLoadBalancerPoolsFilter: One or more values used to look up Load Balancer pools. If more than one value is given all values must match in order to be included.
Pools []GetLoadBalancerPoolsPool: A list of Load Balancer Pools details.

accountId String: The account identifier to target for the datasource lookups.
filter GetLoadBalancerPoolsFilter: One or more values used to look up Load Balancer pools. If more than one value is given all values must match in order to be included.
pools List<GetLoadBalancerPoolsPool>: A list of Load Balancer Pools details.

accountId string: The account identifier to target for the datasource lookups.
filter GetLoadBalancerPoolsFilter: One or more values used to look up Load Balancer pools. If more than one value is given all values must match in order to be included.
pools GetLoadBalancerPoolsPool[]: A list of Load Balancer Pools details.

account_id str: The account identifier to target for the datasource lookups.
filter GetLoadBalancerPoolsFilter: One or more values used to look up Load Balancer pools. If more than one value is given all values must match in order to be included.
pools Sequence[GetLoadBalancerPoolsPool]: A list of Load Balancer Pools details.

accountId String: The account identifier to target for the datasource lookups.
filter Property Map: One or more values used to look up Load Balancer pools. If more than one value is given all values must match in order to be included.
pools List<Property Map>: A list of Load Balancer Pools details.

getLoadBalancerPools Result

The following output properties are available:

AccountId string: The account identifier to target for the datasource lookups.
Id string: The provider-assigned unique ID for this managed resource.
Pools List<GetLoadBalancerPoolsPool>: A list of Load Balancer Pools details.
Filter GetLoadBalancerPoolsFilter: One or more values used to look up Load Balancer pools. If more than one value is given all values must match in order to be included.

AccountId string: The account identifier to target for the datasource lookups.
Id string: The provider-assigned unique ID for this managed resource.
Pools []GetLoadBalancerPoolsPool: A list of Load Balancer Pools details.
Filter GetLoadBalancerPoolsFilter: One or more values used to look up Load Balancer pools. If more than one value is given all values must match in order to be included.

accountId String: The account identifier to target for the datasource lookups.
id String: The provider-assigned unique ID for this managed resource.
pools List<GetLoadBalancerPoolsPool>: A list of Load Balancer Pools details.
filter GetLoadBalancerPoolsFilter: One or more values used to look up Load Balancer pools. If more than one value is given all values must match in order to be included.

accountId string: The account identifier to target for the datasource lookups.
id string: The provider-assigned unique ID for this managed resource.
pools GetLoadBalancerPoolsPool[]: A list of Load Balancer Pools details.
filter GetLoadBalancerPoolsFilter: One or more values used to look up Load Balancer pools. If more than one value is given all values must match in order to be included.

account_id str: The account identifier to target for the datasource lookups.
id str: The provider-assigned unique ID for this managed resource.
pools Sequence[GetLoadBalancerPoolsPool]: A list of Load Balancer Pools details.
filter GetLoadBalancerPoolsFilter: One or more values used to look up Load Balancer pools. If more than one value is given all values must match in order to be included.

accountId String: The account identifier to target for the datasource lookups.
id String: The provider-assigned unique ID for this managed resource.
pools List<Property Map>: A list of Load Balancer Pools details.
filter Property Map: One or more values used to look up Load Balancer pools. If more than one value is given all values must match in order to be included.

Supporting Types

GetLoadBalancerPoolsFilter

Name string: A regular expression matching the name of the Load Balancer pool to lookup.

Name string: A regular expression matching the name of the Load Balancer pool to lookup.

name String: A regular expression matching the name of the Load Balancer pool to lookup.

name string: A regular expression matching the name of the Load Balancer pool to lookup.

name str: A regular expression matching the name of the Load Balancer pool to lookup.

name String: A regular expression matching the name of the Load Balancer pool to lookup.

GetLoadBalancerPoolsPool

CheckRegions List<string>: 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.
CreatedOn string: The RFC3339 timestamp of when the load balancer was created.
Description string: Brief description of the Load Balancer Pool intention.
Enabled bool: Whether this pool is enabled. Disabled pools will not receive traffic and are excluded from health checks.
Id string: ID for this load balancer pool.
Latitude double: Latitude this pool is physically located at; used for proximity steering.
LoadSheddings List<GetLoadBalancerPoolsPoolLoadShedding>: Setting for controlling load shedding for this pool.
Longitude double: Longitude this pool is physically located at; used for proximity steering.
MinimumOrigins int: Minimum number of origins that must be healthy for this pool to serve traffic.
ModifiedOn string: The RFC3339 timestamp of when the load balancer was last modified.
Monitor string: ID of the Monitor to use for health checking origins within this pool.
Name string: Short name (tag) for the pool.
NotificationEmail string: Email address to send health status notifications to. Multiple emails are set as a comma delimited list.
Origins List<GetLoadBalancerPoolsPoolOrigin>: The list of origins within this pool.

CheckRegions []string: 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.
CreatedOn string: The RFC3339 timestamp of when the load balancer was created.
Description string: Brief description of the Load Balancer Pool intention.
Enabled bool: Whether this pool is enabled. Disabled pools will not receive traffic and are excluded from health checks.
Id string: ID for this load balancer pool.
Latitude float64: Latitude this pool is physically located at; used for proximity steering.
LoadSheddings []GetLoadBalancerPoolsPoolLoadShedding: Setting for controlling load shedding for this pool.
Longitude float64: Longitude this pool is physically located at; used for proximity steering.
MinimumOrigins int: Minimum number of origins that must be healthy for this pool to serve traffic.
ModifiedOn string: The RFC3339 timestamp of when the load balancer was last modified.
Monitor string: ID of the Monitor to use for health checking origins within this pool.
Name string: Short name (tag) for the pool.
NotificationEmail string: Email address to send health status notifications to. Multiple emails are set as a comma delimited list.
Origins []GetLoadBalancerPoolsPoolOrigin: The list of origins within this pool.

checkRegions List<String>: 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.
createdOn String: The RFC3339 timestamp of when the load balancer was created.
description String: Brief description of the Load Balancer Pool intention.
enabled Boolean: Whether this pool is enabled. Disabled pools will not receive traffic and are excluded from health checks.
id String: ID for this load balancer pool.
latitude Double: Latitude this pool is physically located at; used for proximity steering.
loadSheddings List<GetLoadBalancerPoolsPoolLoadShedding>: Setting for controlling load shedding for this pool.
longitude Double: Longitude this pool is physically located at; used for proximity steering.
minimumOrigins Integer: Minimum number of origins that must be healthy for this pool to serve traffic.
modifiedOn String: The RFC3339 timestamp of when the load balancer was last modified.
monitor String: ID of the Monitor to use for health checking origins within this pool.
name String: Short name (tag) for the pool.
notificationEmail String: Email address to send health status notifications to. Multiple emails are set as a comma delimited list.
origins List<GetLoadBalancerPoolsPoolOrigin>: The list of origins within this pool.

checkRegions string[]: 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.
createdOn string: The RFC3339 timestamp of when the load balancer was created.
description string: Brief description of the Load Balancer Pool intention.
enabled boolean: Whether this pool is enabled. Disabled pools will not receive traffic and are excluded from health checks.
id string: ID for this load balancer pool.
latitude number: Latitude this pool is physically located at; used for proximity steering.
loadSheddings GetLoadBalancerPoolsPoolLoadShedding[]: Setting for controlling load shedding for this pool.
longitude number: Longitude this pool is physically located at; used for proximity steering.
minimumOrigins number: Minimum number of origins that must be healthy for this pool to serve traffic.
modifiedOn string: The RFC3339 timestamp of when the load balancer was last modified.
monitor string: ID of the Monitor to use for health checking origins within this pool.
name string: Short name (tag) for the pool.
notificationEmail string: Email address to send health status notifications to. Multiple emails are set as a comma delimited list.
origins GetLoadBalancerPoolsPoolOrigin[]: The list of origins within this pool.

check_regions Sequence[str]: 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: Brief description of the Load Balancer Pool intention.
enabled bool: Whether this pool is enabled. Disabled pools will not receive traffic and are excluded from health checks.
id str: ID for this load balancer pool.
latitude float: Latitude this pool is physically located at; used for proximity steering.
load_sheddings Sequence[GetLoadBalancerPoolsPoolLoadShedding]: Setting for controlling load shedding for this pool.
longitude float: Longitude this pool is physically located at; used for proximity steering.
minimum_origins int: Minimum number of origins that must be healthy for this pool to serve traffic.
modified_on str: The RFC3339 timestamp of when the load balancer was last modified.
monitor str: ID of the Monitor to use for health checking origins within this pool.
name str: Short name (tag) for the pool.
notification_email str: Email address to send health status notifications to. Multiple emails are set as a comma delimited list.
origins Sequence[GetLoadBalancerPoolsPoolOrigin]: The list of origins within this pool.

checkRegions List<String>: 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.
createdOn String: The RFC3339 timestamp of when the load balancer was created.
description String: Brief description of the Load Balancer Pool intention.
enabled Boolean: Whether this pool is enabled. Disabled pools will not receive traffic and are excluded from health checks.
id String: ID for this load balancer pool.
latitude Number: 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: Longitude this pool is physically located at; used for proximity steering.
minimumOrigins Number: Minimum number of origins that must be healthy for this pool to serve traffic.
modifiedOn String: The RFC3339 timestamp of when the load balancer was last modified.
monitor String: ID of the Monitor to use for health checking origins within this pool.
name String: Short name (tag) for the pool.
notificationEmail String: Email address to send health status notifications to. Multiple emails are set as a comma delimited list.
origins List<Property Map>: The list of origins within this pool.

GetLoadBalancerPoolsPoolLoadShedding

DefaultPercent double: Percent of traffic to shed 0 - 100.
DefaultPolicy string: Method of shedding traffic. Available values: "", hash, random
SessionPercent double: Percent of session traffic to shed 0 - 100.
SessionPolicy string: Method of shedding traffic. Available values: "", hash

DefaultPercent float64: Percent of traffic to shed 0 - 100.
DefaultPolicy string: Method of shedding traffic. Available values: "", hash, random
SessionPercent float64: Percent of session traffic to shed 0 - 100.
SessionPolicy string: Method of shedding traffic. Available values: "", hash

defaultPercent Double: Percent of traffic to shed 0 - 100.
defaultPolicy String: Method of shedding traffic. Available values: "", hash, random
sessionPercent Double: Percent of session traffic to shed 0 - 100.
sessionPolicy String: Method of shedding traffic. Available values: "", hash

defaultPercent number: Percent of traffic to shed 0 - 100.
defaultPolicy string: Method of shedding traffic. Available values: "", hash, random
sessionPercent number: Percent of session traffic to shed 0 - 100.
sessionPolicy string: Method of shedding traffic. Available values: "", hash

default_percent float: Percent of traffic to shed 0 - 100.
default_policy str: Method of shedding traffic. Available values: "", hash, random
session_percent float: Percent of session traffic to shed 0 - 100.
session_policy str: Method of shedding traffic. Available values: "", hash

defaultPercent Number: Percent of traffic to shed 0 - 100.
defaultPolicy String: Method of shedding traffic. Available values: "", hash, random
sessionPercent Number: Percent of session traffic to shed 0 - 100.
sessionPolicy String: Method of shedding traffic. Available values: "", hash

GetLoadBalancerPoolsPoolOrigin

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.
Headers List<GetLoadBalancerPoolsPoolOriginHeader>: 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.

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.
Headers []GetLoadBalancerPoolsPoolOriginHeader: 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.

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.
headers List<GetLoadBalancerPoolsPoolOriginHeader>: 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.

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.
headers GetLoadBalancerPoolsPoolOriginHeader[]: 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.

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.
headers Sequence[GetLoadBalancerPoolsPoolOriginHeader]: 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.

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

GetLoadBalancerPoolsPoolOriginHeader

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.

Package Details

Repository: Cloudflare pulumi/pulumi-cloudflare
License: Apache-2.0
Notes: This Pulumi package is based on the cloudflare Terraform Provider.

Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.getLoadBalancerPools

On this page

On this page

Example Usage

Using getLoadBalancerPools

getLoadBalancerPools Result

Supporting Types

GetLoadBalancerPoolsFilter

GetLoadBalancerPoolsPool

GetLoadBalancerPoolsPoolLoadShedding

GetLoadBalancerPoolsPoolOrigin

GetLoadBalancerPoolsPoolOriginHeader

Package Details

On this page

On this page