Creates a Traffic Mirror filter rule.
A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.
You need the Traffic Mirror filter ID when you create the rule.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- ClientToken
-
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
Type: String
Required: No
- Description
-
The description of the Traffic Mirror rule.
Type: String
Required: No
- DestinationCidrBlock
-
The destination CIDR block to assign to the Traffic Mirror rule.
Type: String
Required: Yes
- DestinationPortRange
-
The destination port range.
Type: TrafficMirrorPortRangeRequest object
Required: No
- DryRun
-
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 isUnauthorizedOperation.Type: Boolean
Required: No
- Protocol
-
The protocol, for example UDP, to assign to the Traffic Mirror rule.
For information about the protocol value, see Protocol Numbers
on the Internet Assigned Numbers Authority (IANA) website. Type: Integer
Required: No
- RuleAction
-
The action to take on the filtered traffic.
Type: String
Valid Values:
accept | rejectRequired: Yes
- RuleNumber
-
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.
Type: Integer
Required: Yes
- SourceCidrBlock
-
The source CIDR block to assign to the Traffic Mirror rule.
Type: String
Required: Yes
- SourcePortRange
-
The source port range.
Type: TrafficMirrorPortRangeRequest object
Required: No
- TagSpecification.N
-
Traffic Mirroring tags specifications.
Type: Array of TagSpecification objects
Required: No
- TrafficDirection
-
The type of traffic.
Type: String
Valid Values:
ingress | egressRequired: Yes
- TrafficMirrorFilterId
-
The ID of the filter that this rule is associated with.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- clientToken
-
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
Type: String
- requestId
-
The ID of the request.
Type: String
- trafficMirrorFilterRule
-
The Traffic Mirror rule.
Type: TrafficMirrorFilterRule object
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
