1. Packages
  2. F5 BIG-IP
  3. API Docs
  4. ltm
  5. Pool
f5 BIG-IP v3.16.0 published on Monday, Feb 19, 2024 by Pulumi

f5bigip.ltm.Pool

Explore with Pulumi AI

f5bigip logo
f5 BIG-IP v3.16.0 published on Monday, Feb 19, 2024 by Pulumi

    f5bigip.ltm.Pool Manages F5 BIG-IP LTM pools via iControl REST API.

    For resources should be named with their full path. The full path is the combination of the partition + name of the resource or partition + directory + name. For example /Common/my-pool.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using F5BigIP = Pulumi.F5BigIP;
    
    return await Deployment.RunAsync(() => 
    {
        var monitor = new F5BigIP.Ltm.Monitor("monitor", new()
        {
            Name = "/Common/terraform_monitor",
            Parent = "/Common/http",
        });
    
        var pool = new F5BigIP.Ltm.Pool("pool", new()
        {
            Name = "/Common/Axiom_Environment_APP1_Pool",
            LoadBalancingMode = "round-robin",
            MinimumActiveMembers = 1,
            Monitors = new[]
            {
                monitor.Name,
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip/ltm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		monitor, err := ltm.NewMonitor(ctx, "monitor", &ltm.MonitorArgs{
    			Name:   pulumi.String("/Common/terraform_monitor"),
    			Parent: pulumi.String("/Common/http"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ltm.NewPool(ctx, "pool", &ltm.PoolArgs{
    			Name:                 pulumi.String("/Common/Axiom_Environment_APP1_Pool"),
    			LoadBalancingMode:    pulumi.String("round-robin"),
    			MinimumActiveMembers: pulumi.Int(1),
    			Monitors: pulumi.StringArray{
    				monitor.Name,
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.f5bigip.ltm.Monitor;
    import com.pulumi.f5bigip.ltm.MonitorArgs;
    import com.pulumi.f5bigip.ltm.Pool;
    import com.pulumi.f5bigip.ltm.PoolArgs;
    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) {
            var monitor = new Monitor("monitor", MonitorArgs.builder()        
                .name("/Common/terraform_monitor")
                .parent("/Common/http")
                .build());
    
            var pool = new Pool("pool", PoolArgs.builder()        
                .name("/Common/Axiom_Environment_APP1_Pool")
                .loadBalancingMode("round-robin")
                .minimumActiveMembers(1)
                .monitors(monitor.name())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_f5bigip as f5bigip
    
    monitor = f5bigip.ltm.Monitor("monitor",
        name="/Common/terraform_monitor",
        parent="/Common/http")
    pool = f5bigip.ltm.Pool("pool",
        name="/Common/Axiom_Environment_APP1_Pool",
        load_balancing_mode="round-robin",
        minimum_active_members=1,
        monitors=[monitor.name])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as f5bigip from "@pulumi/f5bigip";
    
    const monitor = new f5bigip.ltm.Monitor("monitor", {
        name: "/Common/terraform_monitor",
        parent: "/Common/http",
    });
    const pool = new f5bigip.ltm.Pool("pool", {
        name: "/Common/Axiom_Environment_APP1_Pool",
        loadBalancingMode: "round-robin",
        minimumActiveMembers: 1,
        monitors: [monitor.name],
    });
    
    resources:
      monitor:
        type: f5bigip:ltm:Monitor
        properties:
          name: /Common/terraform_monitor
          parent: /Common/http
      pool:
        type: f5bigip:ltm:Pool
        properties:
          name: /Common/Axiom_Environment_APP1_Pool
          loadBalancingMode: round-robin
          minimumActiveMembers: 1
          monitors:
            - ${monitor.name}
    

    Create Pool Resource

    new Pool(name: string, args: PoolArgs, opts?: CustomResourceOptions);
    @overload
    def Pool(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             allow_nat: Optional[str] = None,
             allow_snat: Optional[str] = None,
             description: Optional[str] = None,
             load_balancing_mode: Optional[str] = None,
             minimum_active_members: Optional[int] = None,
             monitors: Optional[Sequence[str]] = None,
             name: Optional[str] = None,
             reselect_tries: Optional[int] = None,
             service_down_action: Optional[str] = None,
             slow_ramp_time: Optional[int] = None)
    @overload
    def Pool(resource_name: str,
             args: PoolArgs,
             opts: Optional[ResourceOptions] = None)
    func NewPool(ctx *Context, name string, args PoolArgs, opts ...ResourceOption) (*Pool, error)
    public Pool(string name, PoolArgs args, CustomResourceOptions? opts = null)
    public Pool(String name, PoolArgs args)
    public Pool(String name, PoolArgs args, CustomResourceOptions options)
    
    type: f5bigip:ltm:Pool
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args PoolArgs
    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 PoolArgs
    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 PoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PoolArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Pool Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Pool resource accepts the following input properties:

    Name string
    Name of the pool,it should be full path.The full path is the combination of the partition + name of the pool.(For example /Common/my-pool)
    AllowNat string
    Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default : yes, Possible Values yes or no].
    AllowSnat string
    Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default : yes, Possible Values yes or no].
    Description string
    Specifies descriptive text that identifies the pool.
    LoadBalancingMode string
    Specifies the load balancing method. The default is Round Robin.
    MinimumActiveMembers int
    Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is 0 meaning disabled.
    Monitors List<string>
    List of monitor names to associate with the pool
    ReselectTries int
    Specifies the number of times the system tries to contact a new pool member after a passive failure.
    ServiceDownAction string
    Specifies how the system should respond when the target pool member becomes unavailable. The default is None, Possible values: [none, reset, reselect, drop].
    SlowRampTime int
    Specifies the duration during which the system sends less traffic to a newly-enabled pool member.
    Name string
    Name of the pool,it should be full path.The full path is the combination of the partition + name of the pool.(For example /Common/my-pool)
    AllowNat string
    Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default : yes, Possible Values yes or no].
    AllowSnat string
    Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default : yes, Possible Values yes or no].
    Description string
    Specifies descriptive text that identifies the pool.
    LoadBalancingMode string
    Specifies the load balancing method. The default is Round Robin.
    MinimumActiveMembers int
    Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is 0 meaning disabled.
    Monitors []string
    List of monitor names to associate with the pool
    ReselectTries int
    Specifies the number of times the system tries to contact a new pool member after a passive failure.
    ServiceDownAction string
    Specifies how the system should respond when the target pool member becomes unavailable. The default is None, Possible values: [none, reset, reselect, drop].
    SlowRampTime int
    Specifies the duration during which the system sends less traffic to a newly-enabled pool member.
    name String
    Name of the pool,it should be full path.The full path is the combination of the partition + name of the pool.(For example /Common/my-pool)
    allowNat String
    Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default : yes, Possible Values yes or no].
    allowSnat String
    Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default : yes, Possible Values yes or no].
    description String
    Specifies descriptive text that identifies the pool.
    loadBalancingMode String
    Specifies the load balancing method. The default is Round Robin.
    minimumActiveMembers Integer
    Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is 0 meaning disabled.
    monitors List<String>
    List of monitor names to associate with the pool
    reselectTries Integer
    Specifies the number of times the system tries to contact a new pool member after a passive failure.
    serviceDownAction String
    Specifies how the system should respond when the target pool member becomes unavailable. The default is None, Possible values: [none, reset, reselect, drop].
    slowRampTime Integer
    Specifies the duration during which the system sends less traffic to a newly-enabled pool member.
    name string
    Name of the pool,it should be full path.The full path is the combination of the partition + name of the pool.(For example /Common/my-pool)
    allowNat string
    Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default : yes, Possible Values yes or no].
    allowSnat string
    Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default : yes, Possible Values yes or no].
    description string
    Specifies descriptive text that identifies the pool.
    loadBalancingMode string
    Specifies the load balancing method. The default is Round Robin.
    minimumActiveMembers number
    Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is 0 meaning disabled.
    monitors string[]
    List of monitor names to associate with the pool
    reselectTries number
    Specifies the number of times the system tries to contact a new pool member after a passive failure.
    serviceDownAction string
    Specifies how the system should respond when the target pool member becomes unavailable. The default is None, Possible values: [none, reset, reselect, drop].
    slowRampTime number
    Specifies the duration during which the system sends less traffic to a newly-enabled pool member.
    name str
    Name of the pool,it should be full path.The full path is the combination of the partition + name of the pool.(For example /Common/my-pool)
    allow_nat str
    Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default : yes, Possible Values yes or no].
    allow_snat str
    Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default : yes, Possible Values yes or no].
    description str
    Specifies descriptive text that identifies the pool.
    load_balancing_mode str
    Specifies the load balancing method. The default is Round Robin.
    minimum_active_members int
    Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is 0 meaning disabled.
    monitors Sequence[str]
    List of monitor names to associate with the pool
    reselect_tries int
    Specifies the number of times the system tries to contact a new pool member after a passive failure.
    service_down_action str
    Specifies how the system should respond when the target pool member becomes unavailable. The default is None, Possible values: [none, reset, reselect, drop].
    slow_ramp_time int
    Specifies the duration during which the system sends less traffic to a newly-enabled pool member.
    name String
    Name of the pool,it should be full path.The full path is the combination of the partition + name of the pool.(For example /Common/my-pool)
    allowNat String
    Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default : yes, Possible Values yes or no].
    allowSnat String
    Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default : yes, Possible Values yes or no].
    description String
    Specifies descriptive text that identifies the pool.
    loadBalancingMode String
    Specifies the load balancing method. The default is Round Robin.
    minimumActiveMembers Number
    Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is 0 meaning disabled.
    monitors List<String>
    List of monitor names to associate with the pool
    reselectTries Number
    Specifies the number of times the system tries to contact a new pool member after a passive failure.
    serviceDownAction String
    Specifies how the system should respond when the target pool member becomes unavailable. The default is None, Possible values: [none, reset, reselect, drop].
    slowRampTime Number
    Specifies the duration during which the system sends less traffic to a newly-enabled pool member.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Pool Resource

    Get an existing Pool 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?: PoolState, opts?: CustomResourceOptions): Pool
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allow_nat: Optional[str] = None,
            allow_snat: Optional[str] = None,
            description: Optional[str] = None,
            load_balancing_mode: Optional[str] = None,
            minimum_active_members: Optional[int] = None,
            monitors: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            reselect_tries: Optional[int] = None,
            service_down_action: Optional[str] = None,
            slow_ramp_time: Optional[int] = None) -> Pool
    func GetPool(ctx *Context, name string, id IDInput, state *PoolState, opts ...ResourceOption) (*Pool, error)
    public static Pool Get(string name, Input<string> id, PoolState? state, CustomResourceOptions? opts = null)
    public static Pool get(String name, Output<String> id, PoolState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllowNat string
    Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default : yes, Possible Values yes or no].
    AllowSnat string
    Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default : yes, Possible Values yes or no].
    Description string
    Specifies descriptive text that identifies the pool.
    LoadBalancingMode string
    Specifies the load balancing method. The default is Round Robin.
    MinimumActiveMembers int
    Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is 0 meaning disabled.
    Monitors List<string>
    List of monitor names to associate with the pool
    Name string
    Name of the pool,it should be full path.The full path is the combination of the partition + name of the pool.(For example /Common/my-pool)
    ReselectTries int
    Specifies the number of times the system tries to contact a new pool member after a passive failure.
    ServiceDownAction string
    Specifies how the system should respond when the target pool member becomes unavailable. The default is None, Possible values: [none, reset, reselect, drop].
    SlowRampTime int
    Specifies the duration during which the system sends less traffic to a newly-enabled pool member.
    AllowNat string
    Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default : yes, Possible Values yes or no].
    AllowSnat string
    Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default : yes, Possible Values yes or no].
    Description string
    Specifies descriptive text that identifies the pool.
    LoadBalancingMode string
    Specifies the load balancing method. The default is Round Robin.
    MinimumActiveMembers int
    Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is 0 meaning disabled.
    Monitors []string
    List of monitor names to associate with the pool
    Name string
    Name of the pool,it should be full path.The full path is the combination of the partition + name of the pool.(For example /Common/my-pool)
    ReselectTries int
    Specifies the number of times the system tries to contact a new pool member after a passive failure.
    ServiceDownAction string
    Specifies how the system should respond when the target pool member becomes unavailable. The default is None, Possible values: [none, reset, reselect, drop].
    SlowRampTime int
    Specifies the duration during which the system sends less traffic to a newly-enabled pool member.
    allowNat String
    Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default : yes, Possible Values yes or no].
    allowSnat String
    Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default : yes, Possible Values yes or no].
    description String
    Specifies descriptive text that identifies the pool.
    loadBalancingMode String
    Specifies the load balancing method. The default is Round Robin.
    minimumActiveMembers Integer
    Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is 0 meaning disabled.
    monitors List<String>
    List of monitor names to associate with the pool
    name String
    Name of the pool,it should be full path.The full path is the combination of the partition + name of the pool.(For example /Common/my-pool)
    reselectTries Integer
    Specifies the number of times the system tries to contact a new pool member after a passive failure.
    serviceDownAction String
    Specifies how the system should respond when the target pool member becomes unavailable. The default is None, Possible values: [none, reset, reselect, drop].
    slowRampTime Integer
    Specifies the duration during which the system sends less traffic to a newly-enabled pool member.
    allowNat string
    Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default : yes, Possible Values yes or no].
    allowSnat string
    Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default : yes, Possible Values yes or no].
    description string
    Specifies descriptive text that identifies the pool.
    loadBalancingMode string
    Specifies the load balancing method. The default is Round Robin.
    minimumActiveMembers number
    Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is 0 meaning disabled.
    monitors string[]
    List of monitor names to associate with the pool
    name string
    Name of the pool,it should be full path.The full path is the combination of the partition + name of the pool.(For example /Common/my-pool)
    reselectTries number
    Specifies the number of times the system tries to contact a new pool member after a passive failure.
    serviceDownAction string
    Specifies how the system should respond when the target pool member becomes unavailable. The default is None, Possible values: [none, reset, reselect, drop].
    slowRampTime number
    Specifies the duration during which the system sends less traffic to a newly-enabled pool member.
    allow_nat str
    Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default : yes, Possible Values yes or no].
    allow_snat str
    Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default : yes, Possible Values yes or no].
    description str
    Specifies descriptive text that identifies the pool.
    load_balancing_mode str
    Specifies the load balancing method. The default is Round Robin.
    minimum_active_members int
    Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is 0 meaning disabled.
    monitors Sequence[str]
    List of monitor names to associate with the pool
    name str
    Name of the pool,it should be full path.The full path is the combination of the partition + name of the pool.(For example /Common/my-pool)
    reselect_tries int
    Specifies the number of times the system tries to contact a new pool member after a passive failure.
    service_down_action str
    Specifies how the system should respond when the target pool member becomes unavailable. The default is None, Possible values: [none, reset, reselect, drop].
    slow_ramp_time int
    Specifies the duration during which the system sends less traffic to a newly-enabled pool member.
    allowNat String
    Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default : yes, Possible Values yes or no].
    allowSnat String
    Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default : yes, Possible Values yes or no].
    description String
    Specifies descriptive text that identifies the pool.
    loadBalancingMode String
    Specifies the load balancing method. The default is Round Robin.
    minimumActiveMembers Number
    Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is 0 meaning disabled.
    monitors List<String>
    List of monitor names to associate with the pool
    name String
    Name of the pool,it should be full path.The full path is the combination of the partition + name of the pool.(For example /Common/my-pool)
    reselectTries Number
    Specifies the number of times the system tries to contact a new pool member after a passive failure.
    serviceDownAction String
    Specifies how the system should respond when the target pool member becomes unavailable. The default is None, Possible values: [none, reset, reselect, drop].
    slowRampTime Number
    Specifies the duration during which the system sends less traffic to a newly-enabled pool member.

    Package Details

    Repository
    f5 BIG-IP pulumi/pulumi-f5bigip
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the bigip Terraform Provider.
    f5bigip logo
    f5 BIG-IP v3.16.0 published on Monday, Feb 19, 2024 by Pulumi