# CfnTrafficMirrorFilterRuleProps

Properties for defining a `CfnTrafficMirrorFilterRule`.

Used as props by: [CfnTrafficMirrorFilterRule](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.CfnTrafficMirrorFilterRule.html)

- Source: Generated at build time
- Type last changed: v2.154.0 · 22 Aug 2024

## Example

TypeScript:

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnTrafficMirrorFilterRuleProps: ec2.CfnTrafficMirrorFilterRuleProps = {
  destinationCidrBlock: 'destinationCidrBlock',
  ruleAction: 'ruleAction',
  ruleNumber: 123,
  sourceCidrBlock: 'sourceCidrBlock',
  trafficDirection: 'trafficDirection',
  trafficMirrorFilterId: 'trafficMirrorFilterId',

  // the properties below are optional
  description: 'description',
  destinationPortRange: {
    fromPort: 123,
    toPort: 123,
  },
  protocol: 123,
  sourcePortRange: {
    fromPort: 123,
    toPort: 123,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
```

Python:

```python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

cfn_traffic_mirror_filter_rule_props = ec2.CfnTrafficMirrorFilterRuleProps(
    destination_cidr_block="destinationCidrBlock",
    rule_action="ruleAction",
    rule_number=123,
    source_cidr_block="sourceCidrBlock",
    traffic_direction="trafficDirection",
    traffic_mirror_filter_id="trafficMirrorFilterId",

    # the properties below are optional
    description="description",
    destination_port_range=ec2.CfnTrafficMirrorFilterRule.TrafficMirrorPortRangeProperty(
        from_port=123,
        to_port=123
    ),
    protocol=123,
    source_port_range=ec2.CfnTrafficMirrorFilterRule.TrafficMirrorPortRangeProperty(
        from_port=123,
        to_port=123
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
```

Java:

```java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ec2.*;

CfnTrafficMirrorFilterRuleProps cfnTrafficMirrorFilterRuleProps = CfnTrafficMirrorFilterRuleProps.builder()
        .destinationCidrBlock("destinationCidrBlock")
        .ruleAction("ruleAction")
        .ruleNumber(123)
        .sourceCidrBlock("sourceCidrBlock")
        .trafficDirection("trafficDirection")
        .trafficMirrorFilterId("trafficMirrorFilterId")

        // the properties below are optional
        .description("description")
        .destinationPortRange(TrafficMirrorPortRangeProperty.builder()
                .fromPort(123)
                .toPort(123)
                .build())
        .protocol(123)
        .sourcePortRange(TrafficMirrorPortRangeProperty.builder()
                .fromPort(123)
                .toPort(123)
                .build())
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 cfnTrafficMirrorFilterRuleProps = new CfnTrafficMirrorFilterRuleProps {
    DestinationCidrBlock = "destinationCidrBlock",
    RuleAction = "ruleAction",
    RuleNumber = 123,
    SourceCidrBlock = "sourceCidrBlock",
    TrafficDirection = "trafficDirection",
    TrafficMirrorFilterId = "trafficMirrorFilterId",

    // the properties below are optional
    Description = "description",
    DestinationPortRange = new TrafficMirrorPortRangeProperty {
        FromPort = 123,
        ToPort = 123
    },
    Protocol = 123,
    SourcePortRange = new TrafficMirrorPortRangeProperty {
        FromPort = 123,
        ToPort = 123
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnTrafficMirrorFilterRuleProps := &CfnTrafficMirrorFilterRuleProps{
	DestinationCidrBlock: jsii.String("destinationCidrBlock"),
	RuleAction: jsii.String("ruleAction"),
	RuleNumber: jsii.Number(123),
	SourceCidrBlock: jsii.String("sourceCidrBlock"),
	TrafficDirection: jsii.String("trafficDirection"),
	TrafficMirrorFilterId: jsii.String("trafficMirrorFilterId"),

	// the properties below are optional
	Description: jsii.String("description"),
	DestinationPortRange: &TrafficMirrorPortRangeProperty{
		FromPort: jsii.Number(123),
		ToPort: jsii.Number(123),
	},
	Protocol: jsii.Number(123),
	SourcePortRange: &TrafficMirrorPortRangeProperty{
		FromPort: jsii.Number(123),
		ToPort: jsii.Number(123),
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}
```

## Properties

- `description`: string — The description of the Traffic Mirror rule.

- `destinationCidrBlock`: string (required) — The destination CIDR block to assign to the Traffic Mirror rule.

- `destinationPortRange`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnTrafficMirrorFilterRule.TrafficMirrorPortRangeProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.CfnTrafficMirrorFilterRule.TrafficMirrorPortRangeProperty.html) — The destination port range.

- `protocol`: number — The protocol, for example UDP, to assign to the Traffic Mirror rule.

  For information about the protocol value, see [Protocol Numbers](https://docs.aws.amazon.com/https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) on the Internet Assigned Numbers Authority (IANA) website.

- `ruleAction`: string (required) — The action to take on the filtered traffic.

- `ruleNumber`: number (required) — The number of the Traffic Mirror rule.

  This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.

- `sourceCidrBlock`: string (required) — The source CIDR block to assign to the Traffic Mirror rule.

- `sourcePortRange`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnTrafficMirrorFilterRule.TrafficMirrorPortRangeProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.CfnTrafficMirrorFilterRule.TrafficMirrorPortRangeProperty.html) — The source port range.

- `tags`: [CfnTag](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — Tags on Traffic Mirroring filter rules.

- `trafficDirection`: string (required) — The type of traffic.

- `trafficMirrorFilterId`: string (required) — The ID of the filter that this rule is associated with.
