|
| 1 | +--- |
| 2 | +page_title: "cloudavenue_elb_pool Data Source - cloudavenue" |
| 3 | +subcategory: "ELB (EdgeGateway Load Balancer)" |
| 4 | +description: |- |
| 5 | + The cloudavenue_elb_pool data source allows you to retrieve information about an existing edgegateway load balancer pool. |
| 6 | +--- |
| 7 | + |
| 8 | +# cloudavenue_elb_pool (Data Source) |
| 9 | + |
| 10 | +The `cloudavenue_elb_pool` data source allows you to retrieve information about an existing edgegateway load balancer pool. |
| 11 | + |
| 12 | +## Example Usage |
| 13 | + |
| 14 | +```terraform |
| 15 | +data "cloudavenue_elb_pool" "example" { |
| 16 | + name = "example" |
| 17 | + edge_gateway_id = cloudavenue_edge_gateway.example.id |
| 18 | +} |
| 19 | +``` |
| 20 | + |
| 21 | +<!-- schema generated by tfplugindocs --> |
| 22 | +## Schema |
| 23 | + |
| 24 | +### Required |
| 25 | + |
| 26 | +- `name` (String) The name of the pool. |
| 27 | + |
| 28 | +### Optional |
| 29 | + |
| 30 | +- `edge_gateway_id` (String) The ID of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`. |
| 31 | +- `edge_gateway_name` (String) The name of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`. |
| 32 | + |
| 33 | +### Read-Only |
| 34 | + |
| 35 | +- `algorithm` (String) The heart of a load balancer is its ability to effectively distribute traffic across healthy servers. If persistence is enabled, only the first connection from a client is load balanced. While the persistence remains in effect, subsequent connections or requests from a client are directed to the same server. |
| 36 | +- `default_port` (Number) DefaultPort defines destination server port used by the traffic sent to the member. |
| 37 | +- `description` (String) The name of the pool. |
| 38 | +- `enabled` (Boolean) Enable or disable the pool. |
| 39 | +- `health` (Attributes) . (see [below for nested schema](#nestedatt--health)) |
| 40 | +- `id` (String) The ID of the pool. |
| 41 | +- `members` (Attributes) . (see [below for nested schema](#nestedatt--members)) |
| 42 | +- `persistence` (Attributes) . (see [below for nested schema](#nestedatt--persistence)) |
| 43 | +- `tls` (Attributes) . (see [below for nested schema](#nestedatt--tls)) |
| 44 | + |
| 45 | +<a id="nestedatt--health"></a> |
| 46 | +### Nested Schema for `health` |
| 47 | + |
| 48 | +Read-Only: |
| 49 | + |
| 50 | +- `monitors` (List of String) The active health monitors. |
| 51 | +- `passive_monitoring_enabled` (Boolean) PassiveMonitoringEnabled sets if client traffic should be used to check if pool member is up or down. |
| 52 | + |
| 53 | + |
| 54 | +<a id="nestedatt--members"></a> |
| 55 | +### Nested Schema for `members` |
| 56 | + |
| 57 | +Read-Only: |
| 58 | + |
| 59 | +- `graceful_timeout_period` (String) Maximum time (in minutes) to gracefully disable a member. Virtual service waits for the specified time before terminating the existing connections to the members that are disabled. Special values: `0` represents `Immediate` and `-1` represents `Infinite`. The maximum value is `7200` minutes. |
| 60 | +- `target_group` (String) The group contains reference to the Edge Firewall Group representing destination servers which are used by the Load Balancer Pool to direct load balanced traffic. This permit to reference `IP Set` or `Static Group` ID. |
| 61 | +- `targets` (Attributes List) targets field defines list of destination servers which are used by the Load Balancer Pool to direct load balanced traffic. (see [below for nested schema](#nestedatt--members--targets)) |
| 62 | + |
| 63 | +<a id="nestedatt--members--targets"></a> |
| 64 | +### Nested Schema for `members.targets` |
| 65 | + |
| 66 | +Read-Only: |
| 67 | + |
| 68 | +- `enabled` (Boolean) Enable or disable the member. |
| 69 | +- `ip_address` (String) The IP address of the member. |
| 70 | +- `port` (Number) The port of the member. |
| 71 | +- `ratio` (Number) The ratio of the member. The ratio of each pool member denotes the traffic that goes to each server pool member. A server with a ratio of 2 gets twice as much traffic as a server with a ratio of 1. |
| 72 | + |
| 73 | + |
| 74 | + |
| 75 | +<a id="nestedatt--persistence"></a> |
| 76 | +### Nested Schema for `persistence` |
| 77 | + |
| 78 | +Read-Only: |
| 79 | + |
| 80 | +- `type` (String) The type of the persistence. |
| 81 | +- `value` (String) The value of the persistence. |
| 82 | + |
| 83 | + |
| 84 | +<a id="nestedatt--tls"></a> |
| 85 | +### Nested Schema for `tls` |
| 86 | + |
| 87 | +Read-Only: |
| 88 | + |
| 89 | +- `ca_certificate_refs` (List of String) The CA certificate references point to root certificates to use when validating certificates presented by the pool members. |
| 90 | +- `common_name_check_enabled` (Boolean) Enable common name check for server certificate. If enabled and no explicit domain name is specified, the incoming host header will be used to do the match. |
| 91 | +- `domain_names` (List of String) The domain names of the TLS check. This attribute is taken into account if the `common_name_check_enabled` is set to `true`. |
| 92 | +- `enabled` (Boolean) Enable or disable the TLS. |
| 93 | + |
0 commit comments