firewall_rule_group_associations

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

Overview

Name	firewall_rule_group_associations
Type	Resource
Id	aws.route53resolver.firewall_rule_group_associations

Fields

The following fields are returned by SELECT queries:

get_firewall_rule_group_association

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the firewall rule group association.
creation_time	string	The date and time that the association 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.
firewall_rule_group_id	string	The unique identifier of the firewall rule group.
id	string	The identifier for the association.
managed_owner_name	string	The owner of the association, used only for associations that are not managed by you. If you use Firewall Manager to manage your DNS Firewalls, then this reports Firewall Manager as the managed owner.
modification_time	string	The date and time that the association was last modified, in Unix time format and Coordinated Universal Time (UTC).
mutation_protection	string	If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections. (ENABLED, DISABLED)
name	string	The name of the association. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_' ']+)</code>)
priority	integer	The setting that determines the processing order of the rule group among the rule groups that are associated with a single VPC. DNS Firewall filters VPC traffic starting from rule group with the lowest numeric priority setting.
status	string	The current status of the association. (COMPLETE, DELETING, UPDATING)
status_message	string	Additional information about the status of the response, if available.
vpc_id	string	The unique identifier of the VPC that is associated with the rule group.

list_firewall_rule_group_associations

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the firewall rule group association.
creation_time	string	The date and time that the association 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.
firewall_rule_group_id	string	The unique identifier of the firewall rule group.
id	string	The identifier for the association.
managed_owner_name	string	The owner of the association, used only for associations that are not managed by you. If you use Firewall Manager to manage your DNS Firewalls, then this reports Firewall Manager as the managed owner.
modification_time	string	The date and time that the association was last modified, in Unix time format and Coordinated Universal Time (UTC).
mutation_protection	string	If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections. (ENABLED, DISABLED)
name	string	The name of the association. (pattern: <code>(?!^[0-9]+$)([a-zA-Z0-9-_' ']+)</code>)
priority	integer	The setting that determines the processing order of the rule group among the rule groups that are associated with a single VPC. DNS Firewall filters VPC traffic starting from rule group with the lowest numeric priority setting.
status	string	The current status of the association. (COMPLETE, DELETING, UPDATING)
status_message	string	Additional information about the status of the response, if available.
vpc_id	string	The unique identifier of the VPC that is associated with the rule group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_firewall_rule_group_association	select	region		Retrieves a firewall rule group association, which enables DNS filtering for a VPC with one rule group. A VPC can have more than one firewall rule group association, and a rule group can be associated with more than one VPC.
list_firewall_rule_group_associations	select	region		Retrieves the firewall rule group associations that you have defined. Each association enables DNS filtering for a VPC with one rule group. A single call might return only a partial list of the associations. For information, see MaxResults.
update_firewall_rule_group_association	update	region, FirewallRuleGroupAssociationId		Changes the association of a FirewallRuleGroup with a VPC. The association enables DNS filtering for the VPC.

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_association

Retrieves a firewall rule group association, which enables DNS filtering for a VPC with one rule group. A VPC can have more than one firewall rule group association, and a rule group can be associated with more than one VPC.

SELECT
arn,
creation_time,
creator_request_id,
firewall_rule_group_id,
id,
managed_owner_name,
modification_time,
mutation_protection,
name,
priority,
status,
status_message,
vpc_id
FROM aws.route53resolver.firewall_rule_group_associations
WHERE region = '{{ region }}' -- required
;

list_firewall_rule_group_associations

Retrieves the firewall rule group associations that you have defined. Each association enables DNS filtering for a VPC with one rule group. A single call might return only a partial list of the associations. For information, see MaxResults.

SELECT
arn,
creation_time,
creator_request_id,
firewall_rule_group_id,
id,
managed_owner_name,
modification_time,
mutation_protection,
name,
priority,
status,
status_message,
vpc_id
FROM aws.route53resolver.firewall_rule_group_associations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_firewall_rule_group_association

Changes the association of a FirewallRuleGroup with a VPC. The association enables DNS filtering for the VPC.

UPDATE aws.route53resolver.firewall_rule_group_associations
SET 
FirewallRuleGroupAssociationId = '{{ FirewallRuleGroupAssociationId }}',
Priority = {{ Priority }},
MutationProtection = '{{ MutationProtection }}',
Name = '{{ Name }}'
WHERE 
region = '{{ region }}' --required
AND FirewallRuleGroupAssociationId = '{{ FirewallRuleGroupAssociationId }}' --required
RETURNING
firewall_rule_group_association;