Amazonka.CloudTrail.PutEventSelectors

Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events.

When an event occurs in your account, CloudTrail evaluates the event selectors or advanced 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

1. You create an event selector for a trail and specify that you want write-only events.
2. The EC2 GetConsoleOutput and RunInstances API operations occur in your account.
3. CloudTrail evaluates whether the events match your event selectors.
4. The RunInstances is a write-only event and it matches your event selector. The trail logs the event.
5. The GetConsoleOutput is a read-only event that 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 exception is thrown.

You can configure up to five event selectors for each trail. For more information, see Logging management events for trails , Logging data events for trails , and Quotas in CloudTrail in the CloudTrail User Guide.

You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide.

Creating a Request

data PutEventSelectors

See: newPutEventSelectors smart constructor.

Constructors

PutEventSelectors'

Fields

• advancedEventSelectors :: Maybe [AdvancedEventSelector]

  Specifies the settings for advanced event selectors. You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide.

• eventSelectors :: Maybe [EventSelector]

  Specifies the settings for your event selectors. You can configure up to five event selectors for a trail. You can use either EventSelectors or AdvancedEventSelectors in a PutEventSelectors request, but not both. If you apply EventSelectors to a trail, any existing AdvancedEventSelectors are overwritten.

• trailName :: 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 not valid.
  • Not be in IP address format (for example, 192.168.5.4)

  If you specify a trail ARN, it must be in the following format.

  arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Instances

ToJSON PutEventSelectors

Defined in Amazonka.CloudTrail.PutEventSelectors

Methods

toJSON :: PutEventSelectors -> Value

toEncoding :: PutEventSelectors -> Encoding

toJSONList :: [PutEventSelectors] -> Value

toEncodingList :: [PutEventSelectors] -> Encoding

ToHeaders PutEventSelectors

Defined in Amazonka.CloudTrail.PutEventSelectors

Methods

toHeaders :: PutEventSelectors -> [Header]

ToPath PutEventSelectors

Defined in Amazonka.CloudTrail.PutEventSelectors

Methods

toPath :: PutEventSelectors -> ByteString

ToQuery PutEventSelectors

Defined in Amazonka.CloudTrail.PutEventSelectors

Methods

toQuery :: PutEventSelectors -> QueryString

AWSRequest PutEventSelectors

Defined in Amazonka.CloudTrail.PutEventSelectors

Associated Types

type AWSResponse PutEventSelectors

Methods

request :: (Service -> Service) -> PutEventSelectors -> Request PutEventSelectors

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutEventSelectors -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutEventSelectors)))

Generic PutEventSelectors

Defined in Amazonka.CloudTrail.PutEventSelectors

Associated Types

type Rep PutEventSelectors :: Type -> Type

Methods

from :: PutEventSelectors -> Rep PutEventSelectors x

to :: Rep PutEventSelectors x -> PutEventSelectors

Read PutEventSelectors

Defined in Amazonka.CloudTrail.PutEventSelectors

Methods

readsPrec :: Int -> ReadS PutEventSelectors

readList :: ReadS [PutEventSelectors]

readPrec :: ReadPrec PutEventSelectors

readListPrec :: ReadPrec [PutEventSelectors]

Show PutEventSelectors

Defined in Amazonka.CloudTrail.PutEventSelectors

Methods

showsPrec :: Int -> PutEventSelectors -> ShowS

show :: PutEventSelectors -> String

showList :: [PutEventSelectors] -> ShowS

NFData PutEventSelectors

Defined in Amazonka.CloudTrail.PutEventSelectors

Methods

rnf :: PutEventSelectors -> ()

Eq PutEventSelectors

Defined in Amazonka.CloudTrail.PutEventSelectors

Methods

(==) :: PutEventSelectors -> PutEventSelectors -> Bool

(/=) :: PutEventSelectors -> PutEventSelectors -> Bool

Hashable PutEventSelectors

Defined in Amazonka.CloudTrail.PutEventSelectors

Methods

hashWithSalt :: Int -> PutEventSelectors -> Int

hash :: PutEventSelectors -> Int

type AWSResponse PutEventSelectors

Defined in Amazonka.CloudTrail.PutEventSelectors

type AWSResponse PutEventSelectors = PutEventSelectorsResponse

type Rep PutEventSelectors

Defined in Amazonka.CloudTrail.PutEventSelectors

type Rep PutEventSelectors = D1 ('MetaData "PutEventSelectors" "Amazonka.CloudTrail.PutEventSelectors" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "PutEventSelectors'" 'PrefixI 'True) (S1 ('MetaSel ('Just "advancedEventSelectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AdvancedEventSelector])) :*: (S1 ('MetaSel ('Just "eventSelectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EventSelector])) :*: S1 ('MetaSel ('Just "trailName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newPutEventSelectors

Arguments

:: Text

$sel:trailName:PutEventSelectors'

-> PutEventSelectors

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

PutEventSelectors, putEventSelectors_advancedEventSelectors - Specifies the settings for advanced event selectors. You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide.

PutEventSelectors, putEventSelectors_eventSelectors - Specifies the settings for your event selectors. You can configure up to five event selectors for a trail. You can use either EventSelectors or AdvancedEventSelectors in a PutEventSelectors request, but not both. If you apply EventSelectors to a trail, any existing AdvancedEventSelectors are overwritten.

$sel:trailName:PutEventSelectors', putEventSelectors_trailName - 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 not valid.
• Not be in IP address format (for example, 192.168.5.4)

If you specify a trail ARN, it must be in the following format.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Request Lenses

putEventSelectors_advancedEventSelectors :: Lens' PutEventSelectors (Maybe [AdvancedEventSelector])

Specifies the settings for advanced event selectors. You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide.

putEventSelectors_eventSelectors :: Lens' PutEventSelectors (Maybe [EventSelector])

Specifies the settings for your event selectors. You can configure up to five event selectors for a trail. You can use either EventSelectors or AdvancedEventSelectors in a PutEventSelectors request, but not both. If you apply EventSelectors to a trail, any existing AdvancedEventSelectors are overwritten.

putEventSelectors_trailName :: 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 not valid.
• Not be in IP address format (for example, 192.168.5.4)

If you specify a trail ARN, it must be in the following format.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Destructuring the Response

data PutEventSelectorsResponse

See: newPutEventSelectorsResponse smart constructor.

Constructors

PutEventSelectorsResponse'

Fields

• advancedEventSelectors :: Maybe [AdvancedEventSelector]

  Specifies the advanced event selectors configured for your trail.

• eventSelectors :: Maybe [EventSelector]

  Specifies the event selectors configured for your trail.

• trailARN :: Maybe Text

  Specifies the ARN of the trail that was updated with event selectors. The following is the format of a trail ARN.

  arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

• httpStatus :: Int

  The response's http status code.

Instances

Generic PutEventSelectorsResponse

Defined in Amazonka.CloudTrail.PutEventSelectors

Associated Types

type Rep PutEventSelectorsResponse :: Type -> Type

Methods

from :: PutEventSelectorsResponse -> Rep PutEventSelectorsResponse x

to :: Rep PutEventSelectorsResponse x -> PutEventSelectorsResponse

Read PutEventSelectorsResponse

Defined in Amazonka.CloudTrail.PutEventSelectors

Methods

readsPrec :: Int -> ReadS PutEventSelectorsResponse

readList :: ReadS [PutEventSelectorsResponse]

readPrec :: ReadPrec PutEventSelectorsResponse

readListPrec :: ReadPrec [PutEventSelectorsResponse]

Show PutEventSelectorsResponse

Defined in Amazonka.CloudTrail.PutEventSelectors

Methods

showsPrec :: Int -> PutEventSelectorsResponse -> ShowS

show :: PutEventSelectorsResponse -> String

showList :: [PutEventSelectorsResponse] -> ShowS

NFData PutEventSelectorsResponse

Defined in Amazonka.CloudTrail.PutEventSelectors

Methods

rnf :: PutEventSelectorsResponse -> ()

Eq PutEventSelectorsResponse

Defined in Amazonka.CloudTrail.PutEventSelectors

Methods

(==) :: PutEventSelectorsResponse -> PutEventSelectorsResponse -> Bool

(/=) :: PutEventSelectorsResponse -> PutEventSelectorsResponse -> Bool

type Rep PutEventSelectorsResponse

Defined in Amazonka.CloudTrail.PutEventSelectors

type Rep PutEventSelectorsResponse = D1 ('MetaData "PutEventSelectorsResponse" "Amazonka.CloudTrail.PutEventSelectors" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "PutEventSelectorsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "advancedEventSelectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AdvancedEventSelector])) :*: S1 ('MetaSel ('Just "eventSelectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EventSelector]))) :*: (S1 ('MetaSel ('Just "trailARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newPutEventSelectorsResponse

Arguments

:: Int

$sel:httpStatus:PutEventSelectorsResponse'

-> PutEventSelectorsResponse

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

PutEventSelectors, putEventSelectorsResponse_advancedEventSelectors - Specifies the advanced event selectors configured for your trail.

PutEventSelectors, putEventSelectorsResponse_eventSelectors - Specifies the event selectors configured for your trail.

PutEventSelectorsResponse, putEventSelectorsResponse_trailARN - Specifies the ARN of the trail that was updated with event selectors. The following is the format of a trail ARN.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

$sel:httpStatus:PutEventSelectorsResponse', putEventSelectorsResponse_httpStatus - The response's http status code.

Response Lenses

putEventSelectorsResponse_advancedEventSelectors :: Lens' PutEventSelectorsResponse (Maybe [AdvancedEventSelector])

Specifies the advanced event selectors configured for your trail.

putEventSelectorsResponse_eventSelectors :: Lens' PutEventSelectorsResponse (Maybe [EventSelector])

Specifies the event selectors configured for your trail.

putEventSelectorsResponse_trailARN :: Lens' PutEventSelectorsResponse (Maybe Text)

Specifies the ARN of the trail that was updated with event selectors. The following is the format of a trail ARN.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

putEventSelectorsResponse_httpStatus :: Lens' PutEventSelectorsResponse Int

The response's http status code.