proxy_rules

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

Overview

Name	proxy_rules
Type	Resource
Id	aws.network_firewall.proxy_rules

Fields

The following fields are returned by SELECT queries:

describe_proxy_rule

Name	Datatype	Description
proxy_rule	object	Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
update_token	string	A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request. To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token. (pattern: <code>^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_proxy_rule	select	region		Returns the data objects for the specified proxy configuration for the specified proxy rule group.
create_proxy_rules	insert	region		Creates Network Firewall ProxyRule resources. Attaches new proxy rule(s) to an existing proxy rule group. To retrieve information about individual proxy rules, use DescribeProxyRuleGroup and DescribeProxyRule.
update_proxy_rule	update	region, ProxyRuleName, UpdateToken		Updates the properties of the specified proxy rule.
update_proxy_rule_priorities	update	region, RuleGroupRequestPhase, UpdateToken		Updates proxy rule priorities within a proxy rule group.
delete_proxy_rules	delete	region		Deletes the specified ProxyRule(s). currently attached to a ProxyRuleGroup

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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_proxy_rule

Returns the data objects for the specified proxy configuration for the specified proxy rule group.

SELECT
proxy_rule,
update_token
FROM aws.network_firewall.proxy_rules
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_proxy_rules

Creates Network Firewall ProxyRule resources. Attaches new proxy rule(s) to an existing proxy rule group. To retrieve information about individual proxy rules, use DescribeProxyRuleGroup and DescribeProxyRule.

INSERT INTO aws.network_firewall.proxy_rules (
ProxyRuleGroupArn,
ProxyRuleGroupName,
Rules,
region
)
SELECT 
'{{ ProxyRuleGroupArn }}',
'{{ ProxyRuleGroupName }}',
'{{ Rules }}',
'{{ region }}'
RETURNING
proxy_rule_group,
update_token
;

Manifest

# Description fields are for documentation purposes
- name: proxy_rules
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the proxy_rules resource.
  - name: ProxyRuleGroupArn
    value: "{{ ProxyRuleGroupArn }}"
    description: |
      The Amazon Resource Name (ARN) of a proxy rule group. You must specify the ARN or the name, and you can specify both.
  - name: ProxyRuleGroupName
    value: "{{ ProxyRuleGroupName }}"
    description: |
      The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it. You must specify the ARN or the name, and you can specify both.
  - name: Rules
    description: |
      Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
    value:
      PreDNS:
        - ProxyRuleName: "{{ ProxyRuleName }}"
          Description: "{{ Description }}"
          Action: "{{ Action }}"
          Conditions: "{{ Conditions }}"
          InsertPosition: {{ InsertPosition }}
      PreREQUEST:
        - ProxyRuleName: "{{ ProxyRuleName }}"
          Description: "{{ Description }}"
          Action: "{{ Action }}"
          Conditions: "{{ Conditions }}"
          InsertPosition: {{ InsertPosition }}
      PostRESPONSE:
        - ProxyRuleName: "{{ ProxyRuleName }}"
          Description: "{{ Description }}"
          Action: "{{ Action }}"
          Conditions: "{{ Conditions }}"
          InsertPosition: {{ InsertPosition }}

UPDATE examples

update_proxy_rule

Updates the properties of the specified proxy rule.

UPDATE aws.network_firewall.proxy_rules
SET 
ProxyRuleGroupName = '{{ ProxyRuleGroupName }}',
ProxyRuleGroupArn = '{{ ProxyRuleGroupArn }}',
ProxyRuleName = '{{ ProxyRuleName }}',
Description = '{{ Description }}',
Action = '{{ Action }}',
AddConditions = '{{ AddConditions }}',
RemoveConditions = '{{ RemoveConditions }}',
UpdateToken = '{{ UpdateToken }}'
WHERE 
region = '{{ region }}' --required
AND ProxyRuleName = '{{ ProxyRuleName }}' --required
AND UpdateToken = '{{ UpdateToken }}' --required
RETURNING
proxy_rule,
removed_conditions,
update_token;

update_proxy_rule_priorities

Updates proxy rule priorities within a proxy rule group.

UPDATE aws.network_firewall.proxy_rules
SET 
ProxyRuleGroupName = '{{ ProxyRuleGroupName }}',
ProxyRuleGroupArn = '{{ ProxyRuleGroupArn }}',
RuleGroupRequestPhase = '{{ RuleGroupRequestPhase }}',
Rules = '{{ Rules }}',
UpdateToken = '{{ UpdateToken }}'
WHERE 
region = '{{ region }}' --required
AND RuleGroupRequestPhase = '{{ RuleGroupRequestPhase }}' --required
AND UpdateToken = '{{ UpdateToken }}' --required
RETURNING
proxy_rule_group_arn,
proxy_rule_group_name,
rule_group_request_phase,
rules,
update_token;

DELETE examples

delete_proxy_rules

Deletes the specified ProxyRule(s). currently attached to a ProxyRuleGroup

DELETE FROM aws.network_firewall.proxy_rules
WHERE region = '{{ region }}' --required
;