proxy_configurations

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

Overview

Name	proxy_configurations
Type	Resource
Id	aws.network_firewall.proxy_configurations

Fields

The following fields are returned by SELECT queries:

describe_proxy_configuration

Name	Datatype	Description
proxy_configuration	object	The configuration for the specified proxy configuration.
update_token	string	A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request. To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration 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_configurations

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of a proxy configuration. (pattern: <code>^arn:aws.*</code>)
name	string	The descriptive name of the proxy configuration. You can't change the name of a proxy configuration 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_configuration	select	region		Returns the data objects for the specified proxy configuration.
list_proxy_configurations	select	region		Retrieves the metadata for the proxy configuration that you have defined. Depending on your setting for max results and the number of proxy configurations, a single call might not return the full list.
create_proxy_configuration	insert	region, ProxyConfigurationName, DefaultRulePhaseActions		Creates an Network Firewall ProxyConfiguration A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration. To manage a proxy configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource. To retrieve information about proxies, use ListProxyConfigurations and DescribeProxyConfiguration.
attach_rule_groups_to_proxy_configuration	update	region, RuleGroups, UpdateToken		Attaches ProxyRuleGroup resources to a ProxyConfiguration A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.
update_proxy_configuration	update	region, DefaultRulePhaseActions, UpdateToken		Updates the properties of the specified proxy configuration.
detach_rule_groups_from_proxy_configuration	update	region, UpdateToken		Detaches ProxyRuleGroup resources from a ProxyConfiguration A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.
delete_proxy_configuration	delete	region		Deletes the specified ProxyConfiguration.

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_configuration

Returns the data objects for the specified proxy configuration.

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

list_proxy_configurations

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

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

INSERT examples

create_proxy_configuration

Creates an Network Firewall ProxyConfiguration A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration. To manage a proxy configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource. To retrieve information about proxies, use ListProxyConfigurations and DescribeProxyConfiguration.

INSERT INTO aws.network_firewall.proxy_configurations (
ProxyConfigurationName,
Description,
RuleGroupNames,
RuleGroupArns,
DefaultRulePhaseActions,
Tags,
region
)
SELECT 
'{{ ProxyConfigurationName }}' /* required */,
'{{ Description }}',
'{{ RuleGroupNames }}',
'{{ RuleGroupArns }}',
'{{ DefaultRulePhaseActions }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
proxy_configuration,
update_token
;

Manifest

# Description fields are for documentation purposes
- name: proxy_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the proxy_configurations resource.
  - name: ProxyConfigurationName
    value: "{{ ProxyConfigurationName }}"
    description: |
      The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.
  - name: Description
    value: "{{ Description }}"
    description: |
      A description of the proxy configuration.
  - name: RuleGroupNames
    value:
      - "{{ RuleGroupNames }}"
    description: |
      The proxy rule group name(s) to attach to the proxy configuration. You must specify the ARNs or the names, and you can specify both.
  - name: RuleGroupArns
    value:
      - "{{ RuleGroupArns }}"
    description: |
      The proxy rule group arn(s) to attach to the proxy configuration. You must specify the ARNs or the names, and you can specify both.
  - name: DefaultRulePhaseActions
    description: |
      Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.
    value:
      PreDNS: "{{ PreDNS }}"
      PreREQUEST: "{{ PreREQUEST }}"
      PostRESPONSE: "{{ PostRESPONSE }}"
  - name: Tags
    description: |
      The key:value pairs to associate with the resource.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

attach_rule_groups_to_proxy_configuration

Attaches ProxyRuleGroup resources to a ProxyConfiguration A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.

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

update_proxy_configuration

Updates the properties of the specified proxy configuration.

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

detach_rule_groups_from_proxy_configuration

Detaches ProxyRuleGroup resources from a ProxyConfiguration A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.

UPDATE aws.network_firewall.proxy_configurations
SET 
ProxyConfigurationName = '{{ ProxyConfigurationName }}',
ProxyConfigurationArn = '{{ ProxyConfigurationArn }}',
RuleGroupNames = '{{ RuleGroupNames }}',
RuleGroupArns = '{{ RuleGroupArns }}',
UpdateToken = '{{ UpdateToken }}'
WHERE 
region = '{{ region }}' --required
AND UpdateToken = '{{ UpdateToken }}' --required
RETURNING
proxy_configuration,
update_token;

DELETE examples

delete_proxy_configuration

Deletes the specified ProxyConfiguration.

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