Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates a Traffic Mirror session.
A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.
The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.
By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.
Synopsis
- data CreateTrafficMirrorSession = CreateTrafficMirrorSession' {}
- newCreateTrafficMirrorSession :: Text -> Text -> Text -> Int -> CreateTrafficMirrorSession
- createTrafficMirrorSession_clientToken :: Lens' CreateTrafficMirrorSession (Maybe Text)
- createTrafficMirrorSession_description :: Lens' CreateTrafficMirrorSession (Maybe Text)
- createTrafficMirrorSession_dryRun :: Lens' CreateTrafficMirrorSession (Maybe Bool)
- createTrafficMirrorSession_packetLength :: Lens' CreateTrafficMirrorSession (Maybe Int)
- createTrafficMirrorSession_tagSpecifications :: Lens' CreateTrafficMirrorSession (Maybe [TagSpecification])
- createTrafficMirrorSession_virtualNetworkId :: Lens' CreateTrafficMirrorSession (Maybe Int)
- createTrafficMirrorSession_networkInterfaceId :: Lens' CreateTrafficMirrorSession Text
- createTrafficMirrorSession_trafficMirrorTargetId :: Lens' CreateTrafficMirrorSession Text
- createTrafficMirrorSession_trafficMirrorFilterId :: Lens' CreateTrafficMirrorSession Text
- createTrafficMirrorSession_sessionNumber :: Lens' CreateTrafficMirrorSession Int
- data CreateTrafficMirrorSessionResponse = CreateTrafficMirrorSessionResponse' {}
- newCreateTrafficMirrorSessionResponse :: Int -> CreateTrafficMirrorSessionResponse
- createTrafficMirrorSessionResponse_clientToken :: Lens' CreateTrafficMirrorSessionResponse (Maybe Text)
- createTrafficMirrorSessionResponse_trafficMirrorSession :: Lens' CreateTrafficMirrorSessionResponse (Maybe TrafficMirrorSession)
- createTrafficMirrorSessionResponse_httpStatus :: Lens' CreateTrafficMirrorSessionResponse Int
Creating a Request
data CreateTrafficMirrorSession Source #
See: newCreateTrafficMirrorSession
smart constructor.
CreateTrafficMirrorSession' | |
|
Instances
newCreateTrafficMirrorSession Source #
:: Text | |
-> Text | |
-> Text | |
-> Int | |
-> CreateTrafficMirrorSession |
Create a value of CreateTrafficMirrorSession
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateTrafficMirrorSession
, createTrafficMirrorSession_clientToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see
How to ensure idempotency.
CreateTrafficMirrorSession
, createTrafficMirrorSession_description
- The description of the Traffic Mirror session.
$sel:dryRun:CreateTrafficMirrorSession'
, createTrafficMirrorSession_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 is UnauthorizedOperation
.
CreateTrafficMirrorSession
, createTrafficMirrorSession_packetLength
- The number of bytes in each packet to mirror. These are bytes after the
VXLAN header. Do not specify this parameter when you want to mirror the
entire packet. To mirror a subset of the packet, set this to the length
(in bytes) that you want 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.
If you do not want to mirror the entire packet, use the PacketLength
parameter to specify the number of bytes in each packet to mirror.
CreateTrafficMirrorSession
, createTrafficMirrorSession_tagSpecifications
- The tags to assign to a Traffic Mirror session.
CreateTrafficMirrorSession
, createTrafficMirrorSession_virtualNetworkId
- The VXLAN ID for the Traffic Mirror session. For more information about
the VXLAN protocol, see RFC 7348.
If you do not specify a VirtualNetworkId
, an account-wide unique id is
chosen at random.
CreateTrafficMirrorSession
, createTrafficMirrorSession_networkInterfaceId
- The ID of the source network interface.
CreateTrafficMirrorSession
, createTrafficMirrorSession_trafficMirrorTargetId
- The ID of the Traffic Mirror target.
CreateTrafficMirrorSession
, createTrafficMirrorSession_trafficMirrorFilterId
- The ID of the Traffic Mirror filter.
CreateTrafficMirrorSession
, createTrafficMirrorSession_sessionNumber
- 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.
Request Lenses
createTrafficMirrorSession_clientToken :: Lens' CreateTrafficMirrorSession (Maybe Text) Source #
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
createTrafficMirrorSession_description :: Lens' CreateTrafficMirrorSession (Maybe Text) Source #
The description of the Traffic Mirror session.
createTrafficMirrorSession_dryRun :: Lens' CreateTrafficMirrorSession (Maybe Bool) Source #
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
.
createTrafficMirrorSession_packetLength :: Lens' CreateTrafficMirrorSession (Maybe Int) Source #
The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want 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.
If you do not want to mirror the entire packet, use the PacketLength
parameter to specify the number of bytes in each packet to mirror.
createTrafficMirrorSession_tagSpecifications :: Lens' CreateTrafficMirrorSession (Maybe [TagSpecification]) Source #
The tags to assign to a Traffic Mirror session.
createTrafficMirrorSession_virtualNetworkId :: Lens' CreateTrafficMirrorSession (Maybe Int) Source #
The VXLAN ID for the Traffic Mirror session. For more information about
the VXLAN protocol, see RFC 7348.
If you do not specify a VirtualNetworkId
, an account-wide unique id is
chosen at random.
createTrafficMirrorSession_networkInterfaceId :: Lens' CreateTrafficMirrorSession Text Source #
The ID of the source network interface.
createTrafficMirrorSession_trafficMirrorTargetId :: Lens' CreateTrafficMirrorSession Text Source #
The ID of the Traffic Mirror target.
createTrafficMirrorSession_trafficMirrorFilterId :: Lens' CreateTrafficMirrorSession Text Source #
The ID of the Traffic Mirror filter.
createTrafficMirrorSession_sessionNumber :: Lens' CreateTrafficMirrorSession Int Source #
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.
Destructuring the Response
data CreateTrafficMirrorSessionResponse Source #
See: newCreateTrafficMirrorSessionResponse
smart constructor.
CreateTrafficMirrorSessionResponse' | |
|
Instances
newCreateTrafficMirrorSessionResponse Source #
Create a value of CreateTrafficMirrorSessionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateTrafficMirrorSession
, createTrafficMirrorSessionResponse_clientToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. For more information, see
How to ensure idempotency.
$sel:trafficMirrorSession:CreateTrafficMirrorSessionResponse'
, createTrafficMirrorSessionResponse_trafficMirrorSession
- Information about the Traffic Mirror session.
$sel:httpStatus:CreateTrafficMirrorSessionResponse'
, createTrafficMirrorSessionResponse_httpStatus
- The response's http status code.
Response Lenses
createTrafficMirrorSessionResponse_clientToken :: Lens' CreateTrafficMirrorSessionResponse (Maybe Text) Source #
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
createTrafficMirrorSessionResponse_trafficMirrorSession :: Lens' CreateTrafficMirrorSessionResponse (Maybe TrafficMirrorSession) Source #
Information about the Traffic Mirror session.
createTrafficMirrorSessionResponse_httpStatus :: Lens' CreateTrafficMirrorSessionResponse Int Source #
The response's http status code.