1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. LoadBalancerPool
Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi

cloudflare.LoadBalancerPool

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi

    Example Usage

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

    Create LoadBalancerPool Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LoadBalancerPool(name: string, args: LoadBalancerPoolArgs, opts?: CustomResourceOptions);
    @overload
    def LoadBalancerPool(resource_name: str,
                         args: LoadBalancerPoolArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def LoadBalancerPool(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         account_id: Optional[str] = None,
                         origins: Optional[Sequence[LoadBalancerPoolOriginArgs]] = None,
                         name: Optional[str] = None,
                         enabled: Optional[bool] = None,
                         latitude: Optional[float] = None,
                         load_shedding: Optional[LoadBalancerPoolLoadSheddingArgs] = None,
                         longitude: Optional[float] = None,
                         minimum_origins: Optional[int] = None,
                         monitor: Optional[str] = None,
                         description: Optional[str] = None,
                         notification_email: Optional[str] = None,
                         notification_filter: Optional[LoadBalancerPoolNotificationFilterArgs] = None,
                         origin_steering: Optional[LoadBalancerPoolOriginSteeringArgs] = None,
                         check_regions: Optional[Sequence[str]] = 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.
    
    

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var loadBalancerPoolResource = new Cloudflare.LoadBalancerPool("loadBalancerPoolResource", new()
    {
        AccountId = "string",
        Origins = new[]
        {
            new Cloudflare.Inputs.LoadBalancerPoolOriginArgs
            {
                Address = "string",
                DisabledAt = "string",
                Enabled = false,
                Header = new Cloudflare.Inputs.LoadBalancerPoolOriginHeaderArgs
                {
                    Hosts = new[]
                    {
                        "string",
                    },
                },
                Name = "string",
                VirtualNetworkId = "string",
                Weight = 0,
            },
        },
        Name = "string",
        Enabled = false,
        Latitude = 0,
        LoadShedding = new Cloudflare.Inputs.LoadBalancerPoolLoadSheddingArgs
        {
            DefaultPercent = 0,
            DefaultPolicy = "string",
            SessionPercent = 0,
            SessionPolicy = "string",
        },
        Longitude = 0,
        MinimumOrigins = 0,
        Monitor = "string",
        Description = "string",
        NotificationEmail = "string",
        NotificationFilter = new Cloudflare.Inputs.LoadBalancerPoolNotificationFilterArgs
        {
            Origin = new Cloudflare.Inputs.LoadBalancerPoolNotificationFilterOriginArgs
            {
                Disable = false,
                Healthy = false,
            },
            Pool = new Cloudflare.Inputs.LoadBalancerPoolNotificationFilterPoolArgs
            {
                Disable = false,
                Healthy = false,
            },
        },
        OriginSteering = new Cloudflare.Inputs.LoadBalancerPoolOriginSteeringArgs
        {
            Policy = "string",
        },
        CheckRegions = new[]
        {
            "string",
        },
    });
    
    example, err := cloudflare.NewLoadBalancerPool(ctx, "loadBalancerPoolResource", &cloudflare.LoadBalancerPoolArgs{
    	AccountId: pulumi.String("string"),
    	Origins: cloudflare.LoadBalancerPoolOriginArray{
    		&cloudflare.LoadBalancerPoolOriginArgs{
    			Address:    pulumi.String("string"),
    			DisabledAt: pulumi.String("string"),
    			Enabled:    pulumi.Bool(false),
    			Header: &cloudflare.LoadBalancerPoolOriginHeaderArgs{
    				Hosts: pulumi.StringArray{
    					pulumi.String("string"),
    				},
    			},
    			Name:             pulumi.String("string"),
    			VirtualNetworkId: pulumi.String("string"),
    			Weight:           pulumi.Float64(0),
    		},
    	},
    	Name:     pulumi.String("string"),
    	Enabled:  pulumi.Bool(false),
    	Latitude: pulumi.Float64(0),
    	LoadShedding: &cloudflare.LoadBalancerPoolLoadSheddingArgs{
    		DefaultPercent: pulumi.Float64(0),
    		DefaultPolicy:  pulumi.String("string"),
    		SessionPercent: pulumi.Float64(0),
    		SessionPolicy:  pulumi.String("string"),
    	},
    	Longitude:         pulumi.Float64(0),
    	MinimumOrigins:    pulumi.Int(0),
    	Monitor:           pulumi.String("string"),
    	Description:       pulumi.String("string"),
    	NotificationEmail: pulumi.String("string"),
    	NotificationFilter: &cloudflare.LoadBalancerPoolNotificationFilterArgs{
    		Origin: &cloudflare.LoadBalancerPoolNotificationFilterOriginArgs{
    			Disable: pulumi.Bool(false),
    			Healthy: pulumi.Bool(false),
    		},
    		Pool: &cloudflare.LoadBalancerPoolNotificationFilterPoolArgs{
    			Disable: pulumi.Bool(false),
    			Healthy: pulumi.Bool(false),
    		},
    	},
    	OriginSteering: &cloudflare.LoadBalancerPoolOriginSteeringArgs{
    		Policy: pulumi.String("string"),
    	},
    	CheckRegions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var loadBalancerPoolResource = new LoadBalancerPool("loadBalancerPoolResource", LoadBalancerPoolArgs.builder()
        .accountId("string")
        .origins(LoadBalancerPoolOriginArgs.builder()
            .address("string")
            .disabledAt("string")
            .enabled(false)
            .header(LoadBalancerPoolOriginHeaderArgs.builder()
                .hosts("string")
                .build())
            .name("string")
            .virtualNetworkId("string")
            .weight(0)
            .build())
        .name("string")
        .enabled(false)
        .latitude(0)
        .loadShedding(LoadBalancerPoolLoadSheddingArgs.builder()
            .defaultPercent(0)
            .defaultPolicy("string")
            .sessionPercent(0)
            .sessionPolicy("string")
            .build())
        .longitude(0)
        .minimumOrigins(0)
        .monitor("string")
        .description("string")
        .notificationEmail("string")
        .notificationFilter(LoadBalancerPoolNotificationFilterArgs.builder()
            .origin(LoadBalancerPoolNotificationFilterOriginArgs.builder()
                .disable(false)
                .healthy(false)
                .build())
            .pool(LoadBalancerPoolNotificationFilterPoolArgs.builder()
                .disable(false)
                .healthy(false)
                .build())
            .build())
        .originSteering(LoadBalancerPoolOriginSteeringArgs.builder()
            .policy("string")
            .build())
        .checkRegions("string")
        .build());
    
    load_balancer_pool_resource = cloudflare.LoadBalancerPool("loadBalancerPoolResource",
        account_id="string",
        origins=[{
            "address": "string",
            "disabled_at": "string",
            "enabled": False,
            "header": {
                "hosts": ["string"],
            },
            "name": "string",
            "virtual_network_id": "string",
            "weight": 0,
        }],
        name="string",
        enabled=False,
        latitude=0,
        load_shedding={
            "default_percent": 0,
            "default_policy": "string",
            "session_percent": 0,
            "session_policy": "string",
        },
        longitude=0,
        minimum_origins=0,
        monitor="string",
        description="string",
        notification_email="string",
        notification_filter={
            "origin": {
                "disable": False,
                "healthy": False,
            },
            "pool": {
                "disable": False,
                "healthy": False,
            },
        },
        origin_steering={
            "policy": "string",
        },
        check_regions=["string"])
    
    const loadBalancerPoolResource = new cloudflare.LoadBalancerPool("loadBalancerPoolResource", {
        accountId: "string",
        origins: [{
            address: "string",
            disabledAt: "string",
            enabled: false,
            header: {
                hosts: ["string"],
            },
            name: "string",
            virtualNetworkId: "string",
            weight: 0,
        }],
        name: "string",
        enabled: false,
        latitude: 0,
        loadShedding: {
            defaultPercent: 0,
            defaultPolicy: "string",
            sessionPercent: 0,
            sessionPolicy: "string",
        },
        longitude: 0,
        minimumOrigins: 0,
        monitor: "string",
        description: "string",
        notificationEmail: "string",
        notificationFilter: {
            origin: {
                disable: false,
                healthy: false,
            },
            pool: {
                disable: false,
                healthy: false,
            },
        },
        originSteering: {
            policy: "string",
        },
        checkRegions: ["string"],
    });
    
    type: cloudflare:LoadBalancerPool
    properties:
        accountId: string
        checkRegions:
            - string
        description: string
        enabled: false
        latitude: 0
        loadShedding:
            defaultPercent: 0
            defaultPolicy: string
            sessionPercent: 0
            sessionPolicy: string
        longitude: 0
        minimumOrigins: 0
        monitor: string
        name: string
        notificationEmail: string
        notificationFilter:
            origin:
                disable: false
                healthy: false
            pool:
                disable: false
                healthy: false
        originSteering:
            policy: string
        origins:
            - address: string
              disabledAt: string
              enabled: false
              header:
                hosts:
                    - string
              name: string
              virtualNetworkId: string
              weight: 0
    

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The LoadBalancerPool resource accepts the following input properties:

    AccountId string
    Identifier
    Name string
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    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 from which to run health checks. Null means every Cloudflare data center.
    Description string
    A human-readable description of the pool.
    Enabled bool
    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
    Latitude double
    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.
    LoadShedding LoadBalancerPoolLoadShedding
    Configures load shedding policies and percentages for the pool.
    Longitude double
    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.
    MinimumOrigins 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 will failover to the next available pool.
    Monitor string
    The ID of the Monitor to use for checking the health of origins within this pool.
    NotificationEmail string
    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
    NotificationFilter LoadBalancerPoolNotificationFilter
    Filter pool and origin health notifications by resource type or health status. Use null to reset.
    OriginSteering LoadBalancerPoolOriginSteering
    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
    AccountId string
    Identifier
    Name string
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    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 from which to run health checks. Null means every Cloudflare data center.
    Description string
    A human-readable description of the pool.
    Enabled bool
    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
    Latitude float64
    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.
    LoadShedding LoadBalancerPoolLoadSheddingArgs
    Configures load shedding policies and percentages for the pool.
    Longitude float64
    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.
    MinimumOrigins 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 will failover to the next available pool.
    Monitor string
    The ID of the Monitor to use for checking the health of origins within this pool.
    NotificationEmail string
    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
    NotificationFilter LoadBalancerPoolNotificationFilterArgs
    Filter pool and origin health notifications by resource type or health status. Use null to reset.
    OriginSteering LoadBalancerPoolOriginSteeringArgs
    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
    accountId String
    Identifier
    name String
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    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 from which to run health checks. Null means every Cloudflare data center.
    description String
    A human-readable description of the pool.
    enabled Boolean
    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
    latitude Double
    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.
    loadShedding LoadBalancerPoolLoadShedding
    Configures load shedding policies and percentages for the pool.
    longitude Double
    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.
    minimumOrigins 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 will failover to the next available pool.
    monitor String
    The ID of the Monitor to use for checking the health of origins within this pool.
    notificationEmail String
    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
    notificationFilter LoadBalancerPoolNotificationFilter
    Filter pool and origin health notifications by resource type or health status. Use null to reset.
    originSteering LoadBalancerPoolOriginSteering
    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
    accountId string
    Identifier
    name string
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    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 from which to run health checks. Null means every Cloudflare data center.
    description string
    A human-readable description of the pool.
    enabled boolean
    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
    latitude number
    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.
    loadShedding LoadBalancerPoolLoadShedding
    Configures load shedding policies and percentages for the pool.
    longitude number
    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.
    minimumOrigins 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 will failover to the next available pool.
    monitor string
    The ID of the Monitor to use for checking the health of origins within this pool.
    notificationEmail string
    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
    notificationFilter LoadBalancerPoolNotificationFilter
    Filter pool and origin health notifications by resource type or health status. Use null to reset.
    originSteering LoadBalancerPoolOriginSteering
    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
    account_id str
    Identifier
    name str
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    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 from which to run health checks. Null means every Cloudflare data center.
    description str
    A human-readable description of the pool.
    enabled bool
    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
    latitude float
    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.
    load_shedding LoadBalancerPoolLoadSheddingArgs
    Configures load shedding policies and percentages for the pool.
    longitude float
    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.
    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 will failover to the next available pool.
    monitor str
    The ID of the Monitor to use for checking the health of origins within this pool.
    notification_email str
    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
    notification_filter LoadBalancerPoolNotificationFilterArgs
    Filter pool and origin health notifications by resource type or health status. Use null to reset.
    origin_steering LoadBalancerPoolOriginSteeringArgs
    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
    accountId String
    Identifier
    name String
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    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 from which to run health checks. Null means every Cloudflare data center.
    description String
    A human-readable description of the pool.
    enabled Boolean
    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
    latitude Number
    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.
    loadShedding Property Map
    Configures load shedding policies and percentages for the pool.
    longitude Number
    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.
    minimumOrigins 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 will failover to the next available pool.
    monitor String
    The ID of the Monitor to use for checking the health of origins within this pool.
    notificationEmail String
    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
    notificationFilter Property Map
    Filter pool and origin health notifications by resource type or health status. Use null to reset.
    originSteering Property Map
    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LoadBalancerPool resource produces the following output properties:

    CreatedOn string
    DisabledAt string
    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedOn string
    Networks List<string>
    List of networks where Load Balancer or Pool is enabled.
    CreatedOn string
    DisabledAt string
    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedOn string
    Networks []string
    List of networks where Load Balancer or Pool is enabled.
    createdOn String
    disabledAt String
    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedOn String
    networks List<String>
    List of networks where Load Balancer or Pool is enabled.
    createdOn string
    disabledAt string
    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
    id string
    The provider-assigned unique ID for this managed resource.
    modifiedOn string
    networks string[]
    List of networks where Load Balancer or Pool is enabled.
    created_on str
    disabled_at str
    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
    id str
    The provider-assigned unique ID for this managed resource.
    modified_on str
    networks Sequence[str]
    List of networks where Load Balancer or Pool is enabled.
    createdOn String
    disabledAt String
    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedOn String
    networks List<String>
    List of networks where Load Balancer or Pool is enabled.

    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,
            disabled_at: Optional[str] = None,
            enabled: Optional[bool] = None,
            latitude: Optional[float] = None,
            load_shedding: Optional[LoadBalancerPoolLoadSheddingArgs] = None,
            longitude: Optional[float] = None,
            minimum_origins: Optional[int] = None,
            modified_on: Optional[str] = None,
            monitor: Optional[str] = None,
            name: Optional[str] = None,
            networks: Optional[Sequence[str]] = None,
            notification_email: Optional[str] = None,
            notification_filter: Optional[LoadBalancerPoolNotificationFilterArgs] = None,
            origin_steering: Optional[LoadBalancerPoolOriginSteeringArgs] = None,
            origins: Optional[Sequence[LoadBalancerPoolOriginArgs]] = None) -> LoadBalancerPool
    func 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)
    resources:  _:    type: cloudflare:LoadBalancerPool    get:      id: ${id}
    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.
    The following state arguments are supported:
    AccountId string
    Identifier
    CheckRegions List<string>
    A list of regions from which to run health checks. Null means every Cloudflare data center.
    CreatedOn string
    Description string
    A human-readable description of the pool.
    DisabledAt string
    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
    Enabled bool
    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
    Latitude double
    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.
    LoadShedding LoadBalancerPoolLoadShedding
    Configures load shedding policies and percentages for the pool.
    Longitude double
    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.
    MinimumOrigins 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 will failover to the next available pool.
    ModifiedOn string
    Monitor string
    The ID of the Monitor to use for checking the health of origins within this pool.
    Name string
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    Networks List<string>
    List of networks where Load Balancer or Pool is enabled.
    NotificationEmail string
    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
    NotificationFilter LoadBalancerPoolNotificationFilter
    Filter pool and origin health notifications by resource type or health status. Use null to reset.
    OriginSteering LoadBalancerPoolOriginSteering
    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
    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.
    AccountId string
    Identifier
    CheckRegions []string
    A list of regions from which to run health checks. Null means every Cloudflare data center.
    CreatedOn string
    Description string
    A human-readable description of the pool.
    DisabledAt string
    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
    Enabled bool
    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
    Latitude float64
    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.
    LoadShedding LoadBalancerPoolLoadSheddingArgs
    Configures load shedding policies and percentages for the pool.
    Longitude float64
    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.
    MinimumOrigins 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 will failover to the next available pool.
    ModifiedOn string
    Monitor string
    The ID of the Monitor to use for checking the health of origins within this pool.
    Name string
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    Networks []string
    List of networks where Load Balancer or Pool is enabled.
    NotificationEmail string
    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
    NotificationFilter LoadBalancerPoolNotificationFilterArgs
    Filter pool and origin health notifications by resource type or health status. Use null to reset.
    OriginSteering LoadBalancerPoolOriginSteeringArgs
    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
    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.
    accountId String
    Identifier
    checkRegions List<String>
    A list of regions from which to run health checks. Null means every Cloudflare data center.
    createdOn String
    description String
    A human-readable description of the pool.
    disabledAt String
    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
    enabled Boolean
    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
    latitude Double
    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.
    loadShedding LoadBalancerPoolLoadShedding
    Configures load shedding policies and percentages for the pool.
    longitude Double
    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.
    minimumOrigins 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 will failover to the next available pool.
    modifiedOn String
    monitor String
    The ID of the Monitor to use for checking the health of origins within this pool.
    name String
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    networks List<String>
    List of networks where Load Balancer or Pool is enabled.
    notificationEmail String
    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
    notificationFilter LoadBalancerPoolNotificationFilter
    Filter pool and origin health notifications by resource type or health status. Use null to reset.
    originSteering LoadBalancerPoolOriginSteering
    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
    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.
    accountId string
    Identifier
    checkRegions string[]
    A list of regions from which to run health checks. Null means every Cloudflare data center.
    createdOn string
    description string
    A human-readable description of the pool.
    disabledAt string
    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
    enabled boolean
    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
    latitude number
    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.
    loadShedding LoadBalancerPoolLoadShedding
    Configures load shedding policies and percentages for the pool.
    longitude number
    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.
    minimumOrigins 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 will failover to the next available pool.
    modifiedOn string
    monitor string
    The ID of the Monitor to use for checking the health of origins within this pool.
    name string
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    networks string[]
    List of networks where Load Balancer or Pool is enabled.
    notificationEmail string
    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
    notificationFilter LoadBalancerPoolNotificationFilter
    Filter pool and origin health notifications by resource type or health status. Use null to reset.
    originSteering LoadBalancerPoolOriginSteering
    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
    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.
    account_id str
    Identifier
    check_regions Sequence[str]
    A list of regions from which to run health checks. Null means every Cloudflare data center.
    created_on str
    description str
    A human-readable description of the pool.
    disabled_at str
    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
    enabled bool
    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
    latitude float
    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.
    load_shedding LoadBalancerPoolLoadSheddingArgs
    Configures load shedding policies and percentages for the pool.
    longitude float
    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.
    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 will failover to the next available pool.
    modified_on str
    monitor str
    The ID of the Monitor to use for checking the health of origins within this pool.
    name str
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    networks Sequence[str]
    List of networks where Load Balancer or Pool is enabled.
    notification_email str
    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
    notification_filter LoadBalancerPoolNotificationFilterArgs
    Filter pool and origin health notifications by resource type or health status. Use null to reset.
    origin_steering LoadBalancerPoolOriginSteeringArgs
    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
    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.
    accountId String
    Identifier
    checkRegions List<String>
    A list of regions from which to run health checks. Null means every Cloudflare data center.
    createdOn String
    description String
    A human-readable description of the pool.
    disabledAt String
    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
    enabled Boolean
    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
    latitude Number
    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.
    loadShedding Property Map
    Configures load shedding policies and percentages for the pool.
    longitude Number
    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.
    minimumOrigins 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 will failover to the next available pool.
    modifiedOn String
    monitor String
    The ID of the Monitor to use for checking the health of origins within this pool.
    name String
    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
    networks List<String>
    List of networks where Load Balancer or Pool is enabled.
    notificationEmail String
    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
    notificationFilter Property Map
    Filter pool and origin health notifications by resource type or health status. Use null to reset.
    originSteering Property Map
    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
    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, LoadBalancerPoolLoadSheddingArgs

    DefaultPercent double
    The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.
    DefaultPolicy string
    The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs. Available values: "random", "hash".
    SessionPercent double
    The percent of existing sessions to shed from the pool, according to the session policy.
    SessionPolicy string
    Only the hash policy is supported for existing sessions (to avoid exponential decay). Available values: "hash".
    DefaultPercent float64
    The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.
    DefaultPolicy string
    The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs. Available values: "random", "hash".
    SessionPercent float64
    The percent of existing sessions to shed from the pool, according to the session policy.
    SessionPolicy string
    Only the hash policy is supported for existing sessions (to avoid exponential decay). Available values: "hash".
    defaultPercent Double
    The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.
    defaultPolicy String
    The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs. Available values: "random", "hash".
    sessionPercent Double
    The percent of existing sessions to shed from the pool, according to the session policy.
    sessionPolicy String
    Only the hash policy is supported for existing sessions (to avoid exponential decay). Available values: "hash".
    defaultPercent number
    The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.
    defaultPolicy string
    The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs. Available values: "random", "hash".
    sessionPercent number
    The percent of existing sessions to shed from the pool, according to the session policy.
    sessionPolicy string
    Only the hash policy is supported for existing sessions (to avoid exponential decay). Available values: "hash".
    default_percent float
    The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.
    default_policy str
    The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs. Available values: "random", "hash".
    session_percent float
    The percent of existing sessions to shed from the pool, according to the session policy.
    session_policy str
    Only the hash policy is supported for existing sessions (to avoid exponential decay). Available values: "hash".
    defaultPercent Number
    The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.
    defaultPolicy String
    The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs. Available values: "random", "hash".
    sessionPercent Number
    The percent of existing sessions to shed from the pool, according to the session policy.
    sessionPolicy String
    Only the hash policy is supported for existing sessions (to avoid exponential decay). Available values: "hash".

    LoadBalancerPoolNotificationFilter, LoadBalancerPoolNotificationFilterArgs

    Origin LoadBalancerPoolNotificationFilterOrigin
    Filter options for a particular resource type (pool or origin). Use null to reset.
    Pool LoadBalancerPoolNotificationFilterPool
    Filter options for a particular resource type (pool or origin). Use null to reset.
    Origin LoadBalancerPoolNotificationFilterOrigin
    Filter options for a particular resource type (pool or origin). Use null to reset.
    Pool LoadBalancerPoolNotificationFilterPool
    Filter options for a particular resource type (pool or origin). Use null to reset.
    origin LoadBalancerPoolNotificationFilterOrigin
    Filter options for a particular resource type (pool or origin). Use null to reset.
    pool LoadBalancerPoolNotificationFilterPool
    Filter options for a particular resource type (pool or origin). Use null to reset.
    origin LoadBalancerPoolNotificationFilterOrigin
    Filter options for a particular resource type (pool or origin). Use null to reset.
    pool LoadBalancerPoolNotificationFilterPool
    Filter options for a particular resource type (pool or origin). Use null to reset.
    origin LoadBalancerPoolNotificationFilterOrigin
    Filter options for a particular resource type (pool or origin). Use null to reset.
    pool LoadBalancerPoolNotificationFilterPool
    Filter options for a particular resource type (pool or origin). Use null to reset.
    origin Property Map
    Filter options for a particular resource type (pool or origin). Use null to reset.
    pool Property Map
    Filter options for a particular resource type (pool or origin). Use null to reset.

    LoadBalancerPoolNotificationFilterOrigin, LoadBalancerPoolNotificationFilterOriginArgs

    Disable bool
    If set true, disable notifications for this type of resource (pool or origin).
    Healthy bool
    If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).
    Disable bool
    If set true, disable notifications for this type of resource (pool or origin).
    Healthy bool
    If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).
    disable Boolean
    If set true, disable notifications for this type of resource (pool or origin).
    healthy Boolean
    If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).
    disable boolean
    If set true, disable notifications for this type of resource (pool or origin).
    healthy boolean
    If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).
    disable bool
    If set true, disable notifications for this type of resource (pool or origin).
    healthy bool
    If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).
    disable Boolean
    If set true, disable notifications for this type of resource (pool or origin).
    healthy Boolean
    If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).

    LoadBalancerPoolNotificationFilterPool, LoadBalancerPoolNotificationFilterPoolArgs

    Disable bool
    If set true, disable notifications for this type of resource (pool or origin).
    Healthy bool
    If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).
    Disable bool
    If set true, disable notifications for this type of resource (pool or origin).
    Healthy bool
    If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).
    disable Boolean
    If set true, disable notifications for this type of resource (pool or origin).
    healthy Boolean
    If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).
    disable boolean
    If set true, disable notifications for this type of resource (pool or origin).
    healthy boolean
    If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).
    disable bool
    If set true, disable notifications for this type of resource (pool or origin).
    healthy bool
    If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).
    disable Boolean
    If set true, disable notifications for this type of resource (pool or origin).
    healthy Boolean
    If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).

    LoadBalancerPoolOrigin, LoadBalancerPoolOriginArgs

    Address string
    The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtualnetworkid must also be set.
    DisabledAt string
    This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.
    Enabled bool
    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.
    Header LoadBalancerPoolOriginHeader
    The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.
    Name string
    A human-identifiable name for the origin.
    VirtualNetworkId string
    The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.
    Weight double
    The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.
    Address string
    The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtualnetworkid must also be set.
    DisabledAt string
    This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.
    Enabled bool
    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.
    Header LoadBalancerPoolOriginHeader
    The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.
    Name string
    A human-identifiable name for the origin.
    VirtualNetworkId string
    The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.
    Weight float64
    The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.
    address String
    The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtualnetworkid must also be set.
    disabledAt String
    This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.
    enabled Boolean
    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.
    header LoadBalancerPoolOriginHeader
    The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.
    name String
    A human-identifiable name for the origin.
    virtualNetworkId String
    The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.
    weight Double
    The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.
    address string
    The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtualnetworkid must also be set.
    disabledAt string
    This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.
    enabled boolean
    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.
    header LoadBalancerPoolOriginHeader
    The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.
    name string
    A human-identifiable name for the origin.
    virtualNetworkId string
    The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.
    weight number
    The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.
    address str
    The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtualnetworkid must also be set.
    disabled_at str
    This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.
    enabled bool
    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.
    header LoadBalancerPoolOriginHeader
    The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.
    name str
    A human-identifiable name for the origin.
    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 of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.
    address String
    The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtualnetworkid must also be set.
    disabledAt String
    This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.
    enabled Boolean
    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.
    header Property Map
    The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.
    name String
    A human-identifiable name for the origin.
    virtualNetworkId String
    The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.
    weight Number
    The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.

    LoadBalancerPoolOriginHeader, LoadBalancerPoolOriginHeaderArgs

    Hosts List<string>
    The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.
    Hosts []string
    The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.
    hosts List<String>
    The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.
    hosts string[]
    The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.
    hosts Sequence[str]
    The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.
    hosts List<String>
    The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.

    LoadBalancerPoolOriginSteering, LoadBalancerPoolOriginSteeringArgs

    Policy string
    The type of origin steering policy to use.
    Policy string
    The type of origin steering policy to use.
    policy String
    The type of origin steering policy to use.
    policy string
    The type of origin steering policy to use.
    policy str
    The type of origin steering policy to use.
    policy String
    The type of origin steering policy to use.

    Import

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi