firewall_rule_group_associations

Creates, updates, deletes or gets a firewall_rule_group_association resource or lists firewall_rule_group_associations in a region

Overview

Name	firewall_rule_group_associations
Type	Resource
Description	Resource schema for AWS::Route53Resolver::FirewallRuleGroupAssociation.
Id	awscc.route53resolver.firewall_rule_group_associations

Fields

get (all properties)

Name	Datatype	Description
id	string	Id
arn	string	Arn
firewall_rule_group_id	string	FirewallRuleGroupId
vpc_id	string	VpcId
name	string	FirewallRuleGroupAssociationName
priority	integer	Priority
mutation_protection	string	MutationProtectionStatus
managed_owner_name	string	ServicePrincipal
status	string	ResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED.
status_message	string	FirewallDomainListAssociationStatus
creator_request_id	string	The id of the creator request.
creation_time	string	Rfc3339TimeString
modification_time	string	Rfc3339TimeString
▶tags	array	Tags
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string	Id
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	firewall_rule_group_associations	INSERT	FirewallRuleGroupId, VpcId, Priority, region
delete_resource	firewall_rule_group_associations	DELETE	Identifier, region
update_resource	firewall_rule_group_associations	UPDATE	Identifier, PatchDocument, region
list_resources	firewall_rule_group_associations_list_only	SELECT	region
get_resource	firewall_rule_group_associations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual firewall_rule_group_association.

SELECT
  region,
  id,
  arn,
  firewall_rule_group_id,
  vpc_id,
  name,
  priority,
  mutation_protection,
  managed_owner_name,
  status,
  status_message,
  creator_request_id,
  creation_time,
  modification_time,
  tags
FROM awscc.route53resolver.firewall_rule_group_associations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all firewall_rule_group_associations in a region.

SELECT
  region,
  id
FROM awscc.route53resolver.firewall_rule_group_associations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.route53resolver.firewall_rule_group_associations (
  FirewallRuleGroupId,
  VpcId,
  Priority,
  region
)
SELECT
  '{{ firewall_rule_group_id }}',
  '{{ vpc_id }}',
  '{{ priority }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.route53resolver.firewall_rule_group_associations (
  FirewallRuleGroupId,
  VpcId,
  Name,
  Priority,
  MutationProtection,
  Tags,
  region
)
SELECT
  '{{ firewall_rule_group_id }}',
  '{{ vpc_id }}',
  '{{ name }}',
  '{{ priority }}',
  '{{ mutation_protection }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: firewall_rule_group_association
  props:
    - name: firewall_rule_group_id
      value: '{{ firewall_rule_group_id }}'
    - name: vpc_id
      value: '{{ vpc_id }}'
    - name: name
      value: '{{ name }}'
    - name: priority
      value: '{{ priority }}'
    - name: mutation_protection
      value: '{{ mutation_protection }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.route53resolver.firewall_rule_group_associations
SET PatchDocument = string('{{ {
    "Name": name,
    "Priority": priority,
    "MutationProtection": mutation_protection,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.route53resolver.firewall_rule_group_associations
WHERE
  Identifier = '{{ id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

route53resolver:AssociateFirewallRuleGroup,
route53resolver:GetFirewallRuleGroupAssociation,
route53resolver:TagResource,
route53resolver:ListTagsForResource,
ec2:DescribeVpcs

Read

route53resolver:GetFirewallRuleGroupAssociation,
route53resolver:ListTagsForResource

List

route53resolver:ListFirewallRuleGroupAssociations,
route53resolver:ListTagsForResource

Delete

route53resolver:DisassociateFirewallRuleGroup,
route53resolver:GetFirewallRuleGroupAssociation,
route53resolver:UntagResource,
route53resolver:ListTagsForResource

Update

route53resolver:UpdateFirewallRuleGroupAssociation,
route53resolver:GetFirewallRuleGroupAssociation,
route53resolver:TagResource,
route53resolver:UntagResource,
route53resolver:ListTagsForResource