traffic_mirror_targets

Creates, updates, deletes or gets a traffic_mirror_target resource or lists traffic_mirror_targets in a region

Overview

Name	traffic_mirror_targets
Type	Resource
Description	The description of the Traffic Mirror target.
Id	awscc.ec2.traffic_mirror_targets

Fields

Name	Datatype	Description
network_load_balancer_arn	string	The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.
description	string	The description of the Traffic Mirror target.
id	string
network_interface_id	string	The network interface ID that is associated with the target.
gateway_load_balancer_endpoint_id	string	The ID of the Gateway Load Balancer endpoint.
▶tags	array	The tags to assign to the Traffic Mirror target.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	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_target.

SELECT
region,
network_load_balancer_arn,
description,
id,
network_interface_id,
gateway_load_balancer_endpoint_id,
tags
FROM awscc.ec2.traffic_mirror_targets
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_target resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.ec2.traffic_mirror_targets (
 NetworkLoadBalancerArn,
 Description,
 NetworkInterfaceId,
 GatewayLoadBalancerEndpointId,
 Tags,
 region
)
SELECT 
'{{ NetworkLoadBalancerArn }}',
 '{{ Description }}',
 '{{ NetworkInterfaceId }}',
 '{{ GatewayLoadBalancerEndpointId }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ec2.traffic_mirror_targets (
 NetworkLoadBalancerArn,
 Description,
 NetworkInterfaceId,
 GatewayLoadBalancerEndpointId,
 Tags,
 region
)
SELECT 
 '{{ NetworkLoadBalancerArn }}',
 '{{ Description }}',
 '{{ NetworkInterfaceId }}',
 '{{ GatewayLoadBalancerEndpointId }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: traffic_mirror_target
    props:
      - name: NetworkLoadBalancerArn
        value: '{{ NetworkLoadBalancerArn }}'
      - name: Description
        value: '{{ Description }}'
      - name: NetworkInterfaceId
        value: '{{ NetworkInterfaceId }}'
      - name: GatewayLoadBalancerEndpointId
        value: '{{ GatewayLoadBalancerEndpointId }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

ec2:CreateTrafficMirrorTarget,
ec2:CreateTags

Read

ec2:DescribeTrafficMirrorTargets,
ec2:DescribeTags

Update

ec2:DescribeTrafficMirrorTargets,
ec2:CreateTags,
ec2:DeleteTags,
ec2:DescribeTags

Delete

ec2:DeleteTrafficMirrorTarget,
ec2:DeleteTags

List

ec2:DescribeTrafficMirrorTargets,
ec2:DescribeTags