firewall_policies

Creates, updates, deletes or gets a firewall_policy resource or lists firewall_policies in a region

Overview

Name	firewall_policies
Type	Resource
Description	Resource type definition for AWS::NetworkFirewall::FirewallPolicy
Id	aws.networkfirewall.firewall_policies

Fields

Name	Datatype	Description
firewall_policy_name	string
firewall_policy_arn	string	A resource ARN.
firewall_policy	object	Resource type definition for AWS::NetworkFirewall::FirewallPolicy
firewall_policy_id	string
description	string
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	FirewallPolicyName, FirewallPolicy, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all firewall_policies in a region.

SELECT
region,
firewall_policy_name,
firewall_policy_arn,
firewall_policy,
firewall_policy_id,
description,
tags
FROM aws.networkfirewall.firewall_policies
WHERE region = 'us-east-1';

Gets all properties from an individual firewall_policy.

SELECT
region,
firewall_policy_name,
firewall_policy_arn,
firewall_policy,
firewall_policy_id,
description,
tags
FROM aws.networkfirewall.firewall_policies
WHERE region = 'us-east-1' AND data__Identifier = '<FirewallPolicyArn>';

INSERT example

Use the following StackQL query and manifest file to create a new firewall_policy resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.networkfirewall.firewall_policies (
 FirewallPolicyName,
 FirewallPolicy,
 region
)
SELECT 
'{{ FirewallPolicyName }}',
 '{{ FirewallPolicy }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.networkfirewall.firewall_policies (
 FirewallPolicyName,
 FirewallPolicy,
 Description,
 Tags,
 region
)
SELECT 
 '{{ FirewallPolicyName }}',
 '{{ FirewallPolicy }}',
 '{{ Description }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: firewall_policy
    props:
      - name: FirewallPolicyName
        value: '{{ FirewallPolicyName }}'
      - name: FirewallPolicy
        value:
          FirewallPolicyName: '{{ FirewallPolicyName }}'
          FirewallPolicy: null
          Description: '{{ Description }}'
          Tags:
            - Key: '{{ Key }}'
              Value: '{{ Value }}'
      - name: Description
        value: '{{ Description }}'
      - name: Tags
        value:
          - null

DELETE example

/*+ delete */
DELETE FROM aws.networkfirewall.firewall_policies
WHERE data__Identifier = '<FirewallPolicyArn>'
AND region = 'us-east-1';

Permissions

To operate on the firewall_policies resource, the following permissions are required:

Create

network-firewall:CreateFirewallPolicy,
network-firewall:DescribeFirewallPolicy,
network-firewall:ListTLSInspectionConfigurations,
network-firewall:TagResource,
network-firewall:ListRuleGroups

Read

network-firewall:DescribeFirewallPolicy,
network-firewall:ListTagsForResources

Update

network-firewall:UpdateFirewallPolicy,
network-firewall:DescribeFirewallPolicy,
network-firewall:TagResource,
network-firewall:UntagResource,
network-firewall:ListRuleGroups,
network-firewall:ListTLSInspectionConfigurations

Delete

network-firewall:DeleteFirewallPolicy,
network-firewall:DescribeFirewallPolicy,
network-firewall:UntagResource

List

network-firewall:ListFirewallPolicies