@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

package/dist/docs/resources/dns_load_balancer.md

@@ -0,0 +1,254 @@
+---
+page_title: "f5xc_dns_load_balancer Resource - terraform-provider-f5xc"
+subcategory: "DNS"
+description: |-
+  [Category: Load Balancing] [Namespace: required] Manages DNS Load Balancer in a given namespace. If one already exist it will give a error. in F5 Distributed Cloud.
+---
+
+# f5xc_dns_load_balancer (Resource)
+
+[Category: Load Balancing] [Namespace: required] Manages DNS Load Balancer in a given namespace. If one already exist it will give a error. in F5 Distributed Cloud.
+
+~> **Note** Please refer to [DNS Load Balancer API docs](https://docs.cloud.f5.com/docs-v2/api/dns-load-balancer) to learn more.
+
+## Example Usage
+
+```terraform
+# DNS Load Balancer Resource Example
+# [Category: Load Balancing] [Namespace: required] Manages DNS Load Balancer in a given namespace. If one already exist it will give a error. in F5 Distributed Cloud.
+
+# Basic DNS Load Balancer configuration
+resource "f5xc_dns_load_balancer" "example" {
+  name      = "example-dns-load-balancer"
+  namespace = "staging"
+
+  labels = {
+    environment = "production"
+    managed_by  = "terraform"
+  }
+
+  annotations = {
+    "owner" = "platform-team"
+  }
+
+  # DNS Load Balancer configuration
+  record_type = "A"
+
+  # DNS zone reference
+  dns_zone {
+    name      = "example-dns-zone"
+    namespace = "staging"
+  }
+
+  # Rule-based load balancing
+  rule_list {
+    rules {
+      geo_location_set {
+        name      = "us-geo"
+        namespace = "shared"
+      }
+      pool {
+        name      = "us-pool"
+        namespace = "staging"
+      }
+      score = 100
+    }
+  }
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Argument Reference
+
+### Metadata Argument Reference
+
+<a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the DNS Load Balancer. Must be unique within the namespace
+
+<a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the DNS Load Balancer will be created
+
+<a id="annotations"></a>&#x2022; [`annotations`](#annotations) - Optional Map<br>Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata
+
+<a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Human readable description for the object
+
+<a id="disable"></a>&#x2022; [`disable`](#disable) - Optional Bool<br>A value of true will administratively disable the object
+
+<a id="labels"></a>&#x2022; [`labels`](#labels) - Optional Map<br>Labels is a user defined key value map that can be attached to resources for organization and filtering
+
+### Spec Argument Reference
+
+<a id="fallback-pool"></a>&#x2022; [`fallback_pool`](#fallback-pool) - Optional Block<br>Object reference. This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Fallback Pool](#fallback-pool) below for details.
+
+<a id="record-type"></a>&#x2022; [`record_type`](#record-type) - Optional String  Defaults to `A`<br>Possible values are `A`, `AAAA`, `MX`, `CNAME`, `SRV`<br>[Enum: A|AAAA|MX|CNAME|SRV] Resource Record Type. Resource Record Type - A: A - AAAA: AAAA - MX: MX - CNAME: CNAME - SRV: SRV
+
+<a id="response-cache"></a>&#x2022; [`response_cache`](#response-cache) - Optional Block<br>Response Cache. Response Cache<br>See [Response Cache](#response-cache) below for details.
+
+<a id="rule-list"></a>&#x2022; [`rule_list`](#rule-list) - Optional Block<br>Load Balancing Rule List. List of the Load Balancing Rules<br>See [Rule List](#rule-list) below for details.
+
+<a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
+
+### Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+<a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
+
+---
+
+#### Fallback Pool
+
+A [`fallback_pool`](#fallback-pool) block supports the following:
+
+<a id="fallback-pool-name"></a>&#x2022; [`name`](#fallback-pool-name) - Optional String<br>Name. When a configuration object(e.g. virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. route's) name
+
+<a id="fallback-pool-namespace"></a>&#x2022; [`namespace`](#fallback-pool-namespace) - Optional String<br>Namespace. When a configuration object(e.g. virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. route's) namespace
+
+<a id="fallback-pool-tenant"></a>&#x2022; [`tenant`](#fallback-pool-tenant) - Optional String<br>Tenant. When a configuration object(e.g. virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. route's) tenant
+
+#### Response Cache
+
+A [`response_cache`](#response-cache) block supports the following:
+
+<a id="response-cache-default-response-cache-parameters"></a>&#x2022; [`default_response_cache_parameters`](#response-cache-default-response-cache-parameters) - Optional Block<br>Enable this option
+
+<a id="response-cache-disable"></a>&#x2022; [`disable`](#response-cache-disable) - Optional Block<br>Enable this option
+
+<a id="response-cache-response-cache-parameters"></a>&#x2022; [`response_cache_parameters`](#response-cache-response-cache-parameters) - Optional Block<br>Response Cache Parameters<br>See [Response Cache Parameters](#response-cache-response-cache-parameters) below.
+
+#### Response Cache Response Cache Parameters
+
+A [`response_cache_parameters`](#response-cache-response-cache-parameters) block (within [`response_cache`](#response-cache)) supports the following:
+
+<a id="response-cache-response-cache-parameters-cache-cidr-ipv4"></a>&#x2022; [`cache_cidr_ipv4`](#response-cache-response-cache-parameters-cache-cidr-ipv4) - Optional Number<br>Length of IPv4 CIDR masks. Length of CIDR masks used to group IPv4 clients
+
+<a id="response-cache-response-cache-parameters-cache-cidr-ipv6"></a>&#x2022; [`cache_cidr_ipv6`](#response-cache-response-cache-parameters-cache-cidr-ipv6) - Optional Number<br>Length of IPv6 CIDR masks. Length of CIDR masks used to group IPv6 clients
+
+<a id="response-cache-response-cache-parameters-cache-ttl"></a>&#x2022; [`cache_ttl`](#response-cache-response-cache-parameters-cache-ttl) - Optional Number<br>TTL. TTL for response cache
+
+#### Rule List
+
+A [`rule_list`](#rule-list) block supports the following:
+
+<a id="rule-list-rules"></a>&#x2022; [`rules`](#rule-list-rules) - Optional Block<br>Load Balancing Rules. Rules to perform load balancing<br>See [Rules](#rule-list-rules) below.
+
+#### Rule List Rules
+
+A [`rules`](#rule-list-rules) block (within [`rule_list`](#rule-list)) supports the following:
+
+<a id="rule-list-rules-asn-list"></a>&#x2022; [`asn_list`](#rule-list-rules-asn-list) - Optional Block<br>ASN Match List. An unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer<br>See [Asn List](#rule-list-rules-asn-list) below.
+
+<a id="rule-list-rules-asn-matcher"></a>&#x2022; [`asn_matcher`](#rule-list-rules-asn-matcher) - Optional Block<br>ASN Matcher. Match any AS number contained in the list of bgp_asn_sets<br>See [Asn Matcher](#rule-list-rules-asn-matcher) below.
+
+<a id="rule-list-rules-geo-location-label-selector"></a>&#x2022; [`geo_location_label_selector`](#rule-list-rules-geo-location-label-selector) - Optional Block<br>Label Selector. This type can be used to establish a 'selector reference' from one object(called selector) to a set of other objects(called selectees) based on the value of expresssions. A label selector is a label query over a set of resources. An empty label selector matches all objects. A null label selector matches no objects. Label selector is immutable. expressions is a list of strings of label selection expression. Each string has ',' separated values which are 'AND' and all strings are logically 'OR'. BNF for expression string `<selector-syntax>` ::= `<requirement>` | `<requirement>` ',' `<selector-syntax>` `<requirement>` ::= [!] KEY [ `<set-based-restriction>` | `<exact-match-restriction>` ] `<set-based-restriction>` ::= '' | `<inclusion-exclusion>` `<value-set>` `<inclusion-exclusion>` ::= `<inclusion>` | `<exclusion>` `<exclusion>` ::= 'notin' `<inclusion>` ::= 'in' `<value-set>` ::= '(' `<values>` ')' `<values>` ::= VALUE | VALUE ',' `<values>` `<exact-match-restriction>` ::= ['='|'=='|'!='] VALUE<br>See [Geo Location Label Selector](#rule-list-rules-geo-location-label-selector) below.
+
+<a id="rule-list-rules-geo-location-set"></a>&#x2022; [`geo_location_set`](#rule-list-rules-geo-location-set) - Optional Block<br>Object reference. This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Geo Location Set](#rule-list-rules-geo-location-set) below.
+
+<a id="rule-list-rules-ip-prefix-list"></a>&#x2022; [`ip_prefix_list`](#rule-list-rules-ip-prefix-list) - Optional Block<br>IP Prefix Match List. List of IP Prefix strings to match against<br>See [IP Prefix List](#rule-list-rules-ip-prefix-list) below.
+
+<a id="rule-list-rules-ip-prefix-set"></a>&#x2022; [`ip_prefix_set`](#rule-list-rules-ip-prefix-set) - Optional Block<br>IP Prefix Matcher. Match any IP prefix contained in the list of ip_prefix_sets. The result of the match is inverted if invert_matcher is true<br>See [IP Prefix Set](#rule-list-rules-ip-prefix-set) below.
+
+<a id="rule-list-rules-pool"></a>&#x2022; [`pool`](#rule-list-rules-pool) - Optional Block<br>Object reference. This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Pool](#rule-list-rules-pool) below.
+
+<a id="rule-list-rules-score"></a>&#x2022; [`score`](#rule-list-rules-score) - Optional Number<br>Score. When multiple load balancing rules match a query, the one with the highest score is chosen
+
+#### Rule List Rules Asn List
+
+An [`asn_list`](#rule-list-rules-asn-list) block (within [`rule_list.rules`](#rule-list-rules)) supports the following:
+
+<a id="rule-list-rules-asn-list-as-numbers"></a>&#x2022; [`as_numbers`](#rule-list-rules-asn-list-as-numbers) - Optional List<br>AS Numbers. An unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer
+
+#### Rule List Rules Asn Matcher
+
+An [`asn_matcher`](#rule-list-rules-asn-matcher) block (within [`rule_list.rules`](#rule-list-rules)) supports the following:
+
+<a id="rule-list-rules-asn-matcher-asn-sets"></a>&#x2022; [`asn_sets`](#rule-list-rules-asn-matcher-asn-sets) - Optional Block<br>BGP ASN Sets. A list of references to bgp_asn_set objects<br>See [Asn Sets](#rule-list-rules-asn-matcher-asn-sets) below.
+
+#### Rule List Rules Asn Matcher Asn Sets
+
+An [`asn_sets`](#rule-list-rules-asn-matcher-asn-sets) block (within [`rule_list.rules.asn_matcher`](#rule-list-rules-asn-matcher)) supports the following:
+
+<a id="rule-list-rules-asn-matcher-asn-sets-kind"></a>&#x2022; [`kind`](#rule-list-rules-asn-matcher-asn-sets-kind) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
+
+<a id="rule-list-rules-asn-matcher-asn-sets-name"></a>&#x2022; [`name`](#rule-list-rules-asn-matcher-asn-sets-name) - Optional String<br>Name. When a configuration object(e.g. virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. route's) name
+
+<a id="rule-list-rules-asn-matcher-asn-sets-namespace"></a>&#x2022; [`namespace`](#rule-list-rules-asn-matcher-asn-sets-namespace) - Optional String<br>Namespace. When a configuration object(e.g. virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. route's) namespace
+
+<a id="rule-list-rules-asn-matcher-asn-sets-tenant"></a>&#x2022; [`tenant`](#rule-list-rules-asn-matcher-asn-sets-tenant) - Optional String<br>Tenant. When a configuration object(e.g. virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. route's) tenant
+
+<a id="rule-list-rules-asn-matcher-asn-sets-uid"></a>&#x2022; [`uid`](#rule-list-rules-asn-matcher-asn-sets-uid) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
+
+#### Rule List Rules Geo Location Label Selector
+
+A [`geo_location_label_selector`](#rule-list-rules-geo-location-label-selector) block (within [`rule_list.rules`](#rule-list-rules)) supports the following:
+
+<a id="rule-list-rules-geo-location-label-selector-expressions"></a>&#x2022; [`expressions`](#rule-list-rules-geo-location-label-selector-expressions) - Optional List<br>Selector Expression. expressions contains the kubernetes style label expression for selections
+
+#### Rule List Rules Geo Location Set
+
+A [`geo_location_set`](#rule-list-rules-geo-location-set) block (within [`rule_list.rules`](#rule-list-rules)) supports the following:
+
+<a id="rule-list-rules-geo-location-set-name"></a>&#x2022; [`name`](#rule-list-rules-geo-location-set-name) - Optional String<br>Name. When a configuration object(e.g. virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. route's) name
+
+<a id="rule-list-rules-geo-location-set-namespace"></a>&#x2022; [`namespace`](#rule-list-rules-geo-location-set-namespace) - Optional String<br>Namespace. When a configuration object(e.g. virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. route's) namespace
+
+<a id="rule-list-rules-geo-location-set-tenant"></a>&#x2022; [`tenant`](#rule-list-rules-geo-location-set-tenant) - Optional String<br>Tenant. When a configuration object(e.g. virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. route's) tenant
+
+#### Rule List Rules IP Prefix List
+
+An [`ip_prefix_list`](#rule-list-rules-ip-prefix-list) block (within [`rule_list.rules`](#rule-list-rules)) supports the following:
+
+<a id="rule-list-rules-ip-prefix-list-invert-match"></a>&#x2022; [`invert_match`](#rule-list-rules-ip-prefix-list-invert-match) - Optional Bool<br>Invert Match Result. Invert the match result
+
+<a id="rule-list-rules-ip-prefix-list-ip-prefixes"></a>&#x2022; [`ip_prefixes`](#rule-list-rules-ip-prefix-list-ip-prefixes) - Optional List<br>IPv4 Prefix List. List of IPv4 prefix strings
+
+#### Rule List Rules IP Prefix Set
+
+An [`ip_prefix_set`](#rule-list-rules-ip-prefix-set) block (within [`rule_list.rules`](#rule-list-rules)) supports the following:
+
+<a id="rule-list-rules-ip-prefix-set-invert-matcher"></a>&#x2022; [`invert_matcher`](#rule-list-rules-ip-prefix-set-invert-matcher) - Optional Bool<br>Invert IP Matcher. Invert the match result
+
+<a id="rule-list-rules-ip-prefix-set-prefix-sets"></a>&#x2022; [`prefix_sets`](#rule-list-rules-ip-prefix-set-prefix-sets) - Optional Block<br>IP Prefix Sets. A list of references to ip_prefix_set objects<br>See [Prefix Sets](#rule-list-rules-ip-prefix-set-prefix-sets) below.
+
+#### Rule List Rules IP Prefix Set Prefix Sets
+
+A [`prefix_sets`](#rule-list-rules-ip-prefix-set-prefix-sets) block (within [`rule_list.rules.ip_prefix_set`](#rule-list-rules-ip-prefix-set)) supports the following:
+
+<a id="rule-list-rules-ip-prefix-set-prefix-sets-kind"></a>&#x2022; [`kind`](#rule-list-rules-ip-prefix-set-prefix-sets-kind) - Optional String<br>Kind. When a configuration object(e.g. virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
+
+<a id="rule-list-rules-ip-prefix-set-prefix-sets-name"></a>&#x2022; [`name`](#rule-list-rules-ip-prefix-set-prefix-sets-name) - Optional String<br>Name. When a configuration object(e.g. virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. route's) name
+
+<a id="rule-list-rules-ip-prefix-set-prefix-sets-namespace"></a>&#x2022; [`namespace`](#rule-list-rules-ip-prefix-set-prefix-sets-namespace) - Optional String<br>Namespace. When a configuration object(e.g. virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. route's) namespace
+
+<a id="rule-list-rules-ip-prefix-set-prefix-sets-tenant"></a>&#x2022; [`tenant`](#rule-list-rules-ip-prefix-set-prefix-sets-tenant) - Optional String<br>Tenant. When a configuration object(e.g. virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. route's) tenant
+
+<a id="rule-list-rules-ip-prefix-set-prefix-sets-uid"></a>&#x2022; [`uid`](#rule-list-rules-ip-prefix-set-prefix-sets-uid) - Optional String<br>UID. When a configuration object(e.g. virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. route's) uid
+
+#### Rule List Rules Pool
+
+A [`pool`](#rule-list-rules-pool) block (within [`rule_list.rules`](#rule-list-rules)) supports the following:
+
+<a id="rule-list-rules-pool-name"></a>&#x2022; [`name`](#rule-list-rules-pool-name) - Optional String<br>Name. When a configuration object(e.g. virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. route's) name
+
+<a id="rule-list-rules-pool-namespace"></a>&#x2022; [`namespace`](#rule-list-rules-pool-namespace) - Optional String<br>Namespace. When a configuration object(e.g. virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. route's) namespace
+
+<a id="rule-list-rules-pool-tenant"></a>&#x2022; [`tenant`](#rule-list-rules-pool-tenant) - Optional String<br>Tenant. When a configuration object(e.g. virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. route's) tenant
+
+#### Timeouts
+
+A [`timeouts`](#timeouts) block supports the following:
+
+<a id="timeouts-create"></a>&#x2022; [`create`](#timeouts-create) - Optional String (Defaults to `10 minutes`)<br>Used when creating the resource
+
+<a id="timeouts-delete"></a>&#x2022; [`delete`](#timeouts-delete) - Optional String (Defaults to `10 minutes`)<br>Used when deleting the resource
+
+<a id="timeouts-read"></a>&#x2022; [`read`](#timeouts-read) - Optional String (Defaults to `5 minutes`)<br>Used when retrieving the resource
+
+<a id="timeouts-update"></a>&#x2022; [`update`](#timeouts-update) - Optional String (Defaults to `10 minutes`)<br>Used when updating the resource
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# Import using namespace/name format
+terraform import f5xc_dns_load_balancer.example system/example
+```