amazonka-cloudtrail-1.6.0: Amazon CloudTrail SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudTrail.PutEventSelectors

Contents

Description

Configures an event selector for your trail. Use event selectors to specify whether you want your trail to log management and/or data events. When an event occurs in your account, CloudTrail evaluates the event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

Example

  • You create an event selector for a trail and specify that you want write-only events.
  • The EC2 GetConsoleOutput and RunInstances API operations occur in your account.
  • CloudTrail evaluates whether the events match your event selectors.
  • The RunInstances is a write-only event and it matches your event selector. The trail logs the event.
  • The GetConsoleOutput is a read-only event but it doesn't match your event selector. The trail doesn't log the event.

The PutEventSelectors operation must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

You can configure up to five event selectors for each trail. For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide .

Synopsis

Creating a Request

putEventSelectors #

Creates a value of PutEventSelectors with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • pesTrailName - Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements: * Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) * Start with a letter or number, and end with a letter or number * Be between 3 and 128 characters * Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid. * Not be in IP address format (for example, 192.168.5.4) If you specify a trail ARN, it must be in the format: arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
  • pesEventSelectors - Specifies the settings for your event selectors. You can configure up to five event selectors for a trail.

data PutEventSelectors #

See: putEventSelectors smart constructor.

Instances

Eq PutEventSelectors # 
Data PutEventSelectors # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutEventSelectors -> c PutEventSelectors #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutEventSelectors #

toConstr :: PutEventSelectors -> Constr #

dataTypeOf :: PutEventSelectors -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PutEventSelectors) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutEventSelectors) #

gmapT :: (forall b. Data b => b -> b) -> PutEventSelectors -> PutEventSelectors #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutEventSelectors -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutEventSelectors -> r #

gmapQ :: (forall d. Data d => d -> u) -> PutEventSelectors -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutEventSelectors -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutEventSelectors -> m PutEventSelectors #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutEventSelectors -> m PutEventSelectors #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutEventSelectors -> m PutEventSelectors #

Read PutEventSelectors # 
Show PutEventSelectors # 
Generic PutEventSelectors # 
Hashable PutEventSelectors # 
ToJSON PutEventSelectors # 
NFData PutEventSelectors # 

Methods

rnf :: PutEventSelectors -> () #

AWSRequest PutEventSelectors # 
ToHeaders PutEventSelectors # 
ToPath PutEventSelectors # 
ToQuery PutEventSelectors # 
type Rep PutEventSelectors # 
type Rep PutEventSelectors = D1 * (MetaData "PutEventSelectors" "Network.AWS.CloudTrail.PutEventSelectors" "amazonka-cloudtrail-1.6.0-FtX1PWl9UH1Ll5Gb3xSmkU" False) (C1 * (MetaCons "PutEventSelectors'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_pesTrailName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_pesEventSelectors") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [EventSelector]))))
type Rs PutEventSelectors # 

Request Lenses

pesTrailName :: Lens' PutEventSelectors Text #

Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements: * Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) * Start with a letter or number, and end with a letter or number * Be between 3 and 128 characters * Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid. * Not be in IP address format (for example, 192.168.5.4) If you specify a trail ARN, it must be in the format: arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

pesEventSelectors :: Lens' PutEventSelectors [EventSelector] #

Specifies the settings for your event selectors. You can configure up to five event selectors for a trail.

Destructuring the Response

putEventSelectorsResponse #

Creates a value of PutEventSelectorsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • pesrsTrailARN - Specifies the ARN of the trail that was updated with event selectors. The format of a trail ARN is: arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
  • pesrsEventSelectors - Specifies the event selectors configured for your trail.
  • pesrsResponseStatus - -- | The response status code.

data PutEventSelectorsResponse #

See: putEventSelectorsResponse smart constructor.

Instances

Eq PutEventSelectorsResponse # 
Data PutEventSelectorsResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutEventSelectorsResponse -> c PutEventSelectorsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutEventSelectorsResponse #

toConstr :: PutEventSelectorsResponse -> Constr #

dataTypeOf :: PutEventSelectorsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PutEventSelectorsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutEventSelectorsResponse) #

gmapT :: (forall b. Data b => b -> b) -> PutEventSelectorsResponse -> PutEventSelectorsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutEventSelectorsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutEventSelectorsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> PutEventSelectorsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutEventSelectorsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutEventSelectorsResponse -> m PutEventSelectorsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutEventSelectorsResponse -> m PutEventSelectorsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutEventSelectorsResponse -> m PutEventSelectorsResponse #

Read PutEventSelectorsResponse # 
Show PutEventSelectorsResponse # 
Generic PutEventSelectorsResponse # 
NFData PutEventSelectorsResponse # 
type Rep PutEventSelectorsResponse # 
type Rep PutEventSelectorsResponse = D1 * (MetaData "PutEventSelectorsResponse" "Network.AWS.CloudTrail.PutEventSelectors" "amazonka-cloudtrail-1.6.0-FtX1PWl9UH1Ll5Gb3xSmkU" False) (C1 * (MetaCons "PutEventSelectorsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_pesrsTrailARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_pesrsEventSelectors") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [EventSelector]))) (S1 * (MetaSel (Just Symbol "_pesrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

pesrsTrailARN :: Lens' PutEventSelectorsResponse (Maybe Text) #

Specifies the ARN of the trail that was updated with event selectors. The format of a trail ARN is: arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

pesrsEventSelectors :: Lens' PutEventSelectorsResponse [EventSelector] #

Specifies the event selectors configured for your trail.

pesrsResponseStatus :: Lens' PutEventSelectorsResponse Int #

  • - | The response status code.