traffic_mirror_sessions

Creates, updates, deletes or gets a traffic_mirror_session resource or lists traffic_mirror_sessions in a region

Overview

Name	traffic_mirror_sessions
Type	Resource
Description	Resource schema for AWS::EC2::TrafficMirrorSession
Id	awscc.ec2.traffic_mirror_sessions

Fields

Name	Datatype	Description
id	string	The ID of a Traffic Mirror session.
network_interface_id	string	The ID of the source network interface.
traffic_mirror_target_id	string	The ID of a Traffic Mirror target.
traffic_mirror_filter_id	string	The ID of a Traffic Mirror filter.
packet_length	integer	The number of bytes in each packet to mirror.
session_number	integer	The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
virtual_network_id	integer	The VXLAN ID for the Traffic Mirror session.
description	string	The description of the Traffic Mirror session.
owner_id	string	The ID of the account that owns the Traffic Mirror session.
▶tags	array	The tags assigned to the Traffic Mirror session.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	NetworkInterfaceId, TrafficMirrorFilterId, SessionNumber, TrafficMirrorTargetId, 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_session.

SELECT
region,
id,
network_interface_id,
traffic_mirror_target_id,
traffic_mirror_filter_id,
packet_length,
session_number,
virtual_network_id,
description,
owner_id,
tags
FROM awscc.ec2.traffic_mirror_sessions
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.traffic_mirror_sessions (
 NetworkInterfaceId,
 TrafficMirrorTargetId,
 TrafficMirrorFilterId,
 SessionNumber,
 region
)
SELECT 
'{{ NetworkInterfaceId }}',
 '{{ TrafficMirrorTargetId }}',
 '{{ TrafficMirrorFilterId }}',
 '{{ SessionNumber }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ec2.traffic_mirror_sessions (
 NetworkInterfaceId,
 TrafficMirrorTargetId,
 TrafficMirrorFilterId,
 PacketLength,
 SessionNumber,
 VirtualNetworkId,
 Description,
 OwnerId,
 Tags,
 region
)
SELECT 
 '{{ NetworkInterfaceId }}',
 '{{ TrafficMirrorTargetId }}',
 '{{ TrafficMirrorFilterId }}',
 '{{ PacketLength }}',
 '{{ SessionNumber }}',
 '{{ VirtualNetworkId }}',
 '{{ Description }}',
 '{{ OwnerId }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: traffic_mirror_session
    props:
      - name: NetworkInterfaceId
        value: '{{ NetworkInterfaceId }}'
      - name: TrafficMirrorTargetId
        value: '{{ TrafficMirrorTargetId }}'
      - name: TrafficMirrorFilterId
        value: '{{ TrafficMirrorFilterId }}'
      - name: PacketLength
        value: '{{ PacketLength }}'
      - name: SessionNumber
        value: '{{ SessionNumber }}'
      - name: VirtualNetworkId
        value: '{{ VirtualNetworkId }}'
      - name: Description
        value: '{{ Description }}'
      - name: OwnerId
        value: '{{ OwnerId }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

ec2:CreateTrafficMirrorSession,
ec2:DescribeTrafficMirrorSessions,
ec2:CreateTags,
ec2:DescribeTags

Read

ec2:DescribeTrafficMirrorSessions,
ec2:DescribeTags

Update

ec2:ModifyTrafficMirrorSession,
ec2:CreateTags,
ec2:DeleteTags,
ec2:DescribeTrafficMirrorSessions,
ec2:DescribeTags

Delete

ec2:DeleteTrafficMirrorSession,
ec2:DeleteTags

List

ec2:DescribeTrafficMirrorSessions,
ec2:DescribeTags