.. _envoy_v3_api_file_envoy/extensions/filter/udp/dns_filter/v3alpha/dns_filter.proto:

DNS Filter
==========

.. _extension_envoy.filters.udp_listener.dns_filter:


This extension may be referenced by the qualified name *envoy.filters.udp_listener.dns_filter*

.. note::
  This extension is functional but has not had substantial production burn time, use only with this caveat.

  This extension is intended to be robust against untrusted downstream traffic. It assumes that the upstream is trusted.

.. warning::
   This API is work-in-progress and is subject to breaking changes.

DNS Filter :ref:`configuration overview <config_udp_listener_filters_dns_filter>`.

.. _envoy_v3_api_msg_extensions.filter.udp.dns_filter.v3alpha.DnsFilterConfig:

extensions.filter.udp.dns_filter.v3alpha.DnsFilterConfig
--------------------------------------------------------

`[extensions.filter.udp.dns_filter.v3alpha.DnsFilterConfig proto] <https://github.com/envoyproxy/envoy/blob/v1.14.4/api/envoy/extensions/filter/udp/dns_filter/v3alpha/dns_filter.proto#L22>`_

Configuration for the DNS filter.

.. code-block:: json

  {
    "stat_prefix": "...",
    "server_config": "{...}"
  }

.. _envoy_v3_api_field_extensions.filter.udp.dns_filter.v3alpha.DnsFilterConfig.stat_prefix:

stat_prefix
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) The stat prefix used when emitting DNS filter statistics
  
  
.. _envoy_v3_api_field_extensions.filter.udp.dns_filter.v3alpha.DnsFilterConfig.server_config:

server_config
  (:ref:`extensions.filter.udp.dns_filter.v3alpha.DnsFilterConfig.ServerContextConfig <envoy_v3_api_msg_extensions.filter.udp.dns_filter.v3alpha.DnsFilterConfig.ServerContextConfig>`) Server context configuration
  
  
.. _envoy_v3_api_msg_extensions.filter.udp.dns_filter.v3alpha.DnsFilterConfig.ServerContextConfig:

extensions.filter.udp.dns_filter.v3alpha.DnsFilterConfig.ServerContextConfig
----------------------------------------------------------------------------

`[extensions.filter.udp.dns_filter.v3alpha.DnsFilterConfig.ServerContextConfig proto] <https://github.com/envoyproxy/envoy/blob/v1.14.4/api/envoy/extensions/filter/udp/dns_filter/v3alpha/dns_filter.proto#L29>`_

This message contains the configuration for the Dns Filter operating
in a server context. This message will contain the virtual hosts and
associated addresses with which Envoy will respond to queries

.. code-block:: json

  {
    "inline_dns_table": "{...}",
    "external_dns_table": "{...}"
  }

.. _envoy_v3_api_field_extensions.filter.udp.dns_filter.v3alpha.DnsFilterConfig.ServerContextConfig.inline_dns_table:

inline_dns_table
  (:ref:`data.dns.v3.DnsTable <envoy_v3_api_msg_data.dns.v3.DnsTable>`) Load the configuration specified from the control plane
  
  
  
  Precisely one of :ref:`inline_dns_table <envoy_v3_api_field_extensions.filter.udp.dns_filter.v3alpha.DnsFilterConfig.ServerContextConfig.inline_dns_table>`, :ref:`external_dns_table <envoy_v3_api_field_extensions.filter.udp.dns_filter.v3alpha.DnsFilterConfig.ServerContextConfig.external_dns_table>` must be set.
  
.. _envoy_v3_api_field_extensions.filter.udp.dns_filter.v3alpha.DnsFilterConfig.ServerContextConfig.external_dns_table:

external_dns_table
  (:ref:`config.core.v3.DataSource <envoy_v3_api_msg_config.core.v3.DataSource>`) Seed the filter configuration from an external path. This source
  is a yaml formatted file that contains the DnsTable driving Envoy's
  responses to DNS queries
  
  
  
  Precisely one of :ref:`inline_dns_table <envoy_v3_api_field_extensions.filter.udp.dns_filter.v3alpha.DnsFilterConfig.ServerContextConfig.inline_dns_table>`, :ref:`external_dns_table <envoy_v3_api_field_extensions.filter.udp.dns_filter.v3alpha.DnsFilterConfig.ServerContextConfig.external_dns_table>` must be set.