CreateTrafficMirrorTargetCommand

Suggest an Edit

Creates a target for your Traffic Mirror session.

A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.

A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.

To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, CreateTrafficMirrorTargetCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, CreateTrafficMirrorTargetCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // CreateTrafficMirrorTargetRequest
  NetworkInterfaceId: "STRING_VALUE",
  NetworkLoadBalancerArn: "STRING_VALUE",
  Description: "STRING_VALUE",
  TagSpecifications: [ // TagSpecificationList
    { // TagSpecification
      ResourceType: "capacity-reservation" || "client-vpn-endpoint" || "customer-gateway" || "carrier-gateway" || "coip-pool" || "declarative-policies-report" || "dedicated-host" || "dhcp-options" || "egress-only-internet-gateway" || "elastic-ip" || "elastic-gpu" || "export-image-task" || "export-instance-task" || "fleet" || "fpga-image" || "host-reservation" || "image" || "import-image-task" || "import-snapshot-task" || "instance" || "instance-event-window" || "internet-gateway" || "ipam" || "ipam-pool" || "ipam-scope" || "ipv4pool-ec2" || "ipv6pool-ec2" || "key-pair" || "launch-template" || "local-gateway" || "local-gateway-route-table" || "local-gateway-virtual-interface" || "local-gateway-virtual-interface-group" || "local-gateway-route-table-vpc-association" || "local-gateway-route-table-virtual-interface-group-association" || "natgateway" || "network-acl" || "network-interface" || "network-insights-analysis" || "network-insights-path" || "network-insights-access-scope" || "network-insights-access-scope-analysis" || "placement-group" || "prefix-list" || "replace-root-volume-task" || "reserved-instances" || "route-table" || "security-group" || "security-group-rule" || "snapshot" || "spot-fleet-request" || "spot-instances-request" || "subnet" || "subnet-cidr-reservation" || "traffic-mirror-filter" || "traffic-mirror-session" || "traffic-mirror-target" || "transit-gateway" || "transit-gateway-attachment" || "transit-gateway-connect-peer" || "transit-gateway-multicast-domain" || "transit-gateway-policy-table" || "transit-gateway-route-table" || "transit-gateway-route-table-announcement" || "volume" || "vpc" || "vpc-endpoint" || "vpc-endpoint-connection" || "vpc-endpoint-service" || "vpc-endpoint-service-permission" || "vpc-peering-connection" || "vpn-connection" || "vpn-gateway" || "vpc-flow-log" || "capacity-reservation-fleet" || "traffic-mirror-filter-rule" || "vpc-endpoint-connection-device-type" || "verified-access-instance" || "verified-access-group" || "verified-access-endpoint" || "verified-access-policy" || "verified-access-trust-provider" || "vpn-connection-device-type" || "vpc-block-public-access-exclusion" || "route-server" || "route-server-endpoint" || "route-server-peer" || "ipam-resource-discovery" || "ipam-resource-discovery-association" || "instance-connect-endpoint" || "verified-access-endpoint-target" || "ipam-external-resource-verification-token",
      Tags: [ // TagList
        { // Tag
          Key: "STRING_VALUE",
          Value: "STRING_VALUE",
        },
      ],
    },
  ],
  DryRun: true || false,
  ClientToken: "STRING_VALUE",
  GatewayLoadBalancerEndpointId: "STRING_VALUE",
};
const command = new CreateTrafficMirrorTargetCommand(input);
const response = await client.send(command);
// { // CreateTrafficMirrorTargetResult
//   TrafficMirrorTarget: { // TrafficMirrorTarget
//     TrafficMirrorTargetId: "STRING_VALUE",
//     NetworkInterfaceId: "STRING_VALUE",
//     NetworkLoadBalancerArn: "STRING_VALUE",
//     Type: "network-interface" || "network-load-balancer" || "gateway-load-balancer-endpoint",
//     Description: "STRING_VALUE",
//     OwnerId: "STRING_VALUE",
//     Tags: [ // TagList
//       { // Tag
//         Key: "STRING_VALUE",
//         Value: "STRING_VALUE",
//       },
//     ],
//     GatewayLoadBalancerEndpointId: "STRING_VALUE",
//   },
//   ClientToken: "STRING_VALUE",
// };

CreateTrafficMirrorTargetCommand Input

See CreateTrafficMirrorTargetCommandInput for more details

Parameter
Type
Description
ClientToken
string | undefined

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency .

Description
string | undefined

The description of the Traffic Mirror target.

DryRun
boolean | undefined

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

GatewayLoadBalancerEndpointId
string | undefined

The ID of the Gateway Load Balancer endpoint.

NetworkInterfaceId
string | undefined

The network interface ID that is associated with the target.

NetworkLoadBalancerArn
string | undefined

The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.

TagSpecifications
TagSpecification[] | undefined

The tags to assign to the Traffic Mirror target.

CreateTrafficMirrorTargetCommand Output

See CreateTrafficMirrorTargetCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ClientToken
string | undefined

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency .

TrafficMirrorTarget
TrafficMirrorTarget | undefined

Information about the Traffic Mirror target.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.