firewall_rule_groups

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

Overview

Name	firewall_rule_groups
Type	Resource
Id	aws.route53resolver.firewall_rule_groups

Fields

The following fields are returned by SELECT queries:

get_firewall_rule_group

Name	Datatype	Description
arn	string	The ARN (Amazon Resource Name) of the rule group.
creation_time	string	The date and time that the rule group was created, in Unix time format and Coordinated Universal Time (UTC).
creator_request_id	string	A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.
id	string	The ID of the rule group.
modification_time	string	The date and time that the rule group was last modified, in Unix time format and Coordinated Universal Time (UTC).
name	string	The name of the rule group. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_' ']+)</code>)
owner_id	string	The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you.
rule_count	integer	The number of rules in the rule group.
share_status	string	Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM). (NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME)
status	string	The status of the domain list. (COMPLETE, DELETING, UPDATING)
status_message	string	Additional information about the status of the rule group, if available.

list_firewall_rule_groups

Name	Datatype	Description
arn	string	The ARN (Amazon Resource Name) of the rule group.
creator_request_id	string	A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.
id	string	The ID of the rule group.
name	string	The name of the rule group. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_' ']+)</code>)
owner_id	string	The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you.
share_status	string	Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM). (NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_firewall_rule_group	select	region		Retrieves the specified firewall rule group.
list_firewall_rule_groups	select	region		Retrieves the minimal high-level information for the rule groups that you have defined. A single call might return only a partial list of the rule groups. For information, see MaxResults.
create_firewall_rule_group	insert	region, CreatorRequestId		Creates an empty DNS Firewall rule group for filtering DNS network traffic in a VPC. You can add rules to the new rule group by calling CreateFirewallRule.
associate_firewall_rule_group	update	region, CreatorRequestId, FirewallRuleGroupId, VpcId, Priority		Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC. If the rule group contains any rule configured with the PartnerThreatProtection rule type, the calling account must hold an active AWS Marketplace subscription to the named partner. If the subscription is missing, the association request is rejected.
disassociate_firewall_rule_group	update	region, FirewallRuleGroupAssociationId		Disassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the VPC.
delete_firewall_rule_group	delete	region		Deletes the specified firewall rule group.

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

get_firewall_rule_group

Retrieves the specified firewall rule group.

SELECT
arn,
creation_time,
creator_request_id,
id,
modification_time,
name,
owner_id,
rule_count,
share_status,
status,
status_message
FROM aws.route53resolver.firewall_rule_groups
WHERE region = '{{ region }}' -- required
;

list_firewall_rule_groups

Retrieves the minimal high-level information for the rule groups that you have defined. A single call might return only a partial list of the rule groups. For information, see MaxResults.

SELECT
arn,
creator_request_id,
id,
name,
owner_id,
share_status
FROM aws.route53resolver.firewall_rule_groups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_firewall_rule_group

Creates an empty DNS Firewall rule group for filtering DNS network traffic in a VPC. You can add rules to the new rule group by calling CreateFirewallRule.

INSERT INTO aws.route53resolver.firewall_rule_groups (
CreatorRequestId,
Name,
Tags,
region
)
SELECT 
'{{ CreatorRequestId }}' /* required */,
'{{ Name }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
firewall_rule_group
;

Manifest

# Description fields are for documentation purposes
- name: firewall_rule_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the firewall_rule_groups resource.
  - name: CreatorRequestId
    value: "{{ CreatorRequestId }}"
    description: |
      A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.
  - name: Name
    value: "{{ Name }}"
    description: |
      A name that lets you identify the rule group, to manage and use it.
  - name: Tags
    description: |
      A list of the tag keys and values that you want to associate with the rule group.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

associate_firewall_rule_group

Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC. If the rule group contains any rule configured with the PartnerThreatProtection rule type, the calling account must hold an active AWS Marketplace subscription to the named partner. If the subscription is missing, the association request is rejected.

UPDATE aws.route53resolver.firewall_rule_groups
SET 
CreatorRequestId = '{{ CreatorRequestId }}',
FirewallRuleGroupId = '{{ FirewallRuleGroupId }}',
VpcId = '{{ VpcId }}',
Priority = {{ Priority }},
Name = '{{ Name }}',
MutationProtection = '{{ MutationProtection }}',
Tags = '{{ Tags }}'
WHERE 
region = '{{ region }}' --required
AND CreatorRequestId = '{{ CreatorRequestId }}' --required
AND FirewallRuleGroupId = '{{ FirewallRuleGroupId }}' --required
AND VpcId = '{{ VpcId }}' --required
AND Priority = '{{ Priority }}' --required
RETURNING
firewall_rule_group_association;

disassociate_firewall_rule_group

Disassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the VPC.

UPDATE aws.route53resolver.firewall_rule_groups
SET 
FirewallRuleGroupAssociationId = '{{ FirewallRuleGroupAssociationId }}'
WHERE 
region = '{{ region }}' --required
AND FirewallRuleGroupAssociationId = '{{ FirewallRuleGroupAssociationId }}' --required
RETURNING
firewall_rule_group_association;

DELETE examples

delete_firewall_rule_group

Deletes the specified firewall rule group.

DELETE FROM aws.route53resolver.firewall_rule_groups
WHERE region = '{{ region }}' --required
;