response_policy_rules

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

Overview

Name	response_policy_rules
Type	Resource
Id	google.dns.response_policy_rules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
behavior	string	Answer this query with a behavior rather than DNS data. (behaviorUnspecified, bypassResponsePolicy)
dnsName	string	The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
kind	string	(default: dns#responsePolicyRule)
localData	object	Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed. (id: ResponsePolicyRuleLocalData)
ruleName	string	An identifier for this rule. Must be unique with the ResponsePolicy.

list

Name	Datatype	Description
behavior	string	Answer this query with a behavior rather than DNS data. (behaviorUnspecified, bypassResponsePolicy)
dnsName	string	The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
kind	string	(default: dns#responsePolicyRule)
localData	object	Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed. (id: ResponsePolicyRuleLocalData)
ruleName	string	An identifier for this rule. Must be unique with the ResponsePolicy.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, responsePolicy, responsePolicyRule	clientOperationId	Fetches the representation of an existing Response Policy Rule.
list	select	project, responsePolicy	maxResults, pageToken	Enumerates all Response Policy Rules associated with a project.
create	insert	project, responsePolicy	clientOperationId	Creates a new Response Policy Rule.
patch	update	project, responsePolicy, responsePolicyRule	clientOperationId	Applies a partial update to an existing Response Policy Rule.
update	replace	project, responsePolicy, responsePolicyRule	clientOperationId	Updates an existing Response Policy Rule.
delete	delete	project, responsePolicy, responsePolicyRule	clientOperationId	Deletes a previously created Response Policy Rule.

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
project	string
responsePolicy	string
responsePolicyRule	string
clientOperationId	string
maxResults	integer (int32)
pageToken	string

SELECT examples

get

Fetches the representation of an existing Response Policy Rule.

SELECT
behavior,
dnsName,
kind,
localData,
ruleName
FROM google.dns.response_policy_rules
WHERE project = '{{ project }}' -- required
AND responsePolicy = '{{ responsePolicy }}' -- required
AND responsePolicyRule = '{{ responsePolicyRule }}' -- required
AND clientOperationId = '{{ clientOperationId }}'
;

list

Enumerates all Response Policy Rules associated with a project.

SELECT
behavior,
dnsName,
kind,
localData,
ruleName
FROM google.dns.response_policy_rules
WHERE project = '{{ project }}' -- required
AND responsePolicy = '{{ responsePolicy }}' -- required
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a new Response Policy Rule.

INSERT INTO google.dns.response_policy_rules (
data__behavior,
data__dnsName,
data__kind,
data__localData,
data__ruleName,
project,
responsePolicy,
clientOperationId
)
SELECT 
'{{ behavior }}',
'{{ dnsName }}',
'{{ kind }}',
'{{ localData }}',
'{{ ruleName }}',
'{{ project }}',
'{{ responsePolicy }}',
'{{ clientOperationId }}'
RETURNING
behavior,
dnsName,
kind,
localData,
ruleName
;

Manifest

# Description fields are for documentation purposes
- name: response_policy_rules
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the response_policy_rules resource.
  - name: responsePolicy
    value: "{{ responsePolicy }}"
    description: Required parameter for the response_policy_rules resource.
  - name: behavior
    value: "{{ behavior }}"
    description: |
      Answer this query with a behavior rather than DNS data.
    valid_values: ['behaviorUnspecified', 'bypassResponsePolicy']
  - name: dnsName
    value: "{{ dnsName }}"
    description: |
      The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
  - name: kind
    value: "{{ kind }}"
    default: dns#responsePolicyRule
  - name: localData
    description: |
      Answer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed.
    value:
      localDatas:
        - kind: "{{ kind }}"
          name: "{{ name }}"
          routingPolicy:
            geo:
              enableFencing: {{ enableFencing }}
              items:
                - healthCheckedTargets:
                    externalEndpoints: "{{ externalEndpoints }}"
                    internalLoadBalancers: "{{ internalLoadBalancers }}"
                  kind: "{{ kind }}"
                  location: "{{ location }}"
                  rrdatas: "{{ rrdatas }}"
                  signatureRrdatas: "{{ signatureRrdatas }}"
              kind: "{{ kind }}"
            healthCheck: "{{ healthCheck }}"
            kind: "{{ kind }}"
            primaryBackup:
              backupGeoTargets:
                enableFencing: {{ enableFencing }}
                items: "{{ items }}"
                kind: "{{ kind }}"
              kind: "{{ kind }}"
              primaryTargets:
                externalEndpoints: "{{ externalEndpoints }}"
                internalLoadBalancers: "{{ internalLoadBalancers }}"
              trickleTraffic: {{ trickleTraffic }}
            wrr:
              items:
                - healthCheckedTargets:
                    externalEndpoints: "{{ externalEndpoints }}"
                    internalLoadBalancers: "{{ internalLoadBalancers }}"
                  kind: "{{ kind }}"
                  rrdatas: "{{ rrdatas }}"
                  signatureRrdatas: "{{ signatureRrdatas }}"
                  weight: {{ weight }}
              kind: "{{ kind }}"
          rrdatas: "{{ rrdatas }}"
          signatureRrdatas: "{{ signatureRrdatas }}"
          ttl: {{ ttl }}
          type: "{{ type }}"
  - name: ruleName
    value: "{{ ruleName }}"
    description: |
      An identifier for this rule. Must be unique with the ResponsePolicy.
  - name: clientOperationId
    value: "{{ clientOperationId }}"

UPDATE examples

patch

Applies a partial update to an existing Response Policy Rule.

UPDATE google.dns.response_policy_rules
SET 
data__behavior = '{{ behavior }}',
data__dnsName = '{{ dnsName }}',
data__kind = '{{ kind }}',
data__localData = '{{ localData }}',
data__ruleName = '{{ ruleName }}'
WHERE 
project = '{{ project }}' --required
AND responsePolicy = '{{ responsePolicy }}' --required
AND responsePolicyRule = '{{ responsePolicyRule }}' --required
AND clientOperationId = '{{ clientOperationId}}'
RETURNING
responsePolicyRule;

REPLACE examples

update

Updates an existing Response Policy Rule.

REPLACE google.dns.response_policy_rules
SET 
data__behavior = '{{ behavior }}',
data__dnsName = '{{ dnsName }}',
data__kind = '{{ kind }}',
data__localData = '{{ localData }}',
data__ruleName = '{{ ruleName }}'
WHERE 
project = '{{ project }}' --required
AND responsePolicy = '{{ responsePolicy }}' --required
AND responsePolicyRule = '{{ responsePolicyRule }}' --required
AND clientOperationId = '{{ clientOperationId}}'
RETURNING
responsePolicyRule;

DELETE examples

delete

Deletes a previously created Response Policy Rule.

DELETE FROM google.dns.response_policy_rules
WHERE project = '{{ project }}' --required
AND responsePolicy = '{{ responsePolicy }}' --required
AND responsePolicyRule = '{{ responsePolicyRule }}' --required
AND clientOperationId = '{{ clientOperationId }}'
;