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

Amazonka.EC2.ModifyTrafficMirrorSession

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies a Traffic Mirror session.

Synopsis

Creating a Request

data ModifyTrafficMirrorSession Source #

See: newModifyTrafficMirrorSession smart constructor.

Constructors

ModifyTrafficMirrorSession'

Fields

description :: Maybe Text
The description to assign to the Traffic Mirror session.
dryRun :: Maybe Bool
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.
packetLength :: Maybe Int
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.
removeFields :: Maybe [TrafficMirrorSessionField]
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.
sessionNumber :: Maybe Int
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.
trafficMirrorFilterId :: Maybe Text
The ID of the Traffic Mirror filter.
trafficMirrorTargetId :: Maybe Text
The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.
virtualNetworkId :: Maybe Int
The virtual network ID of the Traffic Mirror session.
trafficMirrorSessionId :: Text
The ID of the Traffic Mirror session.

Instances

Instances details

ToHeaders ModifyTrafficMirrorSession Source #
Instance details Defined in Amazonka.EC2.ModifyTrafficMirrorSession Methods toHeaders :: ModifyTrafficMirrorSession -> [Header] #
ToPath ModifyTrafficMirrorSession Source #
Instance details Defined in Amazonka.EC2.ModifyTrafficMirrorSession Methods toPath :: ModifyTrafficMirrorSession -> ByteString #
ToQuery ModifyTrafficMirrorSession Source #
Instance details Defined in Amazonka.EC2.ModifyTrafficMirrorSession Methods toQuery :: ModifyTrafficMirrorSession -> QueryString #
AWSRequest ModifyTrafficMirrorSession Source #
Instance details Defined in Amazonka.EC2.ModifyTrafficMirrorSession Associated Types type AWSResponse ModifyTrafficMirrorSession # Methods request :: (Service -> Service) -> ModifyTrafficMirrorSession -> Request ModifyTrafficMirrorSession # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyTrafficMirrorSession -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyTrafficMirrorSession))) #
Generic ModifyTrafficMirrorSession Source #
Instance details Defined in Amazonka.EC2.ModifyTrafficMirrorSession Associated Types type Rep ModifyTrafficMirrorSession :: Type -> Type # Methods from :: ModifyTrafficMirrorSession -> Rep ModifyTrafficMirrorSession x # to :: Rep ModifyTrafficMirrorSession x -> ModifyTrafficMirrorSession #
Read ModifyTrafficMirrorSession Source #
Instance details Defined in Amazonka.EC2.ModifyTrafficMirrorSession Methods readsPrec :: Int -> ReadS ModifyTrafficMirrorSession # readList :: ReadS [ModifyTrafficMirrorSession] # readPrec :: ReadPrec ModifyTrafficMirrorSession # readListPrec :: ReadPrec [ModifyTrafficMirrorSession] #
Show ModifyTrafficMirrorSession Source #
Instance details Defined in Amazonka.EC2.ModifyTrafficMirrorSession Methods showsPrec :: Int -> ModifyTrafficMirrorSession -> ShowS # show :: ModifyTrafficMirrorSession -> String # showList :: [ModifyTrafficMirrorSession] -> ShowS #
NFData ModifyTrafficMirrorSession Source #
Instance details Defined in Amazonka.EC2.ModifyTrafficMirrorSession Methods rnf :: ModifyTrafficMirrorSession -> () #
Eq ModifyTrafficMirrorSession Source #
Instance details Defined in Amazonka.EC2.ModifyTrafficMirrorSession Methods (==) :: ModifyTrafficMirrorSession -> ModifyTrafficMirrorSession -> Bool # (/=) :: ModifyTrafficMirrorSession -> ModifyTrafficMirrorSession -> Bool #
Hashable ModifyTrafficMirrorSession Source #
Instance details Defined in Amazonka.EC2.ModifyTrafficMirrorSession Methods hashWithSalt :: Int -> ModifyTrafficMirrorSession -> Int # hash :: ModifyTrafficMirrorSession -> Int #
type AWSResponse ModifyTrafficMirrorSession Source #
Instance details Defined in Amazonka.EC2.ModifyTrafficMirrorSession type AWSResponse ModifyTrafficMirrorSession = ModifyTrafficMirrorSessionResponse
type Rep ModifyTrafficMirrorSession Source #
Instance details Defined in Amazonka.EC2.ModifyTrafficMirrorSession type Rep ModifyTrafficMirrorSession = D1 ('MetaData "ModifyTrafficMirrorSession" "Amazonka.EC2.ModifyTrafficMirrorSession" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifyTrafficMirrorSession'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "packetLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "removeFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TrafficMirrorSessionField])))) :: ((S1 ('MetaSel ('Just "sessionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "trafficMirrorFilterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "trafficMirrorTargetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "virtualNetworkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "trafficMirrorSessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newModifyTrafficMirrorSession Source #

Arguments

:: Text	`ModifyTrafficMirrorSession`
-> ModifyTrafficMirrorSession

Create a value of ModifyTrafficMirrorSession 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:

ModifyTrafficMirrorSession, modifyTrafficMirrorSession_description - The description to assign to the Traffic Mirror session.

$sel:dryRun:ModifyTrafficMirrorSession', modifyTrafficMirrorSession_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.

ModifyTrafficMirrorSession, modifyTrafficMirrorSession_packetLength - 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.

$sel:removeFields:ModifyTrafficMirrorSession', modifyTrafficMirrorSession_removeFields - 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.

ModifyTrafficMirrorSession, modifyTrafficMirrorSession_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.

ModifyTrafficMirrorSession, modifyTrafficMirrorSession_trafficMirrorFilterId - The ID of the Traffic Mirror filter.

ModifyTrafficMirrorSession, modifyTrafficMirrorSession_trafficMirrorTargetId - The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.

ModifyTrafficMirrorSession, modifyTrafficMirrorSession_virtualNetworkId - The virtual network ID of the Traffic Mirror session.

ModifyTrafficMirrorSession, modifyTrafficMirrorSession_trafficMirrorSessionId - The ID of the Traffic Mirror session.

Request Lenses

modifyTrafficMirrorSession_description :: Lens' ModifyTrafficMirrorSession (Maybe Text) Source #

The description to assign to the Traffic Mirror session.

modifyTrafficMirrorSession_dryRun :: Lens' ModifyTrafficMirrorSession (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.

modifyTrafficMirrorSession_packetLength :: Lens' ModifyTrafficMirrorSession (Maybe Int) Source #

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.

modifyTrafficMirrorSession_removeFields :: Lens' ModifyTrafficMirrorSession (Maybe [TrafficMirrorSessionField]) Source #

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.

modifyTrafficMirrorSession_sessionNumber :: Lens' ModifyTrafficMirrorSession (Maybe 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.

modifyTrafficMirrorSession_trafficMirrorFilterId :: Lens' ModifyTrafficMirrorSession (Maybe Text) Source #

The ID of the Traffic Mirror filter.

modifyTrafficMirrorSession_trafficMirrorTargetId :: Lens' ModifyTrafficMirrorSession (Maybe Text) Source #

The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.

modifyTrafficMirrorSession_virtualNetworkId :: Lens' ModifyTrafficMirrorSession (Maybe Int) Source #

The virtual network ID of the Traffic Mirror session.

modifyTrafficMirrorSession_trafficMirrorSessionId :: Lens' ModifyTrafficMirrorSession Text Source #

The ID of the Traffic Mirror session.

Destructuring the Response

data ModifyTrafficMirrorSessionResponse Source #

See: newModifyTrafficMirrorSessionResponse smart constructor.

Constructors

ModifyTrafficMirrorSessionResponse'
Fields trafficMirrorSession :: Maybe TrafficMirrorSession Information about the Traffic Mirror session. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ModifyTrafficMirrorSessionResponse Source #
Instance details Defined in Amazonka.EC2.ModifyTrafficMirrorSession Associated Types type Rep ModifyTrafficMirrorSessionResponse :: Type -> Type # Methods from :: ModifyTrafficMirrorSessionResponse -> Rep ModifyTrafficMirrorSessionResponse x # to :: Rep ModifyTrafficMirrorSessionResponse x -> ModifyTrafficMirrorSessionResponse #
Read ModifyTrafficMirrorSessionResponse Source #
Instance details Defined in Amazonka.EC2.ModifyTrafficMirrorSession Methods readsPrec :: Int -> ReadS ModifyTrafficMirrorSessionResponse # readList :: ReadS [ModifyTrafficMirrorSessionResponse] # readPrec :: ReadPrec ModifyTrafficMirrorSessionResponse # readListPrec :: ReadPrec [ModifyTrafficMirrorSessionResponse] #
Show ModifyTrafficMirrorSessionResponse Source #
Instance details Defined in Amazonka.EC2.ModifyTrafficMirrorSession Methods showsPrec :: Int -> ModifyTrafficMirrorSessionResponse -> ShowS # show :: ModifyTrafficMirrorSessionResponse -> String # showList :: [ModifyTrafficMirrorSessionResponse] -> ShowS #
NFData ModifyTrafficMirrorSessionResponse Source #
Instance details Defined in Amazonka.EC2.ModifyTrafficMirrorSession Methods rnf :: ModifyTrafficMirrorSessionResponse -> () #
Eq ModifyTrafficMirrorSessionResponse Source #
Instance details Defined in Amazonka.EC2.ModifyTrafficMirrorSession Methods (==) :: ModifyTrafficMirrorSessionResponse -> ModifyTrafficMirrorSessionResponse -> Bool # (/=) :: ModifyTrafficMirrorSessionResponse -> ModifyTrafficMirrorSessionResponse -> Bool #
type Rep ModifyTrafficMirrorSessionResponse Source #
Instance details Defined in Amazonka.EC2.ModifyTrafficMirrorSession type Rep ModifyTrafficMirrorSessionResponse = D1 ('MetaData "ModifyTrafficMirrorSessionResponse" "Amazonka.EC2.ModifyTrafficMirrorSession" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifyTrafficMirrorSessionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "trafficMirrorSession") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrafficMirrorSession)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyTrafficMirrorSessionResponse Source #

Arguments

:: Int	`$sel:httpStatus:ModifyTrafficMirrorSessionResponse'`
-> ModifyTrafficMirrorSessionResponse

Create a value of ModifyTrafficMirrorSessionResponse 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:

$sel:trafficMirrorSession:ModifyTrafficMirrorSessionResponse', modifyTrafficMirrorSessionResponse_trafficMirrorSession - Information about the Traffic Mirror session.

$sel:httpStatus:ModifyTrafficMirrorSessionResponse', modifyTrafficMirrorSessionResponse_httpStatus - The response's http status code.

Response Lenses

modifyTrafficMirrorSessionResponse_trafficMirrorSession :: Lens' ModifyTrafficMirrorSessionResponse (Maybe TrafficMirrorSession) Source #

Information about the Traffic Mirror session.

modifyTrafficMirrorSessionResponse_httpStatus :: Lens' ModifyTrafficMirrorSessionResponse Int Source #

The response's http status code.