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	awscc.networkfirewall.firewall_policies

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
firewall_policy_arn	string	A resource ARN.
▶firewall_policy	object	Resource type definition for AWS::NetworkFirewall::FirewallPolicy
region	string	AWS region.

For more information, see AWS::NetworkFirewall::FirewallPolicy.

Methods

Name	Resource	Accessible by	Required Params
create_resource	firewall_policies	INSERT	FirewallPolicyName, FirewallPolicy, region
delete_resource	firewall_policies	DELETE	Identifier, region
update_resource	firewall_policies	UPDATE	Identifier, PatchDocument, region
list_resources	firewall_policies_list_only	SELECT	region
get_resource	firewall_policies	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual firewall_policy.

SELECT
  region,
  firewall_policy_name,
  firewall_policy_arn,
  firewall_policy,
  firewall_policy_id,
  description,
  tags
FROM awscc.networkfirewall.firewall_policies
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ firewall_policy_arn }}';

list (identifiers only)

Lists all firewall_policies in a region.

SELECT
  region,
  firewall_policy_arn
FROM awscc.networkfirewall.firewall_policies_list_only
WHERE
  region = 'us-east-1';

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 awscc.networkfirewall.firewall_policies (
  FirewallPolicyName,
  FirewallPolicy,
  region
)
SELECT
  '{{ firewall_policy_name }}',
  '{{ firewall_policy }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.networkfirewall.firewall_policies (
  FirewallPolicyName,
  FirewallPolicy,
  Description,
  Tags,
  region
)
SELECT
  '{{ firewall_policy_name }}',
  '{{ firewall_policy }}',
  '{{ 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: firewall_policy_name
        value: '{{ firewall_policy_name }}'
      - name: firewall_policy
        value:
          firewall_policy_name: '{{ firewall_policy_name }}'
          firewall_policy: null
          description: '{{ description }}'
          tags:
            - key: '{{ key }}'
              value: '{{ value }}'
      - name: description
        value: '{{ description }}'
      - name: tags
        value:
          - null

UPDATE example

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

/*+ update */
UPDATE awscc.networkfirewall.firewall_policies
SET PatchDocument = string('{{ {
    "FirewallPolicy": firewall_policy,
    "Description": description,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ firewall_policy_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.networkfirewall.firewall_policies
WHERE
  Identifier = '{{ firewall_policy_arn }}' 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