AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ec2 ]

modify-traffic-mirror-filter-rule

Description

Modifies the specified Traffic Mirror rule.

DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range.

See also: AWS API Documentation

Synopsis

  modify-traffic-mirror-filter-rule
--traffic-mirror-filter-rule-id <value>
[--traffic-direction <value>]
[--rule-number <value>]
[--rule-action <value>]
[--destination-port-range <value>]
[--source-port-range <value>]
[--protocol <value>]
[--destination-cidr-block <value>]
[--source-cidr-block <value>]
[--description <value>]
[--remove-fields <value>]
[--dry-run | --no-dry-run]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

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

The ID of the Traffic Mirror rule.

--traffic-direction (string)

The type of traffic to assign to the rule.

Possible values:

  • ingress
  • egress

--rule-number (integer)

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.

--rule-action (string)

The action to assign to the rule.

Possible values:

  • accept
  • reject

--destination-port-range (structure)

The destination ports that are associated with the Traffic Mirror rule.

FromPort -> (integer)

The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.

ToPort -> (integer)

The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.

Shorthand Syntax:

FromPort=integer,ToPort=integer

JSON Syntax:

{
  "FromPort": integer,
  "ToPort": integer
}

--source-port-range (structure)

The port range to assign to the Traffic Mirror rule.

FromPort -> (integer)

The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.

ToPort -> (integer)

The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.

Shorthand Syntax:

FromPort=integer,ToPort=integer

JSON Syntax:

{
  "FromPort": integer,
  "ToPort": integer
}

--protocol (integer)

The protocol, for example TCP, to assign to the Traffic Mirror rule.

--destination-cidr-block (string)

The destination CIDR block to assign to the Traffic Mirror rule.

--source-cidr-block (string)

The source CIDR block to assign to the Traffic Mirror rule.

--description (string)

The description to assign to the Traffic Mirror rule.

--remove-fields (list)

The properties that you want to remove from the Traffic Mirror filter rule.

When you remove a property from a Traffic Mirror filter rule, the property is set to the default.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  destination-port-range
  source-port-range
  protocol
  description

--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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To modify a traffic mirror filter rule

The following modify-traffic-mirror-filter-rule example modifies the description of the specified traffic mirror filter rule.

aws ec2 modify-traffic-mirror-filter-rule \
    --traffic-mirror-filter-rule-id tmfr-0ca76e0e08EXAMPLE \
    --description "TCP Rule"

Output:

{
    "TrafficMirrorFilterRule": {
        "TrafficMirrorFilterRuleId": "tmfr-0ca76e0e08EXAMPLE",
        "TrafficMirrorFilterId": "tmf-0293f26e86EXAMPLE",
        "TrafficDirection": "ingress",
        "RuleNumber": 100,
        "RuleAction": "accept",
        "Protocol": 6,
        "DestinationCidrBlock": "10.0.0.0/24",
        "SourceCidrBlock": "10.0.0.0/24",
        "Description": "TCP Rule"
    }
}

For more information, see Modify Your Traffic Mirror Filter Rules in the AWS Traffic Mirroring Guide.

Output

TrafficMirrorFilterRule -> (structure)

Modifies a 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.