TrafficMirrorSession class
Provides an Traffic mirror session. Read limits and considerations for traffic mirroring
Example Usage
To create a basic traffic mirror session
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const filter = new aws.ec2.TrafficMirrorFilter("filter", {
description: "traffic mirror filter - example",
networkServices: ["amazon-dns"],
});
const target = new aws.ec2.TrafficMirrorTarget("target", {networkLoadBalancerArn: lb.arn});
const session = new aws.ec2.TrafficMirrorSession("session", {
description: "traffic mirror session - example",
networkInterfaceId: test.primaryNetworkInterfaceId,
sessionNumber: 1,
trafficMirrorFilterId: filter.id,
trafficMirrorTargetId: target.id,
});
import pulumi
import pulumi_aws as aws
filter = aws.ec2.TrafficMirrorFilter("filter",
description="traffic mirror filter - example",
network_services=["amazon-dns"])
target = aws.ec2.TrafficMirrorTarget("target", network_load_balancer_arn=lb["arn"])
session = aws.ec2.TrafficMirrorSession("session",
description="traffic mirror session - example",
network_interface_id=test["primaryNetworkInterfaceId"],
session_number=1,
traffic_mirror_filter_id=filter.id,
traffic_mirror_target_id=target.id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var filter = new Aws.Ec2.TrafficMirrorFilter("filter", new()
{
Description = "traffic mirror filter - example",
NetworkServices = new[]
{
"amazon-dns",
},
});
var target = new Aws.Ec2.TrafficMirrorTarget("target", new()
{
NetworkLoadBalancerArn = lb.Arn,
});
var session = new Aws.Ec2.TrafficMirrorSession("session", new()
{
Description = "traffic mirror session - example",
NetworkInterfaceId = test.PrimaryNetworkInterfaceId,
SessionNumber = 1,
TrafficMirrorFilterId = filter.Id,
TrafficMirrorTargetId = target.Id,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
filter, err := ec2.NewTrafficMirrorFilter(ctx, "filter", &ec2.TrafficMirrorFilterArgs{
Description: pulumi.String("traffic mirror filter - example"),
NetworkServices: pulumi.StringArray{
pulumi.String("amazon-dns"),
},
})
if err != nil {
return err
}
target, err := ec2.NewTrafficMirrorTarget(ctx, "target", &ec2.TrafficMirrorTargetArgs{
NetworkLoadBalancerArn: pulumi.Any(lb.Arn),
})
if err != nil {
return err
}
_, err = ec2.NewTrafficMirrorSession(ctx, "session", &ec2.TrafficMirrorSessionArgs{
Description: pulumi.String("traffic mirror session - example"),
NetworkInterfaceId: pulumi.Any(test.PrimaryNetworkInterfaceId),
SessionNumber: pulumi.Int(1),
TrafficMirrorFilterId: filter.ID().ToIDOutput().ToStringOutput(),
TrafficMirrorTargetId: target.ID().ToIDOutput().ToStringOutput(),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ec2_trafficmirrorfilter" "filter" {
description = "traffic mirror filter - example"
network_services = ["amazon-dns"]
}
resource "aws_ec2_trafficmirrortarget" "target" {
network_load_balancer_arn = lb.arn
}
resource "aws_ec2_trafficmirrorsession" "session" {
description = "traffic mirror session - example"
network_interface_id = test.primaryNetworkInterfaceId
session_number = 1
traffic_mirror_filter_id = aws_ec2_trafficmirrorfilter.filter.id
traffic_mirror_target_id = aws_ec2_trafficmirrortarget.target.id
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.TrafficMirrorFilter;
import com.pulumi.aws.ec2.TrafficMirrorFilterArgs;
import com.pulumi.aws.ec2.TrafficMirrorTarget;
import com.pulumi.aws.ec2.TrafficMirrorTargetArgs;
import com.pulumi.aws.ec2.TrafficMirrorSession;
import com.pulumi.aws.ec2.TrafficMirrorSessionArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var filter = new TrafficMirrorFilter("filter", TrafficMirrorFilterArgs.builder()
.description("traffic mirror filter - example")
.networkServices("amazon-dns")
.build());
var target = new TrafficMirrorTarget("target", TrafficMirrorTargetArgs.builder()
.networkLoadBalancerArn(lb.arn())
.build());
var session = new TrafficMirrorSession("session", TrafficMirrorSessionArgs.builder()
.description("traffic mirror session - example")
.networkInterfaceId(test.primaryNetworkInterfaceId())
.sessionNumber(1)
.trafficMirrorFilterId(filter.id())
.trafficMirrorTargetId(target.id())
.build());
}
}
resources:
filter:
type: aws:ec2:TrafficMirrorFilter
properties:
description: traffic mirror filter - example
networkServices:
- amazon-dns
target:
type: aws:ec2:TrafficMirrorTarget
properties:
networkLoadBalancerArn: ${lb.arn}
session:
type: aws:ec2:TrafficMirrorSession
properties:
description: traffic mirror session - example
networkInterfaceId: ${test.primaryNetworkInterfaceId}
sessionNumber: 1
trafficMirrorFilterId: ${filter.id}
trafficMirrorTargetId: ${target.id}
Import
Using pulumi import, import traffic mirror sessions using the id. For example:
$ pulumi import aws:ec2/trafficMirrorSession:TrafficMirrorSession session tms-0d8aa3ca35897b82e
Constructors
- TrafficMirrorSession(String name, {TrafficMirrorSessionArgs? args, CustomResourceOptions? options})
-
Creates a new TrafficMirrorSession.
nameThe Pulumi resource name.argsArguments used to configure this TrafficMirrorSession. The set of arguments for TrafficMirrorSession.optionsResource options controlling this resource's behavior. - TrafficMirrorSession.reference(String urn)
- Creates a typed reference to an existing TrafficMirrorSession resource.
Properties
-
arn
↔ Output<
String> -
The ARN of the traffic mirror session.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String?> -
A description of the traffic mirror session.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
networkInterfaceId
↔ Output<
String> -
ID of the source network interface. Not all network interfaces are eligible as mirror sources. On EC2 instances only nitro based instances support mirroring.
latefinal
-
ownerId
↔ Output<
String> -
The AWS account ID of the session owner.
latefinal
-
packetLength
↔ Output<
int> -
The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sessionNumber
↔ Output<
int> -
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.
latefinal
-
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
trafficMirrorFilterId
↔ Output<
String> -
ID of the traffic mirror filter to be used
latefinal
-
trafficMirrorTargetId
↔ Output<
String> -
ID of the traffic mirror target to be used
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
virtualNetworkId
↔ Output<
int> -
The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see RFC 7348. If you do not specify a VirtualNetworkId, an account-wide unique id is chosen at random.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {TrafficMirrorSessionState? state, CustomResourceOptions? options}) → TrafficMirrorSession -
Gets an existing TrafficMirrorSession resource's state with the given
nameandid.