Class CfnTrafficMirrorSessionProps

Properties for defining a CfnTrafficMirrorSession.

Inheritance

object

CfnTrafficMirrorSessionProps

Implements

ICfnTrafficMirrorSessionProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnTrafficMirrorSessionProps : ICfnTrafficMirrorSessionProps

Syntax (vb)

Public Class CfnTrafficMirrorSessionProps Implements ICfnTrafficMirrorSessionProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EC2;

             var cfnTrafficMirrorSessionProps = new CfnTrafficMirrorSessionProps {
                 NetworkInterfaceId = "networkInterfaceId",
                 SessionNumber = 123,
                 TrafficMirrorFilterId = "trafficMirrorFilterId",
                 TrafficMirrorTargetId = "trafficMirrorTargetId",

                 // the properties below are optional
                 Description = "description",
                 OwnerId = "ownerId",
                 PacketLength = 123,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VirtualNetworkId = 123
             };

Synopsis

Constructors

CfnTrafficMirrorSessionProps()

Properties for defining a CfnTrafficMirrorSession.

Properties

Description	The description of the Traffic Mirror session.
NetworkInterfaceId	The ID of the source network interface.
OwnerId	The ID of the account that owns the Traffic Mirror session.
PacketLength	The number of bytes in each packet to mirror.
SessionNumber	The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.
Tags	The tags to assign to a Traffic Mirror session.
TrafficMirrorFilterId	The ID of the Traffic Mirror filter.
TrafficMirrorTargetId	The ID of the Traffic Mirror target.
VirtualNetworkId	The VXLAN ID for the Traffic Mirror session.

Constructors

CfnTrafficMirrorSessionProps()

Properties for defining a CfnTrafficMirrorSession.

public CfnTrafficMirrorSessionProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EC2;

             var cfnTrafficMirrorSessionProps = new CfnTrafficMirrorSessionProps {
                 NetworkInterfaceId = "networkInterfaceId",
                 SessionNumber = 123,
                 TrafficMirrorFilterId = "trafficMirrorFilterId",
                 TrafficMirrorTargetId = "trafficMirrorTargetId",

                 // the properties below are optional
                 Description = "description",
                 OwnerId = "ownerId",
                 PacketLength = 123,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VirtualNetworkId = 123
             };

Properties

Description

The description of the Traffic Mirror session.

public string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-description

NetworkInterfaceId

The ID of the source network interface.

public string NetworkInterfaceId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-networkinterfaceid

OwnerId

The ID of the account that owns the Traffic Mirror session.

public string? OwnerId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-ownerid

PacketLength

The number of bytes in each packet to mirror.

public double? PacketLength { get; set; }

Property Value

double?

Remarks

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. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target.

If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.

For sessions with Network Load Balancer (NLB) Traffic Mirror targets the default PacketLength will be set to 8500. Valid values are 1-8500. Setting a PacketLength greater than 8500 will result in an error response.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-packetlength

SessionNumber

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions.

public double SessionNumber { get; set; }

Property Value

double

Remarks

The first session with a matching filter is the one that mirrors the packets.

Valid values are 1-32766.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-sessionnumber

TrafficMirrorFilterId

The ID of the Traffic Mirror filter.

public string TrafficMirrorFilterId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-trafficmirrorfilterid

TrafficMirrorTargetId

The ID of the Traffic Mirror target.

public string TrafficMirrorTargetId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-trafficmirrortargetid

VirtualNetworkId

The VXLAN ID for the Traffic Mirror session.

public double? VirtualNetworkId { get; set; }

Property Value

double?

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-trafficmirrorsession.html#cfn-ec2-trafficmirrorsession-virtualnetworkid

Implements

ICfnTrafficMirrorSessionProps