Class LoadBalancerPool

Provides a Cloudflare Load Balancer pool resource. This provides a pool of origins that can be used by a Cloudflare Load Balancer. Note that the load balancing feature must be enabled in your Cloudflare account before you can use this resource.

Example Usage

using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

class MyStack : Stack
{
public MyStack()
{
    var foo = new Cloudflare.LoadBalancerPool("foo", new Cloudflare.LoadBalancerPoolArgs
    {
        Description = "example load balancer pool",
        Enabled = false,
        MinimumOrigins = 1,
        Name = "example-pool",
        NotificationEmail = "someone@example.com",
        Origins = 
        {
            new Cloudflare.Inputs.LoadBalancerPoolOriginArgs
            {
                Address = "192.0.2.1",
                Enabled = false,
                Name = "example-1",
            },
            new Cloudflare.Inputs.LoadBalancerPoolOriginArgs
            {
                Address = "192.0.2.2",
                Name = "example-2",
            },
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

LoadBalancerPool

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Cloudflare

Assembly: Pulumi.Cloudflare.dll

Syntax

public class LoadBalancerPool : CustomResource

Constructors

LoadBalancerPool(String, LoadBalancerPoolArgs, CustomResourceOptions)

Create a LoadBalancerPool resource with the given unique name, arguments, and options.

Declaration

public LoadBalancerPool(string name, LoadBalancerPoolArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
LoadBalancerPoolArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

CheckRegions

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.

Declaration

public Output<ImmutableArray<string>> CheckRegions { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

CreatedOn

The RFC3339 timestamp of when the load balancer was created.

Declaration

public Output<string> CreatedOn { get; }

Property Value

Type	Description
Output<System.String>

Description

Free text description.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Enabled

Whether to enable (the default) this origin within the Pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

Declaration

public Output<bool?> Enabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

MinimumOrigins

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. Default: 1.

Declaration

public Output<int?> MinimumOrigins { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

ModifiedOn

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

Declaration

public Output<string> ModifiedOn { get; }

Property Value

Type	Description
Output<System.String>

Monitor

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

Declaration

public Output<string> Monitor { get; }

Property Value

Type	Description
Output<System.String>

Name

A human-identifiable name for the origin.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NotificationEmail

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.

Declaration

public Output<string> NotificationEmail { get; }

Property Value

Type	Description
Output<System.String>

Origins

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. It's a complex value. See description below.

Declaration

public Output<ImmutableArray<LoadBalancerPoolOrigin>> Origins { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<LoadBalancerPoolOrigin>>

Methods

Get(String, Input<String>, LoadBalancerPoolState, CustomResourceOptions)

Get an existing LoadBalancerPool resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static LoadBalancerPool Get(string name, Input<string> id, LoadBalancerPoolState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
LoadBalancerPoolState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
LoadBalancerPool