proxies

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

Overview

Name	proxies
Type	Resource
Id	aws.network_firewall.proxies

Fields

The following fields are returned by SELECT queries:

describe_proxy

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

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of a proxy. (pattern: <code>^arn:aws.*</code>)
name	string	The descriptive name of the proxy. You can't change the name of a proxy 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	select	region		Returns the data objects for the specified proxy.
list_proxies	select	region		Retrieves the metadata for the proxies that you have defined. Depending on your setting for max results and the number of proxies, a single call might not return the full list.
create_proxy	insert	region, ProxyName, NatGatewayId, TlsInterceptProperties		Creates an Network Firewall Proxy Attaches a Proxy configuration to a NAT Gateway. To manage a proxy's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource. To retrieve information about proxies, use ListProxies and DescribeProxy.
update_proxy	update	region, NatGatewayId, UpdateToken		Updates the properties of the specified proxy.
update_proxy_settings	update	region		Modifies the proxy listener configuration of a proxy mode firewall. Proxy mode firewalls are created with NoSourcePreservation set to TRUE. Use this operation to change the ports and protocols on which the firewall's proxy listens for traffic.
delete_proxy	delete	region		Deletes the specified Proxy. Detaches a Proxy configuration from a NAT Gateway.

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

Returns the data objects for the specified proxy.

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

list_proxies

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

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

INSERT examples

create_proxy

Creates an Network Firewall Proxy Attaches a Proxy configuration to a NAT Gateway. To manage a proxy's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource. To retrieve information about proxies, use ListProxies and DescribeProxy.

INSERT INTO aws.network_firewall.proxies (
ProxyName,
NatGatewayId,
ProxyConfigurationName,
ProxyConfigurationArn,
ListenerProperties,
TlsInterceptProperties,
Tags,
region
)
SELECT 
'{{ ProxyName }}' /* required */,
'{{ NatGatewayId }}' /* required */,
'{{ ProxyConfigurationName }}',
'{{ ProxyConfigurationArn }}',
'{{ ListenerProperties }}',
'{{ TlsInterceptProperties }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
proxy,
update_token
;

Manifest

# Description fields are for documentation purposes
- name: proxies
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the proxies resource.
  - name: ProxyName
    value: "{{ ProxyName }}"
    description: |
      The descriptive name of the proxy. You can't change the name of a proxy after you create it.
  - name: NatGatewayId
    value: "{{ NatGatewayId }}"
    description: |
      A unique identifier for the NAT gateway to use with proxy resources.
  - 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. You must specify the ARN or the name, and you can specify both.
  - name: ProxyConfigurationArn
    value: "{{ ProxyConfigurationArn }}"
    description: |
      The Amazon Resource Name (ARN) of a proxy configuration. You must specify the ARN or the name, and you can specify both.
  - name: ListenerProperties
    description: |
      Listener properties for HTTP and HTTPS traffic.
    value:
      - Port: {{ Port }}
        Type: "{{ Type }}"
  - name: TlsInterceptProperties
    description: |
      TLS decryption on traffic to filter on attributes in the HTTP header.
    value:
      PcaArn: "{{ PcaArn }}"
      TlsInterceptMode: "{{ TlsInterceptMode }}"
  - name: Tags
    description: |
      The key:value pairs to associate with the resource.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_proxy

Updates the properties of the specified proxy.

UPDATE aws.network_firewall.proxies
SET 
NatGatewayId = '{{ NatGatewayId }}',
ProxyName = '{{ ProxyName }}',
ProxyArn = '{{ ProxyArn }}',
ListenerPropertiesToAdd = '{{ ListenerPropertiesToAdd }}',
ListenerPropertiesToRemove = '{{ ListenerPropertiesToRemove }}',
TlsInterceptProperties = '{{ TlsInterceptProperties }}',
UpdateToken = '{{ UpdateToken }}'
WHERE 
region = '{{ region }}' --required
AND NatGatewayId = '{{ NatGatewayId }}' --required
AND UpdateToken = '{{ UpdateToken }}' --required
RETURNING
proxy,
update_token;

update_proxy_settings

Modifies the proxy listener configuration of a proxy mode firewall. Proxy mode firewalls are created with NoSourcePreservation set to TRUE. Use this operation to change the ports and protocols on which the firewall's proxy listens for traffic.

UPDATE aws.network_firewall.proxies
SET 
FirewallArn = '{{ FirewallArn }}',
FirewallName = '{{ FirewallName }}',
UpdateToken = '{{ UpdateToken }}',
ProxySettings = '{{ ProxySettings }}'
WHERE 
region = '{{ region }}' --required
RETURNING
firewall_arn,
firewall_name,
proxy_settings,
update_token;

DELETE examples

delete_proxy

Deletes the specified Proxy. Detaches a Proxy configuration from a NAT Gateway.

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