modify-traffic-mirror-filter-network-services¶

Description¶

Allows or restricts mirroring network services.

By default, Amazon DNS network services are not eligible for Traffic Mirror. Use AddNetworkServices to add network services to a Traffic Mirror filter. When a network service is added to the Traffic Mirror filter, all traffic related to that network service will be mirrored. When you no longer want to mirror network services, use RemoveNetworkServices to remove the network services from the Traffic Mirror filter.

For information about filter rule properties, see Network Services in the Traffic Mirroring User Guide .

Synopsis¶

  modify-traffic-mirror-filter-network-services
--traffic-mirror-filter-id <value>
[--add-network-services <value>]
[--remove-network-services <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--traffic-mirror-filter-id (string)

The ID of the Traffic Mirror filter.

--add-network-services (list)

The network service, for example Amazon DNS, that you want to mirror.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  amazon-dns

--remove-network-services (list)

The network service, for example Amazon DNS, that you no longer want to mirror.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  amazon-dns

--dry-run | --no-dry-run (boolean)

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 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To add network services to a Traffic Mirror filter

The following modify-traffic-mirror-filter-network-services example adds the Amazon DNS network services to the specified filter.

aws ec2 modify-traffic-mirror-filter-network-services \
    --traffic-mirror-filter-id tmf-04812ff784EXAMPLE \
    --add-network-service amazon-dns

Output:

{
    "TrafficMirrorFilter": {
        "Tags": [
            {
                "Key": "Name",
                "Value": "Production"
            }
        ],
        "EgressFilterRules": [],
        "NetworkServices": [
            "amazon-dns"
        ],
        "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE",
        "IngressFilterRules": [
            {
                "SourceCidrBlock": "0.0.0.0/0",
                "RuleNumber": 1,
                "DestinationCidrBlock": "0.0.0.0/0",
                "Description": "TCP Rule",
                "Protocol": 6,
                "TrafficDirection": "ingress",
                "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE",
                "RuleAction": "accept",
                "TrafficMirrorFilterRuleId": "tmf-04812ff784EXAMPLE"
            }
        ]
    }
}

For more information, see Modify Traffic Mirror Filter Network Services in the AWS Traffic Mirroring Guide.

Output¶

TrafficMirrorFilter -> (structure)

The Traffic Mirror filter that the network service is associated with.

TrafficMirrorFilterId -> (string)

The ID of the Traffic Mirror filter.

IngressFilterRules -> (list)

Information about the ingress rules that are associated with the Traffic Mirror filter.

(structure)

Describes the Traffic Mirror rule.

TrafficMirrorFilterRuleId -> (string)

The ID of the Traffic Mirror rule.

TrafficMirrorFilterId -> (string)

The ID of the Traffic Mirror filter that the rule is associated with.

TrafficDirection -> (string)

The traffic direction assigned to the Traffic Mirror rule.

RuleNumber -> (integer)

The rule number of the Traffic Mirror rule.

RuleAction -> (string)

The action assigned to the Traffic Mirror rule.

Protocol -> (integer)

The protocol assigned to the Traffic Mirror rule.

DestinationPortRange -> (structure)

The destination port range assigned to the Traffic Mirror rule.

FromPort -> (integer)

The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.

ToPort -> (integer)

The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.

SourcePortRange -> (structure)

The source port range assigned to the Traffic Mirror rule.

FromPort -> (integer)

The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.

ToPort -> (integer)

The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.

DestinationCidrBlock -> (string)

The destination CIDR block assigned to the Traffic Mirror rule.

SourceCidrBlock -> (string)

The source CIDR block assigned to the Traffic Mirror rule.

Description -> (string)

The description of the Traffic Mirror rule.

EgressFilterRules -> (list)

Information about the egress rules that are associated with the Traffic Mirror filter.

(structure)

Describes the Traffic Mirror rule.

TrafficMirrorFilterRuleId -> (string)

The ID of the Traffic Mirror rule.

TrafficMirrorFilterId -> (string)

The ID of the Traffic Mirror filter that the rule is associated with.

TrafficDirection -> (string)

The traffic direction assigned to the Traffic Mirror rule.

RuleNumber -> (integer)

The rule number of the Traffic Mirror rule.

RuleAction -> (string)

The action assigned to the Traffic Mirror rule.

Protocol -> (integer)

The protocol assigned to the Traffic Mirror rule.

DestinationPortRange -> (structure)

The destination port range assigned to the Traffic Mirror rule.

FromPort -> (integer)

The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.

ToPort -> (integer)

The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.

SourcePortRange -> (structure)

The source port range assigned to the Traffic Mirror rule.

FromPort -> (integer)

The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.

ToPort -> (integer)

The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.

DestinationCidrBlock -> (string)

The destination CIDR block assigned to the Traffic Mirror rule.

SourceCidrBlock -> (string)

The source CIDR block assigned to the Traffic Mirror rule.

Description -> (string)

The description of the Traffic Mirror rule.

NetworkServices -> (list)

The network service traffic that is associated with the Traffic Mirror filter.

(string)

Description -> (string)

The description of the Traffic Mirror filter.

Tags -> (list)

The tags assigned to the Traffic Mirror filter.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

Table of Contents

Feedback

User Guide