-
Notifications
You must be signed in to change notification settings - Fork 16
/
cloudtrail.aws.txt
1419 lines (1171 loc) · 79.5 KB
/
cloudtrail.aws.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
CLOUDTRAIL
VERSION ==> #2023-11-26
SUMMARY ==> #Trail: free default, multi-region, org-wide, global SERVICEs
#Log file: S3, delivery, SNS, integrity, lookup, CloudWatch Logs
#Event fields: metadata, request|response, service-specific, resources, auth
#Selectors: readonly vs write, management vs data, ACTION
#Insight: baseline change, selectors, failed vs write, top attributions
#CloudTrail Lake: data store, retention period, billing mode, channel, custom, service-linked channel, partner, policy, import
#Query: SQL, dashboard, saved, S3 delivery, results integrity
/=+===============================+=\
/ : : \
)==: API :==(
\ :_______________________________: /
\=+===============================+=/
SERVICE_DOMAIN #'cloudtrail'
#Except for PutAuditEvents(): 'cloudtrail-data'
# - including in PACTION and SDK|CLI
FORMAT ==> #JSON
#Request: ?Action and ?Version
# - except PutAuditEvents(): REST
PAGINATION ==> #REQ|RES.NextToken STR
#REQ.MaxResults NUM (def|max: 1e3, 50 with LookupEvents(), none with TRAIL)
#No pagination with RESOURCE_TAGS|PUBLIC_KEY
THROTTLING ==> #Max 10 requests per second, except:
# - PutAuditEvents(): 100 requests per second
# - StartQuery|CancelQuery(): 3 requests per second
# - LookupEvents(): 2 requests per second
# - write ACTIONs: 1 request per second
PRICING ==> #TRAIL:
# - 1$/5e4 management EVENTs
# - free: first copy of each management EVENT (with a given EVENT_MID)
# - INSIGHT: 17% more expensive (not part of free tier)
# - 1$/1e6 data EVENTs
# - also, S3 costs
#Shadow TRAILs: charged too
#DATASTORE:
# - EXTENDABLE_RETENTION_PRICING:
# - 1$/1.3GB input (new EVENTs)
# - 33% cheaper if eventCategory 'Insight|ActivityAuditLog|ConfigurationItem|Evidence'
# - also, S3 costs: 1$/43GB (all EVENTs)
# - free: first year for each EVENT
# - i.e. completely free if RetentionPeriod 1 year (default)
# - FIXED_RETENTION_PRICING:
# - 1$/400MB input
# - after 5TB: 2.5x cheaper, 25TB: 5x cheaper
# - no S3 costs
# - i.e. better if >25TB/month and|or RetentionPeriod > 1 year
# - free for 30 days: up to 5GB (not for S3 costs)
#QUERY: 1$/200GB scanned (QUERY_STATS.BytesScanned)
# - free for 30 days: up to 5GB
AWSCloudTrail_FullAccess #AWS managed POLICY, granting:
# - cloudtrail:* on anything
# - iam:ListRoles|GetRolePolicy|GetUser: on any ROLE|USER
# - iam:PassRole: on any ROLE, if SERVICE_DOMAIN 'cloudtrail.amazonaws.com'
# - s3:ListAllMyBuckets|GetBucketLocation|GetBucketPolicy: on any BUCKET
# - s3:CreateBucket|PutBucketPolicy|PutBucketPublicAccessBlock: on BUCKET 'aws-cloudtrail-logs*'
# - sns:ListTopics: on any TOPIC
# - sns:CreateTopic|*TopicAttributes|AddPermission: on TOPIC 'aws-cloudtrail-logs*'
# - logs:CreateLogGroup: on LOG_GROUP 'aws-cloudtrail-logs*'
# - kms:CreateKey|ListKeys|CreateAlias|ListAliases: on any KMS_KEY|ALIAS
# - lambda:ListFunctions: on any FUNCTION
# - dynamodb:List[Global]Tables: on any TABLE
AWSCloudTrail_ReadOnlyAccess #Same but readonly, and only for CloudTrail PACTIONs
/=+===============================+=\
/ : : \
)==: TRAIL MAIN :==(
\ :_______________________________: /
\=+===============================+=/
CreateTrail() #Req: TRAIL
# - no TrailARN, HomeRegion, HasCustomEventSelectors, HasInsightSelectors, SnsTopicARN
# - LogFileValidationEnabled -> EnableLogFileValidation
#Res: TRAIL
# - no HomeRegion, HasCustomEventSelectors, HasInsightSelectors, TagsList
UpdateTrail() #Req: TRAIL
# - Name + TrailARN -> Name
# - no HomeRegion, HasCustomEventSelectors, HasInsightSelectors, SnsTopicARN, TagsList
# - LogFileValidationEnabled -> EnableLogFileValidation
#Res: TRAIL
# - no HomeRegion, HasCustomEventSelectors, HasInsightSelectors, TagsList
GetTrail() #Req: TRAIL
# - Name + TrailARN -> Name
#Res: Trail TRAIL
# - no TagsList
ListTrails() #Req: empty
#Res: Trails TRAIL_ARR
# - only TrailARN, Name, HomeRegion
DescribeTrails() #Req: TRAIL_REQ
#Response: trailList TRAIL_ARR
# - no TagsList
DeleteTrail() #Req: TRAIL
# - Name + TrailARN -> Name
#Res: empty
TRAIL #Logs any AWS API calls to a S3 BUCKET
#Some SERVICEs do not log all their ACTIONs, or sometimes none
#From both user and SERVICE_ACTIONs
#If not created explicitly, a TRAIL is implicitely used but:
# - default settings
# - only LookupEvents()
#Only for current REGION
#Max 5 per REGION
TRAIL.TrailARN #TRAIL_ARN. arn:aws:cloudtrail:REGION:ACCOUNT_ID:trail/TRAIL
TRAIL.Name #'TRAIL'. Max 128 chars, [[:alnum:]._-]
TRAIL_REQ.trailNameList #ARR of 'TRAIL'|TRAIL_ARN
AWS::CloudTrail::Trail #RESPROPs: TrailName
#RESATTRs: Arn
new Trail(...ARGS[, OPTS]) #CTRAIL. CKRESOURCE wrapping TRAIL
CTRAIL.trailArn
OPTS.trailName #TRAIL.*
/=+===============================+=\
/ : : \
)==: TRAIL REGION :==(
\ :_______________________________: /
\=+===============================+=/
TRAIL.HomeRegion #'REGION' of TRAIL
TRAIL.IsMultiRegionTrail #BOOL (def: false, recommended: true). Whether to log SERVICEs from other REGIONs.
DATASTORE.MultiRegionEnabled #For TRAIL, it duplicates it across REGIONs ("shadow TRAIL").
CHANNEL_SOURCE.ApplyToAllRegions #Shadow TRAILs can be used for CloudTrail ACTIONs but:
# - only readonly ones
# - only for its own REGION
#LOG_FILE|DIGEST_FILE:
# - processed in own REGION, by shadow TRAIL
# - including signing with PUBLIC_KEY, which is REGION-specific
# - including REGION shown in filename
# - but sent to a single LOG_BUCKET, in a single REGION
# - same for SNS notification
TRAIL_REQ.includeShadowTrails #BOOL (def: true)
TRAIL.IncludeGlobalServiceEvents #BOOL (def: true). Whether to log global SERVICEs (e.g. IAM, STS (if v1Token), CloudFront)
#If using TRAILs:
# - in multiple REGIONs but with TRAIL.IsMultiRegionTrail false
# - then should set IncludeGlobalServiceEvents to false in all TRAILs but one, to avoid duplicated EVENTs
# - if TRAIL.IsMultiRegionTrail true though, no issue
#Global SERVICEs are:
# - processed in TRAIL's HomeRegion
# - shown as REGION us-east-1 in LOG_FILE
# - shown as REGION where it occurred in EVENT.*
AWS::CloudTrail::Trail #Includes RESPROPs: IsMultiRegionTrail, IncludeGlobalServiceEvents
AWS::CloudTrail::EventDataStore #Includes RESPROPs: MultiRegionEnabled
CTRAIL_OPTS.isMultiRegionTrail #BOOL (def: true). TRAIL.IsMultiRegionTrail
CTRAIL_OPTS
.includeGlobalServiceEvents #BOOL (def: true). TRAIL.IncludeGlobalServiceEvents
/=+===============================+=\
/ : : \
)==: ORG :==(
\ :_______________________________: /
\=+===============================+=/
RegisterOrganization #Req: ORG_ADMIN
DelegatedAdmin() # - DelegatedAdminAccountId -> MemberAccountId
#Res: empty
DeregisterOrganization #Req: ORG_ADMIN
DelegatedAdmin() #Res: empty
ORG_ADMIN.DelegatedAdminAccountId #ACCOUNT_ID. Give same permissions as ORG's management ACCOUNT, for CloudTrail only
#Requires PACTIONs organizations:[De]registerDelegatedAdministrator|ListAWSServiceAccessForOrganization
#Max 3 per ORG
TRAIL.IsOrganizationTrail #BOOL (def: false). Log SERVICEs from all ACCOUNTs in ORG
DATASTORE.OrganizationEnabled #Work similarly to TRAIL.IsMultiRegionTrail:
# - use shadow TRAILs, which are ACCOUNT-specific
# - LOG_FILE|DIGEST_FILE processed in own ACCOUNT, but sent to single LOG_BUCKET
#Requires PACTION organizations:ListAWSServiceAccessForOrganization
TRAIL_PREFIX/AWSLogs/ORG
/ACCOUNT_ID/... #Instead of TRAIL_PREFIX/AWSLogs/ACCOUNT_ID/... if TRAIL.IsOrganizationTrail true
aws validate-logs --account-id #ACCOUNT_ID. Noop unless TRAIL.IsOrganizationTrail true
AWSServiceRoleForCloudTrail #SERVICE_LINKED_ROLE used by TRAIL.IsOrganizationTrail, DATASTORE.OrganizationEnabled and ORG_ADMIN.DelegatedAdminAccountId
#Created automatically by ACTIONs setting those properties
# - providing has PACTIONs iam:CreateServiceLinkedRole|GetRole and organizations:EnableAWSServiceAccess
#Can only be assumed by SERVICE_DOMAIN 'cloudtrail.amazonaws.com'
CloudTrailServiceRolePolicy #POLICY used by AWSServiceRoleForCloudTrail, which allows PACTIONs:
# - cloudtrail:*
# - organizations:ListAWSServiceAccessForOrganization|ListAccounts|DescribeOrganization|DescribeAccount
# - organizations:ListDelegatedAdministrators, if PRINCIPAL 'cloudtrail.amazonaws.com'
AWS::CloudTrail::Trail #Includes RESPROPs: IsOrganizationTrail
AWS::CloudTrail::EventDataStore #Includes RESPROPs: OrganizationEnabled
CTRAIL_OPTS.isOrganizationTrail #TRAIL.*
/=+===============================+=\
/ : : \
)==: TRAIL STATUS :==(
\ :_______________________________: /
\=+===============================+=/
StartLogging|StopLogging() #Req: TRAIL
# - Name + TrailARN -> Name
#Res: empty
#Sets TRAIL_STATUS.IsLogging
GetTrailStatus() #Req: TRAIL
# - Name + TrailARN -> Name
#Res: TRAIL_STATUS
TRAIL_STATUS.IsLogging #BOOL (def: false). Whether TRAIL is enabled.
TRAIL_STATUS.StartLoggingTime #Most recent DATE_NUM, if IsLogging true
TRAIL_STATUS.StopLoggingTime #Most recent DATE_NUM, if IsLogging false
AWS::CloudTrail::Trail #Includes RESPROPs: IsLogging
TRAIL_STATUS.isLogging #Def true with CTRAIL
/=+===============================+=\
/ : : \
)==: LOG FILE :==(
\ :_______________________________: /
\=+===============================+=/
TRAIL.S3BucketName #S3 'LOG_BUCKET' to store LOG_FILE
#Can be in a different REGION|ACCOUNT than TRAIL
#Can use S3 to encrypt, archive|rotate, etc.
TRAIL.S3KeyPrefix #'TRAIL_PREFIX' (def: none). Max 200 chars
PERMISSIONS ==> #Must allow PACTIONs to Principal.Service 'cloudtrail.amazonaws.com':
# - s3:PutObject on arn:aws:s3:::LOG_BUCKET/TRAIL_PREFIX/AWSLogs/ACCOUNT_ID/*
# - COND_KEY aws:SourceArn TRAIL_ARN
# - COND_KEY s3:x-amz-acl 'bucket-owner-full-control'
# - s3:GetBucketAcl on arn:aws:s3:::LOG_BUCKET
# - COND_KEY aws:SourceArn TRAIL_ARN
##With Pulumi AWSX, TRAIL automatically creates a BUCKET POLICY
TRAIL|DATASTORE.KmsKeyId #S3 KMS_KEY_MID|ARN x-amz-server-side-encryption-aws-kms-key-id [C|S]
#Requires some kms:* PACTIONs (see S3 doc)
LOG DELIVERY ==> #LOG_FILE created every 5 mins
#Sometimes delivers same LOG_EVENT twice
TRAIL_STATUS.LatestDeliveryTime #DATE_NUM
TRAIL_STATUS.LatestDeliveryError #Last log delivery 'ERROR', due to issue with LOG_BUCKET
TRAIL_PREFIX/AWSLogs
/ACCOUNT_ID/CloudTrail
/REGION/YYYY/MM/DD/
ACCOUNT_ID_CloudTrail_REGION_
YYYYMMDDTHHMMZ_RANDOM.json.gz #'LOG_FILE'
CLOUDTRAIL PROCESSING LIBRARY ==> #Java library that allows running code on each new LOG_EVENT
#Uses a SQS QUEUE
#Could also achieve this using S3 Object Lambda, S3 Batch, or S3 NOTIFICATIONS_LAMBDA
#Not documented yet
trailscraper ##Version 0.8.1
--verbose ##
trailscraper download ##Download LOG_FILE
##Requires PACTIONs s3::ListBucket
--org-id ##ORG_ID
##Can be specified multiple times
--account-id ##ACCOUNT_ID
##Can be specified multiple times
--region ##'REGION'
--bucket ##S3 'BUCKET'
--prefix ##S3 'PREFIX' (including trailing slash)
--log-dir ##Output 'DIR' (def: '~/.trailscraper/logs')
##Filename is same as LOG_FILE's
--from ##'DATE' or 'DURATION' (def: '-1days')
##Year|month|day, not hour|minute|seconds
##Format: see `dateparser` Python package
--to ##'DATE', 'DURATION' or 'now' (def)
--wait ##BOOL (def: false). Wait until LOG_EVENTs after --to are found
--parallelism ##NUM (def 10) of files to download in parallel
AWS::CloudTrail::Trail #Includes RESPROPs: S3BucketName, S3KeyPrefix
AWS::CloudTrail::
Trail|EventDataStore #Includes RESPROPs: KMSKeyId
CTRAIL_OPTS.bucket #ICBUCKET. TRAIL.S3BucketName
#Def: new one
# - CBUCKET_OPTS.enforceSSL true
# - allows PACTIONs to cloudtrail.amazonaws.com:
# - s3:PutObject, with COND_KEY s3:x-amz-acl 'bucket-owner-full-control'
# - s3:GetBucketAcl
# - no COND_KEY aws:SourceArn
CTRAIL_OPTS.s3KeyPrefix #TRAIL.*
CTRAIL_OPTS.encryptionKey #KMS ICKEY. TRAIL.KmsKeyId
/=+===============================+=\
/ : : \
)==: LOG FIELDS :==(
\ :_______________________________: /
\=+===============================+=/
LOG_FILE #Some of the fields are optional
#Max 50MB
LOG_FILE.Records #LOG_EVENT_ARR
LOG_EVENT #Max 256KB
LOG_EVENT.eventVersion #Current: '1.09'
LOG_EVENT.eventID #EVENT_MID
LOG_EVENT.eventTime #'DATE'
LOG_EVENT.eventSource #'SERVICE_DOMAIN'
LOG_EVENT.apiVersion #SERVICE's version
LOG_EVENT.awsRegion #'REGION'
LOG_EVENT.eventName #'ACTION'
LOG_EVENT.eventType #STR, among:
# - 'AwsApiCall': normal ACTION
# - 'AwsConsoleAction': ACTION from UI console
# - 'AwsConsoleSignIn': ACTION 'ConsoleLogin|CheckMfa'
# - 'AwsServiceEvent': service EVENT
# - 'AwsCloudTrailInsight': INSIGHT
# - 'ActivityLog': audit EVENT
LOG_EVENT.readOnly #BOOL. Whether is readonly ACTION
LOG_EVENT.eventCategory #STR among:
# - 'Data': data EVENT
# - 'Management': management EVENT
# (TRAIL-only)
# - 'Insight': INSIGHT EVENT
# (DATASTORE-only)
# - 'ActivityAuditLog': audit EVENT
# - 'ConfigurationItem': AWS Config items
# - 'Evidence': Audit manager
LOG_EVENT.managementEvent #BOOL. Whether is management EVENT
LOG_EVENT.recipientAccountId #ACCOUNT_ID that received the EVENT
LOG_EVENT.sharedEventID #MID that is shared by EVENTs created in each ACCOUNT of a cross-ACCOUNT call
LOG_EVENT.sourceIPAddress #'IP'. If from a SERVICE, either 'SERVICE_DOMAIN' or 'AWS Internal/INTERNAL_ID'
LOG_EVENT.userAgent #STR of User-Agent [C]. Can also be:
# - 'signin.amazonaws.com': UI console, as USER
# - 'console.amazonaws.com': UI console, as root
# - 'lambda.amazonaws.com': inside a Lambda FUNCTION
# - 'AWS Internal/INTERNAL_ID'
LOG_EVENT
.sessionCredentialFromConsole #'BOOL'. Whether done from UI console
LOG_EVENT.requestID #REQ_ID
LOG_EVENT.requestParameters #PARAMS_OBJ
#Truncate over 100KB
LOG_EVENT.responseElements #RESP_OBJ|null
#Truncate over 100KB
#Some SERVICEs do not send it
LOG_EVENT.errorCode #'CODE'. Some SERVICEs show it in LOG_EVENT.responseElements instead
LOG_EVENT.errorMessage #Same with 'ERROR'
#Truncate over 1KB
LOG_EVENT.additionalEventData #OBJ. Used for some information not present in PARAMS|RESP.
#Called CLOUDTRAIL_METADATA in my doc
#Truncate over 28KB
LOG_EVENT.serviceEventDetails #OBJ. Similar to LOG_EVENT.additionalEventData but when LOG_EVENT.eventType 'AwsServiceEvent'.
#Called CLOUDTRAIL_SMETADATA in my doc
#Truncate over 100KB
LOG_EVENT.resources #LOG_RESOURCE_ARR. ARNs of resources impacted by EVENT
LOG_RESOURCE.ARN #ARN
LOG_RESOURCE.type #'RESTYPE'
LOG_RESOURCE.accountId #ACCOUNT_ID
LOG_EVENT.userIdentity #IDENTITY that created the EVENT
IDENTITY|ISSUER.type #One of:
# - 'Root': ROOT
# - 'IAMUser': USER
# - 'Role': ROLE
# - 'AssumedRole': ASSUMED_ROLE
# - 'SAMLUser': SAML_ROLE
# - 'WebIdentityUser': WEB_ID_ROLE
# - 'FederatedUser': FEDERATED_USER
# - 'IdentityCenterUser': Identity center
# - 'AWSAccount': another ACCOUNT, i.e. cross-ACCOUNT call
# - 'AWSService': SERVICE_DOMAIN
# - 'Directory': AWS WorkDocs|QuickSight
# - 'Unknown'
IDENTITY|ISSUER.arn #IDENTITY ARN, e.g. ROLE_ARN
IDENTITY|ISSUER.principalId #IDENTITY ID, e.g. ROLE_MID
#With:
# - 'SAMLUser': SAML_ROLE.NameQualifier + SAML_ROLE.Subject
# - 'WebIdentityUser': WEB_ID_ROLE.Provider + APP_ID + USER_ID
IDENTITY|ISSUER.userName #'IDENTITY' name, among:
# - 'IAMUser': 'USER'
# - 'Role': 'ROLE'
# - 'SAMLUser': SAML_ROLE.Subject
# - 'WebIdentityUser': USER_ID
# - 'Root|Directory': 'ACCOUNT_ALIAS' (if defined)
IDENTITY|ISSUER.identityProvider #Only with:
# - 'SAMLUser': SAML_ROLE.NameQualifier
# - 'WebIdentityUser': Web_ID_ROLE.Provider
IDENTITY|ISSUER.accountId #ACCOUNT_ID
IDENTITY.accessKeyId #ACCESS_KEY_ID. Sometimes empty
IDENTITY.invokedBy #'SERVICE_DOMAIN', if LOG_EVENT.eventType 'AwsServiceEvent'
IDENTITY.sessionContext #SESSION_CONTEXT. Only if type 'AssumedRole|SAMLUser|WebIdentityUser|FederatedUser'
SESSION_CONTEXT.sessionIssuer #ISSUER who granted TEMP_CREDS:
# - ROLE if 'AssumedRole|SAMLUser|WebIdentityUser'
# - ROOT|USER if 'FederatedUser'
SESSION_CONTEXT.sourceIdentity #STR. ASSUMED_ROLE_USER.SourceIdentity
SESSION_CONTEXT.attributes #SESSION_ATTRS
SESSION_ATTRS.creationDate #'DATE'
SESSION_ATTRS.mfaAuthenticated #'BOOL'
IDENTITY.webIdFederationData #FEDERATION_DATA. Only if type 'WebIdentityUser'
FEDERATION_DATA.federatedProvider #'DOMAIN'
FEDERATION_DATA.attributes #'APP_ID:USER_ID'
LOG_EVENT.tlsDetails #TLS_DETAILS
TLS_DETAILS.tlsVersion #'TLSv1.X'
TLS_DETAILS.cipherSuite #STR, e.g. 'ECDHE-RSA-AES128-GCM-SHA256'
TLS_DETAILS
.clientProvidedHostHeader #Host [C], e.g. 'SERVICE_DOMAIN'
LOG_EVENT.addendum #LOG_ADDENDUM. Describes why EVENT was updated by AWS after creation, or is missing
LOG_ADDENDUM.reason #STR among:
# - 'SERVICE_OUTAGE': missing EVENT due to outage of AWS SERVICE
# - 'DELIVERY_DELAY': delayed EVENT due to network speed|issue
# - 'UPDATED_DATA': missing|incorrect EVENT field was updated
LOG_ADDENDUM.updatedFields #'PROP'_ARR, if reason 'UPDATED_DATA'
LOG_ADDENDUM.originalEventID #Original's EVENT.eventID, if reason 'UPDATED_DATA'
LOG_ADDENDUM.originalRequestID #Original's EVENT.requestID, if reason 'UPDATED_DATA'
/=+===============================+=\
/ : : \
)==: EVENTS LOOKUP :==(
\ :_______________________________: /
\=+===============================+=/
LookupEvents() #Req: EVENTS_REQ
#Res: Events EVENT_ARR
EVENTS_REQ #List LOG_EVENTs
#Only management|INSIGHT EVENTs
#Max 2/s per REGION
EVENTS_REQ.StartTime|EndTime #DATE_NUM. Filter by EVENT.EventTime
#Def|min StartTime: 90 days ago
EVENTS_REQ.EventCategory #Either default ('management') or 'insight'. Filter by LOG_EVENT.eventCategory.
EVENTS_REQ.LookupAttributes #EVENT_ATTR_ARR
EVENT_ATTR.AttributeKey #'PROP' to filter on, of EVENT[_RESOURCE] (except CloudTrailEvent|EventTime)
EVENT_ATTR.AttributeValue #STR
EVENT.CloudTrailEvent #'LOG_EVENT_JSON'
EVENT.EventTime
EVENT.EventId
EVENT.EventSource
EVENT.EventName
EVENT.ReadOnly #LOG_EVENT.*
EVENT.Username
EVENT.AccessKeyId #IDENTITY.*
EVENT.Resources #EVENT_RESOURCE_ARR
EVENT_RESOURCE.ResourceType #LOG_RESOURCE.type, as 'RESOURCE' only, e.g. 'AWS::EC2::Instance' -> 'Instance'
EVENT_RESOURCE.ResourceName #LOG_RESOURCE.arn, as 'NAME'|MID only
trailscraper select ##List LOG_EVENTs, printed as ALL_LOG_EVENTS
##Compared to LookupEvents():
## - pro: can use offline download of LOG_FILEs
## - con: much fewer filtering options
--log-dir
--from
--to ##Like `trailscraper download`
--use-cloudtrail-api ##Call LookupEvents()
##Def: use --log-dir instead, after `trailscraper download`
--filter-assumed-role-arn ##ROLE_ARN that performed LOG_EVENT
##I.e. Filter by LOG_EVENT.userIdentity.sessionContext.sessionIssuer.arn,
##with LOG_EVENT.userIdentity.type 'AssumedRole'
##Can be specified multiple times
ALL_LOG_EVENTS ##JSON_OBJ: Records LOG_EVENT_ARR
trailscraper last-event-timestamp##Print most recent LOG_EVENT.eventTime
--log-dir ##Like `trailscraper download`
/=+===============================+=\
/ : : \
)==: POLICY GENERATION :==(
\ :_______________________________: /
\=+===============================+=/
trailscraper generate ##Print IAM POLICY_DOC allowing all actions from a list of LOG_EVENTs
##Must pass ALL_LOG_EVENTS as stdin
##STATEMENT:
## - Action: LOG_EVENT.eventSource|eventName
## - maps some often-used PACTIONs that do not match same name,
## e.g. 's3:CreateMultipartUpload' -> 's3:PutObject', or ApiGateway
## - Resource: LOG_EVENT.Resources[*].ARN
trailscraper guess ##Transform IAM POLICY_DOC to add all ACTIONs on same SERVICE + resource
##E.g. s3:PutObject -> s3:PutObject|GetObject|ListObjects|...
##Must pass POLICY DOC as stdin
--only ##STR. Only ACTIONs starting with STR
##Among: 'Create', 'Put', 'Update', 'List', 'Describe', 'Get', 'Delete', 'Attach', 'Detach'
##Can be specified multiple times
/=+===============================+=\
/ : : \
)==: LOG INTEGRITY :==(
\ :_______________________________: /
\=+===============================+=/
TRAIL.LogFileValidationEnabled #BOOL (def: false). Enables digest delivery
##With CloudFormation, can use AwsCommunity::CloudTrail::LogValidationEnabled HOOK to ensure it is true
DIGEST DELIVERY ==> #DIGEST_FILE created every 1h
TRAIL_STATUS
.LatestDigestDeliveryTime #DATE_NUM
TRAIL_STATUS
.LatestDigestDeliveryError #Last log delivery 'ERROR', due to issue with LOG_BUCKET
TRAIL_PREFIX/AWSLogs
/ACCOUNT_ID/CloudTrail-Digest
/REGION/YYYY/MM/DD/ACCOUNT_ID_
CloudTrail-Digest_REGION_TRAIL_ #'DIGEST_FILE'
REGION_YYYYMMDDTHHMMSSZ.json.gz #First 2 REGIONs are of the LOG_BUCKET, last is TRAIL's HomeRegion
DIGEST_FILE #List of LOG_FILEs for a given period
#Meant to ensure their integrity
DIGEST_FILE.awsAccountId #ACCOUNT_ID
DIGEST_FILE.digestStartTime #'DATE'
DIGEST_FILE.digestEndTime #'DATE' (1h later)
DIGEST_FILE.oldestEventTime #'DATE' of first EVENT
#Can be < digestStartTime if digest delivery was slow
#null if DIGEST_FILE.logFiles empty
DIGEST_FILE.newestEventTime #'DATE' of last EVENT
#null if DIGEST_FILE.logFiles empty
DIGEST_FILE.digestS3Bucket
DIGEST_FILE.digestS3Object #'BUCKET|OBJECT' where DIGEST_FILE is located
DIGEST_FILE.logFiles #DIGEST_LOG_FILE_ARR. Can be empty.
DIGEST_LOG_FILE.s3Bucket
DIGEST_LOG_FILE.s3Object #'BUCKET|OBJECT' where OBJECT_FILE is located
DIGEST_LOG_FILE.hashValue #'SHA256_HEX' of uncompressed LOG_FILE
#Goal: ensure LOG_FILE's integrity
DIGEST_LOG_FILE.hashAlgorithm #Always 'SHA-256'
DIGEST_LOG_FILE.oldestEventTime #'DATE' of first EVENT
DIGEST_LOG_FILE.newestEventTime #'DATE' of last EVENT. Also LOG_FILE's timestamp
AWS::CloudTrail::Trail #Includes RESPROPs: EnableLogFileValidation BOOL
CTRAIL_OPTS.enableFileValidation #BOOL (def: true). TRAIL.LogFileValidationEnabled
/=+===============================+=\
/ : : \
)==: DIGEST INTEGRITY :==(
\ :_______________________________: /
\=+===============================+=/
ListPublicKeys() #Req: PUBLIC_KEY
# - only ValidityStart|EndTime -> Start|EndTime (def: now)
#Res: PublicKeyList PUBLIC_KEY_ARR
PUBLIC_KEY #Used to validate x-amz-meta-signature [S] and QUERY_RESULTS_SIGN
PUBLIC_KEY.Value #Public key as 'BASE64', DER-encoded PKCS#1
PUBLIC_KEY.Fingerprint #'HEX' of fingerprint
PUBLIC_KEY.ValidityStart|EndTime #DATE_NUM where public key might have been used
x-amz-meta-signature: STR [S] #'HEX'. RSA signature of DIGEST_FILE, with AWS private key
#When retrieving DIGEST_FILE on S3
#Goal: ensure integrity of DIGEST_FILE itself
#STR being signed is newline-concatenation of:
# - DIGEST_FILE.digestEndTime
# - BUCKET/OBJECT of DIGEST_FILE.digestS3Bucket|Object
# - 'SHA256_HEX' of uncompressed DIGEST_FILE
# - DIGEST_FILE.previousDigestHashValue
x-amz-meta-signature-algorithm:
STR [S]
DIGEST_FILE
.digestSignatureAlgorithm #Always 'SHA256withRSA'
DIGEST_FILE
.digestPublicKeyFingerprint #PUBLIC_KEY.Fingerprint
DIGEST_FILE #DIGEST.digestS3Bucket|Object of last DIGEST_FILE
.previousDigestS3Bucket|Object #Goal: ensure the full list of DIGEST_FILEs is complete, with no missing DIGEST_FILE
#When [re]setting TRAIL.LogFileValidationEnabled true, an initial DIGEST_FILE is created,
#with DIGEST_FILE.previous* null
DIGEST_FILE
.previousDigestHashValue #'SHA256_HEX' of last uncompressed DIGEST_FILE
DIGEST_FILE
.previousDigestHashAlgorithm #Always 'SHA-256'
DIGEST_FILE
.previousDigestSignature #Like x-amz-meta-signature [S] but for previous DIGEST_FILE
/=+===============================+=\
/ : : \
)==: INTEGRITY VALIDATE :==(
\ :_______________________________: /
\=+===============================+=/
aws cloudtrail validate-logs #Validate LOG_FILEs|DIGEST_FILEs in a time period, using hashes and signatures
#CLI-only
--trail-arn #TRAIL_ARN
--start-time #'DATE'
--end-time #'DATE' (def: now)
--s3-bucket
--s3-prefix #'BUCKET|OBJECT' of DIGEST_FILE (def: last one)
--verbose #BOOL. Whether to print LOG_VALIDATION_RES_LINEs.
#If false (def), only for main DIGEST_FILE.
OUTPUT ==> #One LOG_VALIDATION_RES_LINE per DIGEST_FILE|LOG_FILE, as TSV
#Then:
# - DIGEST_FILE.oldest|newestEventTime
# - NUM of DIGEST_FILEs|LOG_FILEs [in]valid
LOG_VALIDATION_RES_LINE[0] #'Digest file' or 'Log file'
LOG_VALIDATION_RES_LINE[1] #'s3://LOG_BUCKET/OBJECT'
LOG_VALIDATION_RES_LINE[2] #'valid' or 'INVALID: ...'
/=+===============================+=\
/ : : \
)==: SNS :==(
\ :_______________________________: /
\=+===============================+=/
TRAIL.SnsTopicARN #SNS_TOPIC_ARN to send on log delivery, with SNS_PAYLOAD
TRAIL.SnsTopicName #Same but as 'SNS_TOPIC'
PERMISSIONS ==> #Must allow:
# - Principal.Service 'cloudtrail.amazonaws.com'
# - PACTION sns:Publish on the TOPIC
# - COND_KEY aws:SourceArn TRAIL_ARN
# - also PACTION kms:GenerateDataKey*|Decrypt, if TOPIC uses KMS
SNS_PAYLOAD.s3Bucket #'LOG_BUCKET'
SNS_PAYLOAD.s3ObjectKey #'LOG_FILE'_ARR
TRAIL_STATUS
.LatestNotificationError
TRAIL_STATUS
.LatestNotificationTime #Same as LatestDelivery* but for SNS notifications
AWS::CloudTrail::Trail #Includes RESPROPs: SnsTopicName
#Includes RESATTRs: SnsTopicArn
CTRAIL_OPTS.snsTopic #CTOPIC. TRAIL.SnsTopicName
#Automatically allows sns:Publish to cloudtrail.amazonaws.com
CTRAIL.trailSnsTopicArn #'TOPIC_ARN'_CSATTR. TRAIL.SnsTopicARN
/=+===============================+=\
/ : : \
)==: CLOUDWATCH LOGS :==(
\ :_______________________________: /
\=+===============================+=/
TRAIL.CloudWatchLogsLogGroupArn #LOG_GROUP_ARN. Send LOG_EVENTs to CloudWatch Logs
#Must be same ACCOUNT
#LOG_EVENTs >256KB silently ignored
##With Pulumi AWSX, specifying this automatically creates LOG_GROUP
## - can use skipDestroy
TRAIL.CloudWatchLogsRoleArn #ROLE_ARN used to send to CloudWatch Logs
#Used instead of CloudWatch Logs RESOURCE_POLICY.policyDocument
#Trust policy must use Principal.Service 'cloudtrail.amazonaws.com'
#Must allow:
# - PACTION logs:PutLogEvents|CreateLogStream
# - on LOG_STREAMs:
# - 'ACCOUNT_ID_CloudTrail_REGION*'
# - 'ORG_*', if TRAIL.IsOrganizationTrail true
TRAIL_STATUS.LatestCloudWatchLogs
DeliveryTime #DATE_NUM
TRAIL_STATUS.LatestCloudWatchLogs
DeliveryError #'ERROR'
AWS::CloudTrail::Trail #Includes RESPROPs: CloudWatchLogsLogGroupArn, CloudWatchLogsRoleArn
CTRAIL_OPTS.sendToCloudWatchLogs #BOOL. If false (def), ignore CTRAIL_OPTS.cloudWatchLogGroup
CTRAIL.logGroup #ICLOG_GROUP (def: new one). TRAIL.CloudWatchLogsLogGroupArn
CTRAIL_OPTS.cloudWatchLogGroup #Automatically creates TRAIL.CloudWatchLogsRoleArn
CTRAIL_OPTS
.cloudWatchLogsRetention #CLOG_GROUP_OPTS.retention (def: 1y), when using default CTRAIL_OPTS.cloudWatchLogGroup
/=+===============================+=\
/ : : \
)==: SELECTORS :==(
\ :_______________________________: /
\=+===============================+=/
PutEventSelectors() #Req: SELECTORS
# - TrailName + TrailARN -> TrailName
#Res: SELECTORS
# - no TrailName
GetEventSelectors() #Req: SELECTORS
# - TrailName + TrailARN -> TrailName
#Res: SELECTORS
# - no TrailName
SELECTORS #Filter which EVENTs are logged by a TRAIL
#Def: one ADVANCED_SELECTOR, filtering for eventCategory 'Management' only
SELECTORS.TrailARN #TRAIL_ARN
SELECTORS.TrailName #'TRAIL'
SELECTORS.EventSelectors #SELECTOR_ARR, or'd
#Max 5
SELECTOR.ReadWriteType #Whether to log ACTIONs that are:
# - 'ReadOnly': e.g. Get|List*()
# - 'WriteOnly': not read-only
# - 'All' (def)
SELECTOR.IncludeManagementEvents #BOOL (def: true). Whether to log management EVENTs
#Those are from MANAGEMENT_ACTIONs, i.e. ones triggered directly by AWS users, usually not called frequently
#Those can also be "service EVENTs":
# - i.e. DEPENDENT_ACTION or SERVICE_ASYNC_ACTION
# - "non-API events": service EVENTs + IAM 'ConsoleLogin'
SELECTOR #'SERVICE_DOMAIN'_ARR (def: empty) to exclude
.ExcludeManagementEventSources #Only for management EVENTs
#Only for SERVICEs generating lots of EVENTs: 'kms|rdsdata.amazonaws.com'
SELECTOR.DataResources #DATA_RESOURCE_ARR (def: empty). Which data EVENTs to include
#Those are from DATA_ACTIONs, i.e. ones triggered indirectly by AWS users' users, usually called frequently
# - documented in each SERVICE's doc
#When using SELECTOR (as opposed to ADVANCED_SELECTOR), can only log:
# - S3 OBJECTs
# - Lambda FUNCTIONs
# - DynamoDB TABLEs
#Max 250 among all SELECTORS.EventSelectors
DATA_RESOURCE.Type #'RESTYPE'
DATA_RESOURCE.Values #ARN_ARR
#If there is a NAMEPATH, can use it if trailing slash
# - e.g. arn:aws:s3:::BUCKET/[NAMEPATH/] to target multiple OBJECTs
#Can also be arn:aws:SERVICE for all supported RESOURCEs of that SERVICE
# - for S3: 'arn:aws:s3:::'
SELECTORS|CHANNEL_SOURCE|DATASTORE#ADVANCED_SELECTOR_ARR, or'd
.AdvancedEventSelectors #Cannot use both SELECTORs and ADVANCED_SELECTORs
#Max 2KB per STR in FIELD_SELECTOR.*
ADVANCED_SELECTOR.Name #STR. Description. Max 1000 chars
ADVANCED_SELECTOR.FieldSelectors #FIELD_SELECTOR_ARR
#Max 500 among all SELECTORS.AdvancedEventSelectors
FIELD_SELECTOR.Field #STR. Available name and their values:
# - eventName 'ACTION,...'
# - readOnly BOOL: true|false|def is like SELECTOR.ReadWriteType 'ReadOnly|WriteOnly|All'
# - eventCategory STR: LOG_EVENT.eventCategory
# - eventSource 'SERVICE_DOMAIN': like SELECTOR.ExcludeManagementEventSources
# - resources.type 'RESTYPE': like DATA_RESOURCE.Type
# - resources.ARN ARN: like DATA_RESOURCE.Values
FIELD_SELECTOR.Equals #STR_ARR
#Only possible one with FIELD_SELECTOR.Field 'readOnly|eventCategory|resources.type'
FIELD_SELECTOR.NotEquals #STR_ARR
#Only possible one with FIELD_SELECTOR.Field 'eventSource'
FIELD_SELECTOR
.[Not]Starts|EndsWith #STR_ARR
TRAIL.HasCustomEventSelectors #BOOL. True if there are SELECTORS.
AWS::CloudTrail::Trail #Includes RESPROPs: EventSelectors
AWS::CloudTrail::
Trail|EventDataStore #Includes RESPROPs: AdvancedEventSelectors
/=+===============================+=\
/ : : \
)==: SELECTORS CDK :==(
\ :_______________________________: /
\=+===============================+=/
CTRAIL_OPTS.managementEvents #SELECTOR.ReadWriteType. SELECTOR with IncludeManagementEvents true and no DATA_RESOURCE
#Can be NONE, i.e. no SELECTOR
CTRAIL.addEventSelector
('RESTYPE', 'ARN'_ARR[, OPTS]) #SELECTOR with a single DATA_RESOURCE
OPTS.readWriteType
|excludeManagementEventSources #SELECTOR.*
OPTS.includeManagementEvents #SELECTOR.*
#Def: false if CTRAIL_OPTS.managementEvents NONE, true otherwise
CTRAIL
.logAllS3DataEvents([OPTS]) #Same but with RESTYPE 'AWS::S3::Object' and 'arn:aws:s3:::' ARN (i.e. any OBJECT)
CTRAIL.addS3EventSelector #Same but with RESTYPE 'AWS::S3::Object' and OBJECT_ARN
(OBJ_ARR[, OPTS]) #OBJ_ARR:
# - bucket ICBUCKET
# - objectPrefix 'PREFIX' (def: any)
CTRAIL
.logAllLambdaDataEvents([OPTS]) #Same but with RESTYPE 'AWS::Lambda::Function' and 'arn:aws:lambda' ARN (i.e. any FUNCTION)
CTRAIL.addLambdaEventSelector
(ICANYFUNC_ARR[, OPTS]) #Same but with RESTYPE 'AWS::Lambda::Function' and FUNCTION_ARN
/=+===============================+=\
/ : : \
)==: INSIGHT MAIN :==(
\ :_______________________________: /
\=+===============================+=/
PutInsightSelectors() #Req: INSIGHT
# - TrailName + TrailARN -> TrailName
#Res: INSIGHT
# - no TrailName
GetInsightSelectors() #Req: INSIGHT
# - only TrailName + TrailARN -> TrailName
# - only EventDataStore + EventDataStoreArn -> EventDataStore
#Res: INSIGHT
# - no TrailName
INSIGHT #Logs unusual ACTIONs to INSIGHT_FILE
#Checks for big changes from the "baseline"
# - average/minute, in last 7d
# - on the first minute that deviates
# - but INSIGHT_FILE created every 30m
# - one EVENT for start, another for end
#Per ACTION
#Use either:
# - 1 source TRAIL, output to S3
# - 1 source DATASTORE, output to another DATASTORE2
#Only for management EVENTs
#Impacted by SELECTORS filtering
# - e.g. if InsightType 'ApiCallRateInsight', SELECTOR.ReadWriteType must not be 'WriteOnly'
INSIGHT.TrailARN #TRAIL_ARN
INSIGHT.TrailName #'TRAIL'
INSIGHT.EventDataStoreArn #Source DATASTORE_ARN
INSIGHT.EventDataStore #Source DATASTORE_MID
INSIGHT.InsightsDestination #Destination DATASTORE_ARN
INSIGHT.InsightSelectors #INSIGHT_SELECTOR_ARR
INSIGHT_SELECTOR.InsightType #Counts only ACTIONs that:
# - 'ApiErrorRateInsight': failed
# - 'ApiCallRateInsight': are not readonly
TRAIL.HasInsightSelectors #BOOL. Whether there are INSIGHT_SELECTORs
AWS::CloudTrail::
Trail|EventDataStore #Includes RESPROPs: InsightSelectors
AWS::CloudTrail::EventDataStore #Includes RESPROPs: InsightsDestination
CTRAIL_OPTS.insightTypes #INSIGHT_SELECTORs. Must be ARR of InsightType.API_ERROR_RATE|API_CALL_RATE
/=+===============================+=\
/ : : \
)==: INSIGHT FILE :==(
\ :_______________________________: /
\=+===============================+=/
TRAIL_PREFIX/AWSLogs
/ACCOUNT_ID/CloudTrail-Insight
/REGION/YYYY/MM/DD/ACCOUNT_ID_
CloudTrail-Insight_REGION_ #'INSIGHT_FILE'
YYYYMMDDTHHMMZ_RANDOM.json.gz #Only with TRAIL, not DATASTORE
INSIGHT_FILE #
INSIGHT_FILE.eventVersion
INSIGHT_FILE.eventID
INSIGHT_FILE.eventTime
INSIGHT_FILE.eventType
INSIGHT_FILE.awsRegion
INSIGHT_FILE.recipientAccountId #Like LOG_FILE.*
INSIGHT_FILE.sharedEventID #MID shared by both 'Start' and 'End' EVENTs
INSIGHT_FILE.insightDetails #INSIGHT_DETAILS
INSIGHT_DETAILS.eventSource
INSIGHT_DETAILS.eventName #Like LOG_FILE.*
INSIGHT_DETAILS.state #'Start|End'
INSIGHT_DETAILS.insightType #INSIGHT_SELECTOR.InsightType
INSIGHT_DETAILS.insightContext #INSIGHT_CONTEXT
INSIGHT_CONTEXT.statistics #INSIGHT_STATS
INSIGHT_STATS.baseline.average #NUM. Baseline average/minute
INSIGHT_STATS.baselineDuration #NUM (in mins)
INSIGHT_STATS.insight.average #Same but for current rate
INSIGHT_STATS.insightDuration #For state 'Start', it is first minute only. For 'End', it is since 'Start'
INSIGHT_CONTEXT.attributions #INSIGHT_ATTRS_ARR
#Top value of some of EVENT's properties, for both baseline and current
INSIGHT_ATTRS.attribute #STR among:
# - 'userIdentityArn': IDENTITY.arn
# - 'userAgent': LOG_EVENT.userAgent
# - 'errorCode': LOG_EVENT.errorCode
INSIGHT_ATTRS.baseline #INSIGHT_ATTR_ARR of top values, for baseline
#Max 5. Sorted.
INSIGHT_ATTRS.insight #Same but for current
INSIGHT_ATTR.value #STR. E.g. IDENTITY.arn for 'userIdentityArn'
INSIGHT_ATTR.average #NUM. Average/minute
/=+===============================+=\
/ : : \
)==: DATA STORE :==(
\ :_______________________________: /
\=+===============================+=/
CreateEventDataStore() #Req: DATASTORE
# - no EventDataStoreArn, CreatedTimestamp, UpdatedTimestamp, Status
# - Status 'STARTING_INGESTION' -> StartIngestion BOOL
#Res: DATASTORE
UpdateEventDataStore() #Req: DATASTORE
# - no CreatedTimestamp, UpdatedTimestamp, Status, TagsList
# - EventDataStoreArn -> EventDataStore
#Res: DATASTORE
# - no TagsList
StartEventDataStoreIngestion() #Req: DATASTORE
# - only EventDataStoreArn -> EventDataStore
#Res: empty
#Sets DATASTORE.Status 'STARTING_INGESTION'
StopEventDataStoreIngestion() #Req: DATASTORE
# - only EventDataStoreArn -> EventDataStore
#Res: empty
#Sets DATASTORE.Status 'STOPPING_INGESTION'
GetEventDataStore() #Req: DATASTORE
# - only EventDataStoreArn -> EventDataStore
#Res: DATASTORE
# - no TagsList
ListEventDataStores() #Req: empty
#Res: EventDataStores DATASTORE_ARR
# - no BillingMode, TagsList
DeleteEventDataStore() #Req: DATASTORE
# - only EventDataStoreArn -> EventDataStore
#Res: empty
RestoreEventDataStore() #Req: DATASTORE
# - only EventDataStoreArn -> EventDataStore
#Res: DATASTORE
# - no TagsList
DATASTORE #Like TRAIL but accessed through SQL QUERYs
#Stores EVENTs internally:
# - in ORC format
# - no S3|LOG_FILE
#Can also add audit EVENTs (partner|custom data)
#Features related to DATASTORE|CHANNEL|AUDIT_EVENTs are called "CloudTrail lake"
#DATASTORE.AdvancedEventSelectors must allow only one LOG_EVENT.eventCategory
# - if 'Management|Data': automatically filled
# - can be 'ActivityAuditLog': audit EVENTs
# - can be 'Insight'
#Max 10 per REGION
DATASTORE.EventDataStoreArn #DATASTORE_ARN. 'arn:aws:cloudtrail:REGION:ACCOUNT_ID:eventdatastore/DATASTORE'
DATASTORE.Name #'DATASTORE'
DATASTORE.CreatedTimestamp #DATE_NUM
DATASTORE.UpdatedTimestamp #DATE_NUM
DATASTORE.Status #One of:
# - 'CREATED'
# - 'STARTING_INGESTION', then 'ENABLED'
# - 'STOPPING_INGESTING', then 'STOPPED_INGESTION'
# - 'PENDING_DELETION'
DATASTORE #BOOL (def: true). Do not allow deleting DATASTORE
.TerminationProtectionEnabled #If false, deleting DATATORE waits 7 days to complete,
#during which deletion can be undone with RestoreEventDataStore()
DATASTORE.RetentionPeriod #NUM. Delete audit EVENTs after NUM days.
#Depending on DATASTORE.BillingMode:
# - 'EXTENDABLE_RETENTION_PRICING': def 1 year, max 10 years
# - 'FIXED_RETENTION_PRICING': def|max 7 years
#Min 7 days
#Decreasing default value does not change S3 cost, but increasing does
DATASTORE.BillingMode #'EXTENDABLE_RETENTION_PRICING' (def) or 'FIXED_RETENTION_PRICING'. Pricing option (see above)
AWS/CloudTrail/HourlyDataIngested #CloudWatch METRIC with bytes/hour processed by DATASTORE
AWS/CloudTrail/TotalDataRetained #CloudWatch METRIC with total bytes, updated daily
AWS::CloudTrail::EventDataStore #RESPROPs:
# - Name, TerminationProtectionEnabled, RetentionPeriod, BillingMode
# - IngestionEnabled BOOL
#RESATTRs: EventDataStoreArn, CreatedTimestamp, UpdatedTimestamp, Status
/=+===============================+=\