proxy_rule_groups

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

Overview

Name	proxy_rule_groups
Type	Resource
Id	aws.network_firewall.proxy_rule_groups

Fields

The following fields are returned by SELECT queries:

describe_proxy_rule_group

Name	Datatype	Description
proxy_rule_group	object	The configuration for the specified proxy rule group.
update_token	string	A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request. To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group 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 group 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>)

list_proxy_rule_groups

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of a proxy rule group. (pattern: <code>^arn:aws.*</code>)
name	string	The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it. (pattern: <code>^[a-zA-Z0-9-]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_proxy_rule_group	select	region		Returns the data objects for the specified proxy rule group.
list_proxy_rule_groups	select	region		Retrieves the metadata for the proxy rule groups that you have defined. Depending on your setting for max results and the number of proxy rule groups, a single call might not return the full list.
create_proxy_rule_group	insert	region, ProxyRuleGroupName		Creates an Network Firewall ProxyRuleGroup Collections of related proxy filtering rules. Rule groups help you manage and reuse sets of rules across multiple proxy configurations. To manage a proxy rule group's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource. To retrieve information about proxy rule groups, use ListProxyRuleGroups and DescribeProxyRuleGroup. To retrieve information about individual proxy rules, use DescribeProxyRuleGroup and DescribeProxyRule.
update_proxy_rule_group_priorities	update	region, RuleGroups, UpdateToken		Updates proxy rule group priorities within a proxy configuration.
delete_proxy_rule_group	delete	region		Deletes the specified 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_group

Returns the data objects for the specified proxy rule group.

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

list_proxy_rule_groups

Retrieves the metadata for the proxy rule groups that you have defined. Depending on your setting for max results and the number of proxy rule groups, a single call might not return the full list.

SELECT
arn,
name
FROM aws.network_firewall.proxy_rule_groups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_proxy_rule_group

Creates an Network Firewall ProxyRuleGroup Collections of related proxy filtering rules. Rule groups help you manage and reuse sets of rules across multiple proxy configurations. To manage a proxy rule group's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource. To retrieve information about proxy rule groups, use ListProxyRuleGroups and DescribeProxyRuleGroup. To retrieve information about individual proxy rules, use DescribeProxyRuleGroup and DescribeProxyRule.

INSERT INTO aws.network_firewall.proxy_rule_groups (
ProxyRuleGroupName,
Description,
Rules,
Tags,
region
)
SELECT 
'{{ ProxyRuleGroupName }}' /* required */,
'{{ Description }}',
'{{ Rules }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
proxy_rule_group,
update_token
;

Manifest

# Description fields are for documentation purposes
- name: proxy_rule_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the proxy_rule_groups resource.
  - 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.
  - name: Description
    value: "{{ Description }}"
    description: |
      A description of the proxy rule group.
  - 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 }}"
      PreREQUEST:
        - ProxyRuleName: "{{ ProxyRuleName }}"
          Description: "{{ Description }}"
          Action: "{{ Action }}"
          Conditions: "{{ Conditions }}"
      PostRESPONSE:
        - ProxyRuleName: "{{ ProxyRuleName }}"
          Description: "{{ Description }}"
          Action: "{{ Action }}"
          Conditions: "{{ Conditions }}"
  - name: Tags
    description: |
      The key:value pairs to associate with the resource.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_proxy_rule_group_priorities

Updates proxy rule group priorities within a proxy configuration.

UPDATE aws.network_firewall.proxy_rule_groups
SET 
ProxyConfigurationName = '{{ ProxyConfigurationName }}',
ProxyConfigurationArn = '{{ ProxyConfigurationArn }}',
RuleGroups = '{{ RuleGroups }}',
UpdateToken = '{{ UpdateToken }}'
WHERE 
region = '{{ region }}' --required
AND RuleGroups = '{{ RuleGroups }}' --required
AND UpdateToken = '{{ UpdateToken }}' --required
RETURNING
proxy_rule_groups,
update_token;

DELETE examples

delete_proxy_rule_group

Deletes the specified ProxyRuleGroup.

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