traffic_mirror_filters

Creates, updates, deletes or gets a traffic_mirror_filter resource or lists traffic_mirror_filters in a region

Overview

Name	traffic_mirror_filters
Type	Resource
Description	Resource schema for AWS::EC2::TrafficMirrorFilter
Id	awscc.ec2.traffic_mirror_filters

Fields

get (all properties)

Name	Datatype	Description
id	string	The ID of a traffic mirror filter.
network_services	array	The network service that is associated with the traffic mirror filter.
description	string	The description of a traffic mirror filter.
▶tags	array	The tags for a traffic mirror filter.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string	The ID of a traffic mirror filter.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	traffic_mirror_filters	INSERT	region
delete_resource	traffic_mirror_filters	DELETE	Identifier, region
update_resource	traffic_mirror_filters	UPDATE	Identifier, PatchDocument, region
list_resources	traffic_mirror_filters_list_only	SELECT	region
get_resource	traffic_mirror_filters	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual traffic_mirror_filter.

SELECT
  region,
  id,
  network_services,
  description,
  tags
FROM awscc.ec2.traffic_mirror_filters
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all traffic_mirror_filters in a region.

SELECT
  region,
  id
FROM awscc.ec2.traffic_mirror_filters_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ec2.traffic_mirror_filters (
  NetworkServices,
  Description,
  Tags,
  region
)
SELECT
  '{{ network_services }}',
  '{{ description }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.traffic_mirror_filters (
  NetworkServices,
  Description,
  Tags,
  region
)
SELECT
  '{{ network_services }}',
  '{{ description }}',
  '{{ 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: traffic_mirror_filter
  props:
    - name: network_services
      value:
        - '{{ network_services[0] }}'
    - name: description
      value: '{{ description }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ec2.traffic_mirror_filters
SET PatchDocument = string('{{ {
    "NetworkServices": network_services,
    "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.ec2.traffic_mirror_filters
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 traffic_mirror_filters resource, the following permissions are required:

Create

ec2:CreateTrafficMirrorFilter,
ec2:DescribeTrafficMirrorFilters,
ec2:CreateTags,
ec2:ModifyTrafficMirrorFilterNetworkServices,
ec2:DescribeTags

Read

ec2:DescribeTrafficMirrorFilters,
ec2:DescribeTags

Update

ec2:ModifyTrafficMirrorFilterNetworkServices,
ec2:DescribeTrafficMirrorFilters,
ec2:CreateTags,
ec2:DeleteTags,
ec2:DescribeTags

Delete

ec2:DescribeTrafficMirrorFilters,
ec2:DeleteTrafficMirrorFilter,
ec2:DeleteTags,
ec2:DescribeTags

List

ec2:DescribeTrafficMirrorFilters,
ec2:DescribeTags