traffic_mirror_filter_rules

Creates, updates, deletes or gets a traffic_mirror_filter_rule resource or lists traffic_mirror_filter_rules in a region

Overview

Name	traffic_mirror_filter_rules
Type	Resource
Description	Resource Type definition for for AWS::EC2::TrafficMirrorFilterRule
Id	awscc.ec2.traffic_mirror_filter_rules

Fields

Name	Datatype	Description
▶destination_port_range	object	The destination port range.
description	string	The description of the Traffic Mirror Filter rule.
rule_action	string	The action to take on the filtered traffic (accept/reject).
source_cidr_block	string	The source CIDR block to assign to the Traffic Mirror Filter rule.
rule_number	integer	The number of the Traffic Mirror rule.
destination_cidr_block	string	The destination CIDR block to assign to the Traffic Mirror rule.
traffic_mirror_filter_rule_id	string	The ID of the Traffic Mirror Filter rule.
traffic_mirror_filter_id	string	The ID of the filter that this rule is associated with.
traffic_direction	string	The direction of traffic (ingress/egress).
protocol	integer	The number of protocol, for example 17 (UDP), to assign to the Traffic Mirror rule.
▶tags	array	Any tags assigned to the Traffic Mirror Filter rule.
region	string	AWS region.

For more information, see AWS::EC2::TrafficMirrorFilterRule.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	RuleAction, SourceCidrBlock, RuleNumber, DestinationCidrBlock, TrafficMirrorFilterId, TrafficDirection, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual traffic_mirror_filter_rule.

SELECT
region,
destination_port_range,
description,
source_port_range,
rule_action,
source_cidr_block,
rule_number,
destination_cidr_block,
traffic_mirror_filter_rule_id,
traffic_mirror_filter_id,
traffic_direction,
protocol,
tags
FROM awscc.ec2.traffic_mirror_filter_rules
WHERE region = 'us-east-1' AND data__Identifier = '<TrafficMirrorFilterRuleId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.traffic_mirror_filter_rules (
 RuleAction,
 SourceCidrBlock,
 RuleNumber,
 DestinationCidrBlock,
 TrafficMirrorFilterId,
 TrafficDirection,
 region
)
SELECT 
'{{ RuleAction }}',
 '{{ SourceCidrBlock }}',
 '{{ RuleNumber }}',
 '{{ DestinationCidrBlock }}',
 '{{ TrafficMirrorFilterId }}',
 '{{ TrafficDirection }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ec2.traffic_mirror_filter_rules (
 DestinationPortRange,
 Description,
 SourcePortRange,
 RuleAction,
 SourceCidrBlock,
 RuleNumber,
 DestinationCidrBlock,
 TrafficMirrorFilterId,
 TrafficDirection,
 Protocol,
 Tags,
 region
)
SELECT 
 '{{ DestinationPortRange }}',
 '{{ Description }}',
 '{{ SourcePortRange }}',
 '{{ RuleAction }}',
 '{{ SourceCidrBlock }}',
 '{{ RuleNumber }}',
 '{{ DestinationCidrBlock }}',
 '{{ TrafficMirrorFilterId }}',
 '{{ TrafficDirection }}',
 '{{ Protocol }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: traffic_mirror_filter_rule
    props:
      - name: DestinationPortRange
        value:
          FromPort: '{{ FromPort }}'
          ToPort: '{{ ToPort }}'
      - name: Description
        value: '{{ Description }}'
      - name: SourcePortRange
        value: null
      - name: RuleAction
        value: '{{ RuleAction }}'
      - name: SourceCidrBlock
        value: '{{ SourceCidrBlock }}'
      - name: RuleNumber
        value: '{{ RuleNumber }}'
      - name: DestinationCidrBlock
        value: '{{ DestinationCidrBlock }}'
      - name: TrafficMirrorFilterId
        value: '{{ TrafficMirrorFilterId }}'
      - name: TrafficDirection
        value: '{{ TrafficDirection }}'
      - name: Protocol
        value: '{{ Protocol }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.traffic_mirror_filter_rules
WHERE data__Identifier = '<TrafficMirrorFilterRuleId>'
AND region = 'us-east-1';

Permissions

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

Create

ec2:CreateTrafficMirrorFilterRule,
ec2:CreateTags,
ec2:DescribeTrafficMirrorFilterRules

Read

ec2:DescribeTrafficMirrorFilterRules

Update

ec2:ModifyTrafficMirrorFilterRule,
ec2:CreateTags,
ec2:DeleteTags

Delete

ec2:DeleteTrafficMirrorFilterRule

List

ec2:DescribeTrafficMirrorFilterRules