f5bigip.ltm.Pool
Explore with Pulumi AI
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
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],
});
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])
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", <m.MonitorArgs{
Name: pulumi.String("/Common/terraform_monitor"),
Parent: pulumi.String("/Common/http"),
})
if err != nil {
return err
}
_, err = ltm.NewPool(ctx, "pool", <m.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
})
}
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 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());
}
}
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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Pool(name: string, args: PoolArgs, opts?: CustomResourceOptions);
@overload
def Pool(resource_name: str,
args: PoolArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Pool(resource_name: str,
opts: Optional[ResourceOptions] = None,
name: Optional[str] = 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,
reselect_tries: Optional[int] = None,
service_down_action: Optional[str] = None,
slow_ramp_time: Optional[int] = None)
func NewPool(ctx *Context, name string, args PoolArgs, opts ...ResourceOption) (*Pool, error)
public Pool(string name, PoolArgs args, CustomResourceOptions? opts = null)
type: f5bigip:ltm:Pool
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 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var poolResource = new F5BigIP.Ltm.Pool("poolResource", new()
{
Name = "string",
AllowNat = "string",
AllowSnat = "string",
Description = "string",
LoadBalancingMode = "string",
MinimumActiveMembers = 0,
Monitors = new[]
{
"string",
},
ReselectTries = 0,
ServiceDownAction = "string",
SlowRampTime = 0,
});
example, err := ltm.NewPool(ctx, "poolResource", <m.PoolArgs{
Name: pulumi.String("string"),
AllowNat: pulumi.String("string"),
AllowSnat: pulumi.String("string"),
Description: pulumi.String("string"),
LoadBalancingMode: pulumi.String("string"),
MinimumActiveMembers: pulumi.Int(0),
Monitors: pulumi.StringArray{
pulumi.String("string"),
},
ReselectTries: pulumi.Int(0),
ServiceDownAction: pulumi.String("string"),
SlowRampTime: pulumi.Int(0),
})
var poolResource = new Pool("poolResource", PoolArgs.builder()
.name("string")
.allowNat("string")
.allowSnat("string")
.description("string")
.loadBalancingMode("string")
.minimumActiveMembers(0)
.monitors("string")
.reselectTries(0)
.serviceDownAction("string")
.slowRampTime(0)
.build());
pool_resource = f5bigip.ltm.Pool("poolResource",
name="string",
allow_nat="string",
allow_snat="string",
description="string",
load_balancing_mode="string",
minimum_active_members=0,
monitors=["string"],
reselect_tries=0,
service_down_action="string",
slow_ramp_time=0)
const poolResource = new f5bigip.ltm.Pool("poolResource", {
name: "string",
allowNat: "string",
allowSnat: "string",
description: "string",
loadBalancingMode: "string",
minimumActiveMembers: 0,
monitors: ["string"],
reselectTries: 0,
serviceDownAction: "string",
slowRampTime: 0,
});
type: f5bigip:ltm:Pool
properties:
allowNat: string
allowSnat: string
description: string
loadBalancingMode: string
minimumActiveMembers: 0
monitors:
- string
name: string
reselectTries: 0
serviceDownAction: string
slowRampTime: 0
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
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 thepartition + name
of the pool.(For example/Common/my-pool
) - Allow
Nat string - Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default :
yes
, Possible Valuesyes
orno
]. - Allow
Snat string - Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default :
yes
, Possible Valuesyes
orno
]. - Description string
- Specifies descriptive text that identifies the pool.
- Load
Balancing stringMode - Specifies the load balancing method. The default is Round Robin.
- Minimum
Active intMembers - Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is
0
meaningdisabled
. - Monitors List<string>
- 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 stringAction - 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 intTime - 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 thepartition + name
of the pool.(For example/Common/my-pool
) - Allow
Nat string - Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default :
yes
, Possible Valuesyes
orno
]. - Allow
Snat string - Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default :
yes
, Possible Valuesyes
orno
]. - Description string
- Specifies descriptive text that identifies the pool.
- Load
Balancing stringMode - Specifies the load balancing method. The default is Round Robin.
- Minimum
Active intMembers - Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is
0
meaningdisabled
. - Monitors []string
- 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 stringAction - 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 intTime - 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 thepartition + name
of the pool.(For example/Common/my-pool
) - allow
Nat String - Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default :
yes
, Possible Valuesyes
orno
]. - allow
Snat String - Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default :
yes
, Possible Valuesyes
orno
]. - description String
- Specifies descriptive text that identifies the pool.
- load
Balancing StringMode - Specifies the load balancing method. The default is Round Robin.
- minimum
Active IntegerMembers - Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is
0
meaningdisabled
. - monitors List<String>
- List of monitor names to associate with the pool
- reselect
Tries Integer - Specifies the number of times the system tries to contact a new pool member after a passive failure.
- service
Down StringAction - 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 IntegerTime - 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 thepartition + name
of the pool.(For example/Common/my-pool
) - allow
Nat string - Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default :
yes
, Possible Valuesyes
orno
]. - allow
Snat string - Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default :
yes
, Possible Valuesyes
orno
]. - description string
- Specifies descriptive text that identifies the pool.
- load
Balancing stringMode - Specifies the load balancing method. The default is Round Robin.
- minimum
Active numberMembers - Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is
0
meaningdisabled
. - monitors string[]
- List of monitor names to associate with the pool
- reselect
Tries number - Specifies the number of times the system tries to contact a new pool member after a passive failure.
- service
Down stringAction - 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 numberTime - 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 thepartition + 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 Valuesyes
orno
]. - allow_
snat str - Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default :
yes
, Possible Valuesyes
orno
]. - description str
- Specifies descriptive text that identifies the pool.
- load_
balancing_ strmode - Specifies the load balancing method. The default is Round Robin.
- minimum_
active_ intmembers - Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is
0
meaningdisabled
. - 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_ straction - 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_ inttime - 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 thepartition + name
of the pool.(For example/Common/my-pool
) - allow
Nat String - Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default :
yes
, Possible Valuesyes
orno
]. - allow
Snat String - Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default :
yes
, Possible Valuesyes
orno
]. - description String
- Specifies descriptive text that identifies the pool.
- load
Balancing StringMode - Specifies the load balancing method. The default is Round Robin.
- minimum
Active NumberMembers - Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is
0
meaningdisabled
. - monitors List<String>
- List of monitor names to associate with the pool
- reselect
Tries Number - Specifies the number of times the system tries to contact a new pool member after a passive failure.
- service
Down StringAction - 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 NumberTime - 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.
- Allow
Nat string - Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default :
yes
, Possible Valuesyes
orno
]. - Allow
Snat string - Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default :
yes
, Possible Valuesyes
orno
]. - Description string
- Specifies descriptive text that identifies the pool.
- Load
Balancing stringMode - Specifies the load balancing method. The default is Round Robin.
- Minimum
Active intMembers - Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is
0
meaningdisabled
. - 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 thepartition + 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 stringAction - 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 intTime - Specifies the duration during which the system sends less traffic to a newly-enabled pool member.
- Allow
Nat string - Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default :
yes
, Possible Valuesyes
orno
]. - Allow
Snat string - Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default :
yes
, Possible Valuesyes
orno
]. - Description string
- Specifies descriptive text that identifies the pool.
- Load
Balancing stringMode - Specifies the load balancing method. The default is Round Robin.
- Minimum
Active intMembers - Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is
0
meaningdisabled
. - 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 thepartition + 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 stringAction - 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 intTime - Specifies the duration during which the system sends less traffic to a newly-enabled pool member.
- allow
Nat String - Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default :
yes
, Possible Valuesyes
orno
]. - allow
Snat String - Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default :
yes
, Possible Valuesyes
orno
]. - description String
- Specifies descriptive text that identifies the pool.
- load
Balancing StringMode - Specifies the load balancing method. The default is Round Robin.
- minimum
Active IntegerMembers - Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is
0
meaningdisabled
. - 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 thepartition + name
of the pool.(For example/Common/my-pool
) - reselect
Tries Integer - Specifies the number of times the system tries to contact a new pool member after a passive failure.
- service
Down StringAction - 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 IntegerTime - Specifies the duration during which the system sends less traffic to a newly-enabled pool member.
- allow
Nat string - Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default :
yes
, Possible Valuesyes
orno
]. - allow
Snat string - Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default :
yes
, Possible Valuesyes
orno
]. - description string
- Specifies descriptive text that identifies the pool.
- load
Balancing stringMode - Specifies the load balancing method. The default is Round Robin.
- minimum
Active numberMembers - Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is
0
meaningdisabled
. - 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 thepartition + name
of the pool.(For example/Common/my-pool
) - reselect
Tries number - Specifies the number of times the system tries to contact a new pool member after a passive failure.
- service
Down stringAction - 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 numberTime - 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 Valuesyes
orno
]. - allow_
snat str - Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default :
yes
, Possible Valuesyes
orno
]. - description str
- Specifies descriptive text that identifies the pool.
- load_
balancing_ strmode - Specifies the load balancing method. The default is Round Robin.
- minimum_
active_ intmembers - Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is
0
meaningdisabled
. - 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 thepartition + 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_ straction - 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_ inttime - Specifies the duration during which the system sends less traffic to a newly-enabled pool member.
- allow
Nat String - Specifies whether NATs are automatically enabled or disabled for any connections using this pool, [ Default :
yes
, Possible Valuesyes
orno
]. - allow
Snat String - Specifies whether SNATs are automatically enabled or disabled for any connections using this pool,[ Default :
yes
, Possible Valuesyes
orno
]. - description String
- Specifies descriptive text that identifies the pool.
- load
Balancing StringMode - Specifies the load balancing method. The default is Round Robin.
- minimum
Active NumberMembers - Specifies whether the system load balances traffic according to the priority number assigned to the pool member,Default Value is
0
meaningdisabled
. - 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 thepartition + name
of the pool.(For example/Common/my-pool
) - reselect
Tries Number - Specifies the number of times the system tries to contact a new pool member after a passive failure.
- service
Down StringAction - 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 NumberTime - Specifies the duration during which the system sends less traffic to a newly-enabled pool member.
Import
ing
An existing pool can be imported into this resource by supplying pool Name in full path
as id
.
An example is below:
$ terraform import bigip_ltm_pool.k8s_prod_import /Common/k8prod_Pool
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- f5 BIG-IP pulumi/pulumi-f5bigip
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
bigip
Terraform Provider.