modify-traffic-mirror-session¶
Synopsis¶
modify-traffic-mirror-session
--traffic-mirror-session-id <value>
[--traffic-mirror-target-id <value>]
[--traffic-mirror-filter-id <value>]
[--packet-length <value>]
[--session-number <value>]
[--virtual-network-id <value>]
[--description <value>]
[--remove-fields <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--traffic-mirror-session-id (string)
The ID of the Traffic Mirror session.
--traffic-mirror-target-id (string)
The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.
--traffic-mirror-filter-id (string)
The ID of the Traffic Mirror filter.
--packet-length (integer)
The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) 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. Do not specify this parameter when you want to mirror the entire packet.
--session-number (integer)
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
--virtual-network-id (integer)
The virtual network ID of the Traffic Mirror session.
--description (string)
The description to assign to the Traffic Mirror session.
--remove-fields (list)
The properties that you want to remove from the Traffic Mirror session.
When you remove a property from a Traffic Mirror session, the property is set to the default.
(string)
Syntax:
"string" "string" ...
Where valid values are:
packet-length
description
virtual-network-id
--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 isUnauthorizedOperation.
--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
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
yaml
yaml-stream
--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.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
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 session
The following modify-traffic-mirror-session example changes the traffic mirror session description and the number of packets to mirror.
aws ec2 modify-traffic-mirror-session \
--description "Change packet length" \
--traffic-mirror-session-id tms-08a33b1214EXAMPLE \
--remove-fields "packet-length"
Output:
{
"TrafficMirrorSession": {
"TrafficMirrorSessionId": "tms-08a33b1214EXAMPLE",
"TrafficMirrorTargetId": "tmt-07f75d8feeEXAMPLE",
"TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE",
"NetworkInterfaceId": "eni-070203f901EXAMPLE",
"OwnerId": "111122223333",
"SessionNumber": 1,
"VirtualNetworkId": 7159709,
"Description": "Change packet length",
"Tags": []
}
}
For more information, see Modify your traffic mirror session in the Traffic Mirroring Guide.
Output¶
TrafficMirrorSession -> (structure)
Information about the Traffic Mirror session.
TrafficMirrorSessionId -> (string)
The ID for the Traffic Mirror session.
TrafficMirrorTargetId -> (string)
The ID of the Traffic Mirror target.
TrafficMirrorFilterId -> (string)
The ID of the Traffic Mirror filter.
NetworkInterfaceId -> (string)
The ID of the Traffic Mirror session’s network interface.
OwnerId -> (string)
The ID of the account that owns the Traffic Mirror session.
PacketLength -> (integer)
The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) 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. Do not specify this parameter when you want to mirror the entire packet
SessionNumber -> (integer)
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
VirtualNetworkId -> (integer)
The virtual network ID associated with the Traffic Mirror session.
Description -> (string)
The description of the Traffic Mirror session.
Tags -> (list)
The tags assigned to the Traffic Mirror session.
(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 256 Unicode characters.