firewall_rule_groups

Creates, updates, deletes or gets a firewall_rule_group resource or lists firewall_rule_groups in a region

Overview

Name	firewall_rule_groups
Type	Resource
Description	Resource schema for AWS::Route53Resolver::FirewallRuleGroup.
Id	awscc.route53resolver.firewall_rule_groups

Fields

get (all properties)

Name	Datatype	Description
id	string	ResourceId
arn	string	Arn
name	string	FirewallRuleGroupName
rule_count	integer	Count
status	string	ResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
status_message	string	FirewallRuleGroupStatus
owner_id	string	AccountId
share_status	string	ShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME.
creator_request_id	string	The id of the creator request.
creation_time	string	Rfc3339TimeString
modification_time	string	Rfc3339TimeString
▶firewall_rules	array	FirewallRules
▶tags	array	Tags
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string	ResourceId
region	string	AWS region.

For more information, see AWS::Route53Resolver::FirewallRuleGroup.

Methods

Name	Resource	Accessible by	Required Params
create_resource	firewall_rule_groups	INSERT	region
delete_resource	firewall_rule_groups	DELETE	Identifier, region
update_resource	firewall_rule_groups	UPDATE	Identifier, PatchDocument, region
list_resources	firewall_rule_groups_list_only	SELECT	region
get_resource	firewall_rule_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual firewall_rule_group.

SELECT
  region,
  id,
  arn,
  name,
  rule_count,
  status,
  status_message,
  owner_id,
  share_status,
  creator_request_id,
  creation_time,
  modification_time,
  firewall_rules,
  tags
FROM awscc.route53resolver.firewall_rule_groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all firewall_rule_groups in a region.

SELECT
  region,
  id
FROM awscc.route53resolver.firewall_rule_groups_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.route53resolver.firewall_rule_groups (
  Name,
  FirewallRules,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ firewall_rules }}',
  '{{ tags }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.route53resolver.firewall_rule_groups (
  Name,
  FirewallRules,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ firewall_rules }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: firewall_rule_group
    props:
      - name: name
        value: '{{ name }}'
      - name: firewall_rules
        value:
          - firewall_domain_list_id: '{{ firewall_domain_list_id }}'
            firewall_threat_protection_id: '{{ firewall_threat_protection_id }}'
            priority: '{{ priority }}'
            action: '{{ action }}'
            block_response: '{{ block_response }}'
            block_override_domain: '{{ block_override_domain }}'
            block_override_dns_type: '{{ block_override_dns_type }}'
            block_override_ttl: '{{ block_override_ttl }}'
            qtype: '{{ qtype }}'
            confidence_threshold: '{{ confidence_threshold }}'
            dns_threat_protection: '{{ dns_threat_protection }}'
            firewall_domain_redirection_action: '{{ firewall_domain_redirection_action }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.route53resolver.firewall_rule_groups
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.route53resolver.firewall_rule_groups
WHERE
  Identifier = '{{ id }}' AND
  region = 'us-east-1';

Permissions

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

Create

route53resolver:CreateFirewallRuleGroup,
route53resolver:GetFirewallRuleGroup,
route53resolver:ListFirewallRules,
route53resolver:CreateFirewallRule,
route53resolver:DeleteFirewallRule,
route53resolver:TagResource,
route53resolver:ListTagsForResource

Read

route53resolver:GetFirewallRuleGroup,
route53resolver:ListFirewallRules,
route53resolver:ListTagsForResource

List

route53resolver:ListFirewallRuleGroups,
route53resolver:ListTagsForResource

Delete

route53resolver:GetFirewallRuleGroup,
route53resolver:DeleteFirewallRuleGroup,
route53resolver:ListFirewallRules,
route53resolver:DeleteFirewallRule,
route53resolver:UntagResource,
route53resolver:ListTagsForResource

Update

route53resolver:GetFirewallRuleGroup,
route53resolver:ListFirewallRules,
route53resolver:CreateFirewallRule,
route53resolver:UpdateFirewallRule,
route53resolver:DeleteFirewallRule,
route53resolver:TagResource,
route53resolver:UntagResource,
route53resolver:ListTagsForResource