dns_forwarders

Creates, updates, deletes, gets or lists a dns_forwarders resource.

Overview

Name	dns_forwarders
Type	Resource
Id	confluent.networking.dns_forwarders

Fields

The following fields are returned by SELECT queries:

get_networking_v1_dns_forwarder

DNS Forwarder.

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space"). (example: dlz-f3a90de)
api_version	string	APIVersion defines the schema version of this representation of a resource. (networking/v1)
kind	string	Kind defines the object this REST resource represents. (DnsForwarder)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The desired state of the Dns Forwarder
status	object	The status of the Dns Forwarder

list_networking_v1_dns_forwarders

DNS Forwarder.

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space"). (example: dlz-f3a90de)
api_version	string	APIVersion defines the schema version of this representation of a resource. (networking/v1)
kind	string	Kind defines the object this REST resource represents. (DnsForwarder)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The desired state of the Dns Forwarder
status	object	The status of the Dns Forwarder

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_networking_v1_dns_forwarder	select	environment, id		Make a request to read a DNS forwarder.
list_networking_v1_dns_forwarders	select	environment	page_size, page_token	Retrieve a sorted, filtered, paginated list of all DNS forwarders.
create_networking_v1_dns_forwarder	insert	spec		Make a request to create a DNS forwarder.
update_networking_v1_dns_forwarder	update	id, spec		Make a request to update a DNS forwarder.
delete_networking_v1_dns_forwarder	delete	environment, id		Make a request to delete a DNS forwarder.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
environment	string	Scope the operation to the given environment. (example: env-00000)
id	string	The unique identifier for the DNS forwarder.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.

SELECT examples

get_networking_v1_dns_forwarder

Make a request to read a DNS forwarder.

SELECT
id,
api_version,
kind,
metadata,
spec,
status
FROM confluent.networking.dns_forwarders
WHERE environment = '{{ environment }}' -- required
AND id = '{{ id }}' -- required
;

list_networking_v1_dns_forwarders

Retrieve a sorted, filtered, paginated list of all DNS forwarders.

SELECT
id,
api_version,
kind,
metadata,
spec,
status
FROM confluent.networking.dns_forwarders
WHERE environment = '{{ environment }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_networking_v1_dns_forwarder

Make a request to create a DNS forwarder.

INSERT INTO confluent.networking.dns_forwarders (
spec
)
SELECT 
'{{ spec }}' /* required */
RETURNING
id,
api_version,
kind,
metadata,
spec,
status
;

Manifest

# Description fields are for documentation purposes
- name: dns_forwarders
props:
  - name: spec
    description: |
      The desired state of the Dns Forwarder
    value:
      display_name: "{{ display_name }}"
      domains:
        - "{{ domains }}"
      config:
        kind: "{{ kind }}"
        dns_server_ips:
          - "{{ dns_server_ips }}"
      environment:
        id: "{{ id }}"
        environment: "{{ environment }}"
        related: "{{ related }}"
        resource_name: "{{ resource_name }}"
        api_version: "{{ api_version }}"
        kind: "{{ kind }}"
      gateway:
        id: "{{ id }}"
        environment: "{{ environment }}"
        related: "{{ related }}"
        resource_name: "{{ resource_name }}"
        api_version: "{{ api_version }}"
        kind: "{{ kind }}"

UPDATE examples

update_networking_v1_dns_forwarder

Make a request to update a DNS forwarder.

UPDATE confluent.networking.dns_forwarders
SET 
spec = '{{ spec }}'
WHERE 
id = '{{ id }}' --required
AND spec = '{{ spec }}' --required
RETURNING
id,
api_version,
kind,
metadata,
spec,
status;

DELETE examples

delete_networking_v1_dns_forwarder

Make a request to delete a DNS forwarder.

DELETE FROM confluent.networking.dns_forwarders
WHERE environment = '{{ environment }}' --required
AND id = '{{ id }}' --required
;