xcsh_dns_load_balancer (Data Source)

Retrieves information about DNS Load Balancer in a given namespace. If one already exist it will give a error in F5 Distributed Cloud. This is a read-only data source.

~> Note: For more information, see the DNS Load Balancer API documentation.

Example Usage

# DNSLoadBalancer Data Source Example

terraform {
  required_version = ">= 1.0"

  required_providers {
    xcsh = {
      source  = "f5-sales-demo/xcsh"
      version = ">= 0.1.0"
    }
  }
}

# Look up an existing DNSLoadBalancer by name
data "xcsh_dns_load_balancer" "example" {
  name      = "example-dns-load-balancer"
  namespace = "system"
}

output "dns_load_balancer_id" {
  value = data.xcsh_dns_load_balancer.example.id
}

Argument Reference

-> Syntax Rule: This provider uses OneOf groups for mutually exclusive options. Fields documented as “Optional Block” use block syntax field_name { ... }. Empty OneOf object attributes use field_name = {}; conditional selection uses condition ? {} : null. Boolean attributes (such as add_hsts and http_redirect) use = true or = false.

🔶 High Risk Operations — Some operations on this resource have high danger level. Destructive operations may require confirmation.

~> Dependencies — This resource requires: dns_zone.

Metadata Argument Reference

• name - Required String
Name of the DNSLoadBalancer

• namespace - Optional String
Namespace where the DNSLoadBalancer exists

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• annotations - Optional Map
Annotations applied to this resource

• description - Optional String
Description of the DNSLoadBalancer

• fallback_pool - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• id - Optional String
Unique identifier for the resource

• labels - Optional Map
Labels applied to this resource

• record_type - Optional String Defaults to A
Possible values are A, AAAA, MX, CNAME, SRV
[Enum: A|AAAA|MX|CNAME|SRV] Resource Record Type - A: A - AAAA: AAAA - MX: MX - CNAME: CNAME - SRV: SRV

• response_cache - Optional String
Configuration parameter for response cache

• rule_list - Optional String
Load Balancing Rule List. List of the Load Balancing Rules

• name - Optional String
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

• namespace - Optional String
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

• tenant - Optional String
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

• default_response_cache_parameters - Optional Object
Configuration parameter for default response cache parameters

• disable_spec - Optional Object
Enable this option

• response_cache_parameters - Optional String
Configuration parameter for response cache parameters

• cache_cidr_ipv4 - Optional Number
Length of CIDR masks used to group IPv4 clients

• cache_cidr_ipv6 - Optional Number
Length of CIDR masks used to group IPv6 clients

• cache_ttl - Optional Number
TTL. TTL for response cache

• rules - Optional List
Load Balancing Rules. Rules to perform load balancing

• asn_list - Optional String
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

• asn_matcher - Optional String
Match any AS number contained in the list of bgp_asn_sets

• geo_location_label_selector - Optional String
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 expressions. A label selector is a label query over a set of resources. An empty label selector matches all objects

• geo_location_set - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• ip_prefix_list - Optional String
List of IP Prefix strings to match against

• ip_prefix_set - Optional String
Match any IP prefix contained in the list of ip_prefix_sets. The result of the match is inverted if invert_matcher is true

• pool - Optional String
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name

• score - Optional Number
When multiple load balancing rules match a query, the one with the highest score is chosen

• as_numbers - Optional List
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

• asn_sets - Optional List
List of references to bgp_asn_set objects

• kind - Optional String
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’)

• name - Optional String
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

• namespace - Optional String
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

• tenant - Optional String
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

• uid - Optional String
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

• expressions - Optional List
Expressions contains the Kubernetes style label expression for selections

• name - Optional String
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

• namespace - Optional String
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

• tenant - Optional String
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

• invert_match - Optional Bool
Invert Match Result. Invert the match result

• ip_prefixes - Optional List
IPv4 Prefix List. List of IPv4 prefix strings

• invert_matcher - Optional Bool
Invert IP Matcher. Invert the match result

• prefix_sets - Optional List
List of references to ip_prefix_set objects