aws-sdk-cloudtrail 1.37.0 → 1.41.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudtrail/client.rb +100 -72
- data/lib/aws-sdk-cloudtrail/types.rb +273 -183
- data/lib/aws-sdk-cloudtrail.rb +1 -1
- metadata +5 -5
@@ -33,7 +33,7 @@ module Aws::CloudTrail
|
|
33
33
|
# @return [String]
|
34
34
|
#
|
35
35
|
# @!attribute [rw] tags_list
|
36
|
-
# Contains a list of
|
36
|
+
# Contains a list of tags, up to a limit of 50
|
37
37
|
# @return [Array<Types::Tag>]
|
38
38
|
#
|
39
39
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/AddTagsRequest AWS API Documentation
|
@@ -45,18 +45,18 @@ module Aws::CloudTrail
|
|
45
45
|
include Aws::Structure
|
46
46
|
end
|
47
47
|
|
48
|
-
# Returns the objects or data
|
49
|
-
#
|
48
|
+
# Returns the objects or data if successful. Otherwise, returns an
|
49
|
+
# error.
|
50
50
|
#
|
51
51
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/AddTagsResponse AWS API Documentation
|
52
52
|
#
|
53
53
|
class AddTagsResponse < Aws::EmptyStructure; end
|
54
54
|
|
55
55
|
# Advanced event selectors let you create fine-grained selectors for the
|
56
|
-
# following
|
57
|
-
#
|
56
|
+
# following CloudTrail event record fields. They help you control costs
|
57
|
+
# by logging only those events that are important to you. For more
|
58
58
|
# information about advanced event selectors, see [Logging data events
|
59
|
-
# for trails][1] in the *
|
59
|
+
# for trails][1] in the *CloudTrail User Guide*.
|
60
60
|
#
|
61
61
|
# * `readOnly`
|
62
62
|
#
|
@@ -144,23 +144,39 @@ module Aws::CloudTrail
|
|
144
144
|
#
|
145
145
|
# * <b> <code>eventName</code> </b> - Can use any operator. You can
|
146
146
|
# use it to filter in or filter out any data event logged to
|
147
|
-
# CloudTrail, such as `PutBucket`. You can
|
148
|
-
# this field, separated by commas.
|
147
|
+
# CloudTrail, such as `PutBucket` or `GetSnapshotBlock`. You can
|
148
|
+
# have multiple values for this field, separated by commas.
|
149
149
|
#
|
150
150
|
# * <b> <code>eventCategory</code> </b> - This is required. It must be
|
151
151
|
# set to `Equals`, and the value must be `Management` or `Data`.
|
152
152
|
#
|
153
153
|
# * <b> <code>resources.type</code> </b> - This field is required.
|
154
154
|
# `resources.type` can only use the `Equals` operator, and the value
|
155
|
-
# can be one of the following:
|
156
|
-
#
|
157
|
-
# `AWS::
|
158
|
-
#
|
159
|
-
# `
|
160
|
-
#
|
155
|
+
# can be one of the following:
|
156
|
+
#
|
157
|
+
# * `AWS::S3::Object`
|
158
|
+
#
|
159
|
+
# * `AWS::Lambda::Function`
|
160
|
+
#
|
161
|
+
# * `AWS::DynamoDB::Table`
|
162
|
+
#
|
163
|
+
# * `AWS::S3Outposts::Object`
|
164
|
+
#
|
165
|
+
# * `AWS::ManagedBlockchain::Node`
|
166
|
+
#
|
167
|
+
# * `AWS::S3ObjectLambda::AccessPoint`
|
168
|
+
#
|
169
|
+
# * `AWS::EC2::Snapshot`
|
170
|
+
#
|
171
|
+
# * `AWS::S3::AccessPoint`
|
172
|
+
#
|
173
|
+
# * `AWS::DynamoDB::Stream`
|
174
|
+
#
|
175
|
+
# You can have only one `resources.type` field per selector. To log
|
176
|
+
# data events on more than one resource type, add another selector.
|
161
177
|
#
|
162
178
|
# * <b> <code>resources.ARN</code> </b> - You can use any operator
|
163
|
-
# with resources.ARN
|
179
|
+
# with `resources.ARN`, but if you use `Equals` or `NotEquals`, the
|
164
180
|
# value must exactly match the ARN of a valid resource of the type
|
165
181
|
# you've specified in the template as the value of resources.type.
|
166
182
|
# For example, if resources.type equals `AWS::S3::Object`, the ARN
|
@@ -168,17 +184,30 @@ module Aws::CloudTrail
|
|
168
184
|
# for all objects in a specific S3 bucket, use the `StartsWith`
|
169
185
|
# operator, and include only the bucket ARN as the matching value.
|
170
186
|
#
|
171
|
-
# The trailing slash is intentional; do not exclude it.
|
187
|
+
# The trailing slash is intentional; do not exclude it. Replace the
|
188
|
+
# text between less than and greater than symbols (<>) with
|
189
|
+
# resource-specific information.
|
190
|
+
#
|
191
|
+
# * `arn:<partition>:s3:::<bucket_name>/`
|
192
|
+
#
|
193
|
+
# * `arn:<partition>:s3:::<bucket_name>/<object_path>/`
|
172
194
|
#
|
173
|
-
#
|
195
|
+
# When `resources.type` equals `AWS::S3::AccessPoint`, and the
|
196
|
+
# operator is set to `Equals` or `NotEquals`, the ARN must be in one
|
197
|
+
# of the following formats. To log events on all objects in an S3
|
198
|
+
# access point, we recommend that you use only the access point ARN,
|
199
|
+
# don’t include the object path, and use the `StartsWith` or
|
200
|
+
# `NotStartsWith` operators.
|
174
201
|
#
|
175
|
-
# * `arn
|
202
|
+
# * `arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>`
|
203
|
+
#
|
204
|
+
# * `arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>`
|
176
205
|
#
|
177
206
|
# When resources.type equals `AWS::Lambda::Function`, and the
|
178
207
|
# operator is set to `Equals` or `NotEquals`, the ARN must be in the
|
179
208
|
# following format:
|
180
209
|
#
|
181
|
-
# * `arn
|
210
|
+
# * `arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>`
|
182
211
|
#
|
183
212
|
# ^
|
184
213
|
#
|
@@ -186,7 +215,7 @@ module Aws::CloudTrail
|
|
186
215
|
# operator is set to `Equals` or `NotEquals`, the ARN must be in the
|
187
216
|
# following format:
|
188
217
|
#
|
189
|
-
# * `arn
|
218
|
+
# * `arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>`
|
190
219
|
#
|
191
220
|
# ^
|
192
221
|
#
|
@@ -194,7 +223,7 @@ module Aws::CloudTrail
|
|
194
223
|
# operator is set to `Equals` or `NotEquals`, the ARN must be in the
|
195
224
|
# following format:
|
196
225
|
#
|
197
|
-
# * `arn
|
226
|
+
# * `arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>`
|
198
227
|
#
|
199
228
|
# ^
|
200
229
|
#
|
@@ -202,7 +231,7 @@ module Aws::CloudTrail
|
|
202
231
|
# the operator is set to `Equals` or `NotEquals`, the ARN must be in
|
203
232
|
# the following format:
|
204
233
|
#
|
205
|
-
# * `arn
|
234
|
+
# * `arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>`
|
206
235
|
#
|
207
236
|
# ^
|
208
237
|
#
|
@@ -210,7 +239,23 @@ module Aws::CloudTrail
|
|
210
239
|
# and the operator is set to `Equals` or `NotEquals`, the ARN must
|
211
240
|
# be in the following format:
|
212
241
|
#
|
213
|
-
# * `arn
|
242
|
+
# * `arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>`
|
243
|
+
#
|
244
|
+
# ^
|
245
|
+
#
|
246
|
+
# When `resources.type` equals `AWS::EC2::Snapshot`, and the
|
247
|
+
# operator is set to `Equals` or `NotEquals`, the ARN must be in the
|
248
|
+
# following format:
|
249
|
+
#
|
250
|
+
# * `arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>`
|
251
|
+
#
|
252
|
+
# ^
|
253
|
+
#
|
254
|
+
# When `resources.type` equals `AWS::DynamoDB::Stream`, and the
|
255
|
+
# operator is set to `Equals` or `NotEquals`, the ARN must be in the
|
256
|
+
# following format:
|
257
|
+
#
|
258
|
+
# * `arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>`
|
214
259
|
#
|
215
260
|
# ^
|
216
261
|
# @return [String]
|
@@ -261,8 +306,8 @@ module Aws::CloudTrail
|
|
261
306
|
include Aws::Structure
|
262
307
|
end
|
263
308
|
|
264
|
-
# This exception is thrown when an operation is called with
|
265
|
-
#
|
309
|
+
# This exception is thrown when an operation is called with a trail ARN
|
310
|
+
# that is not valid. The following is the format of a trail ARN.
|
266
311
|
#
|
267
312
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
268
313
|
#
|
@@ -271,9 +316,9 @@ module Aws::CloudTrail
|
|
271
316
|
class CloudTrailARNInvalidException < Aws::EmptyStructure; end
|
272
317
|
|
273
318
|
# This exception is thrown when trusted access has not been enabled
|
274
|
-
# between
|
275
|
-
#
|
276
|
-
# For Creating a Trail For Your Organization][2].
|
319
|
+
# between CloudTrail and Organizations. For more information, see
|
320
|
+
# [Enabling Trusted Access with Other Amazon Web Services Services][1]
|
321
|
+
# and [Prepare For Creating a Trail For Your Organization][2].
|
277
322
|
#
|
278
323
|
#
|
279
324
|
#
|
@@ -287,7 +332,7 @@ module Aws::CloudTrail
|
|
287
332
|
# This exception is thrown when a call results in the
|
288
333
|
# `InvalidClientTokenId` error code. This can occur when you are
|
289
334
|
# creating or updating a trail to send notifications to an Amazon SNS
|
290
|
-
# topic that is in a suspended
|
335
|
+
# topic that is in a suspended Amazon Web Services account.
|
291
336
|
#
|
292
337
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CloudTrailInvalidClientTokenIdException AWS API Documentation
|
293
338
|
#
|
@@ -346,7 +391,7 @@ module Aws::CloudTrail
|
|
346
391
|
# * Be between 3 and 128 characters
|
347
392
|
#
|
348
393
|
# * Have no adjacent periods, underscores or dashes. Names like
|
349
|
-
# `my-_namespace` and `my--namespace` are
|
394
|
+
# `my-_namespace` and `my--namespace` are not valid.
|
350
395
|
#
|
351
396
|
# * Not be in IP address format (for example, 192.168.5.4)
|
352
397
|
# @return [String]
|
@@ -393,7 +438,7 @@ module Aws::CloudTrail
|
|
393
438
|
# default is false.
|
394
439
|
#
|
395
440
|
# <note markdown="1"> When you disable log file integrity validation, the chain of digest
|
396
|
-
# files is broken after one hour. CloudTrail
|
441
|
+
# files is broken after one hour. CloudTrail does not create digest
|
397
442
|
# files for log files that were delivered during a period in which log
|
398
443
|
# file integrity validation was disabled. For example, if you enable
|
399
444
|
# log file integrity validation at noon on January 1, disable it at
|
@@ -409,7 +454,7 @@ module Aws::CloudTrail
|
|
409
454
|
# Specifies a log group name using an Amazon Resource Name (ARN), a
|
410
455
|
# unique identifier that represents the log group to which CloudTrail
|
411
456
|
# logs will be delivered. Not required unless you specify
|
412
|
-
# CloudWatchLogsRoleArn
|
457
|
+
# `CloudWatchLogsRoleArn`.
|
413
458
|
# @return [String]
|
414
459
|
#
|
415
460
|
# @!attribute [rw] cloud_watch_logs_role_arn
|
@@ -423,6 +468,10 @@ module Aws::CloudTrail
|
|
423
468
|
# fully specified ARN to an alias, a fully specified ARN to a key, or
|
424
469
|
# a globally unique identifier.
|
425
470
|
#
|
471
|
+
# CloudTrail also supports KMS multi-Region keys. For more information
|
472
|
+
# about multi-Region keys, see [Using multi-Region keys][1] in the
|
473
|
+
# *Key Management Service Developer Guide*.
|
474
|
+
#
|
426
475
|
# Examples:
|
427
476
|
#
|
428
477
|
# * alias/MyAliasName
|
@@ -432,14 +481,18 @@ module Aws::CloudTrail
|
|
432
481
|
# * arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
|
433
482
|
#
|
434
483
|
# * 12345678-1234-1234-1234-123456789012
|
484
|
+
#
|
485
|
+
#
|
486
|
+
#
|
487
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html
|
435
488
|
# @return [String]
|
436
489
|
#
|
437
490
|
# @!attribute [rw] is_organization_trail
|
438
491
|
# Specifies whether the trail is created for all accounts in an
|
439
|
-
# organization in
|
440
|
-
# account. The default is false, and cannot be true unless
|
441
|
-
# made on behalf of an
|
442
|
-
# organization in
|
492
|
+
# organization in Organizations, or only for the current Amazon Web
|
493
|
+
# Services account. The default is false, and cannot be true unless
|
494
|
+
# the call is made on behalf of an Amazon Web Services account that is
|
495
|
+
# the management account for an organization in Organizations.
|
443
496
|
# @return [Boolean]
|
444
497
|
#
|
445
498
|
# @!attribute [rw] tags_list
|
@@ -532,7 +585,7 @@ module Aws::CloudTrail
|
|
532
585
|
# @!attribute [rw] kms_key_id
|
533
586
|
# Specifies the KMS key ID that encrypts the logs delivered by
|
534
587
|
# CloudTrail. The value is a fully specified ARN to a KMS key in the
|
535
|
-
# format
|
588
|
+
# following format.
|
536
589
|
#
|
537
590
|
# `arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012`
|
538
591
|
# @return [String]
|
@@ -561,7 +614,7 @@ module Aws::CloudTrail
|
|
561
614
|
include Aws::Structure
|
562
615
|
end
|
563
616
|
|
564
|
-
# The Amazon S3 buckets,
|
617
|
+
# The Amazon S3 buckets, Lambda functions, or Amazon DynamoDB tables
|
565
618
|
# that you specify in your event selectors for your trail to log data
|
566
619
|
# events. Data events provide information about the resource operations
|
567
620
|
# performed on or within a resource itself. These are also known as data
|
@@ -599,22 +652,22 @@ module Aws::CloudTrail
|
|
599
652
|
# trail doesn’t log the event.
|
600
653
|
#
|
601
654
|
# The following example demonstrates how logging works when you
|
602
|
-
# configure logging of
|
603
|
-
#
|
655
|
+
# configure logging of Lambda data events for a Lambda function named
|
656
|
+
# *MyLambdaFunction*, but not for all Lambda functions.
|
604
657
|
#
|
605
658
|
# 1. A user runs a script that includes a call to the
|
606
659
|
# *MyLambdaFunction* function and the *MyOtherLambdaFunction*
|
607
660
|
# function.
|
608
661
|
#
|
609
|
-
# 2. The `Invoke` API operation on *MyLambdaFunction* is an
|
610
|
-
#
|
662
|
+
# 2. The `Invoke` API operation on *MyLambdaFunction* is an Lambda API.
|
663
|
+
# It is recorded as a data event in CloudTrail. Because the
|
611
664
|
# CloudTrail user specified logging data events for
|
612
665
|
# *MyLambdaFunction*, any invocations of that function are logged.
|
613
666
|
# The trail processes and logs the event.
|
614
667
|
#
|
615
|
-
# 3. The `Invoke` API operation on *MyOtherLambdaFunction* is an
|
616
|
-
#
|
617
|
-
#
|
668
|
+
# 3. The `Invoke` API operation on *MyOtherLambdaFunction* is an Lambda
|
669
|
+
# API. Because the CloudTrail user did not specify logging data
|
670
|
+
# events for all Lambda functions, the `Invoke` operation for
|
618
671
|
# *MyOtherLambdaFunction* does not match the function specified for
|
619
672
|
# the trail. The trail doesn’t log the event.
|
620
673
|
#
|
@@ -628,25 +681,45 @@ module Aws::CloudTrail
|
|
628
681
|
#
|
629
682
|
# @!attribute [rw] type
|
630
683
|
# The resource type in which you want to log data events. You can
|
631
|
-
# specify
|
632
|
-
#
|
684
|
+
# specify the following *basic* event selector resource types:
|
685
|
+
#
|
686
|
+
# * `AWS::S3::Object`
|
687
|
+
#
|
688
|
+
# * `AWS::Lambda::Function`
|
689
|
+
#
|
690
|
+
# * `AWS::DynamoDB::Table`
|
691
|
+
#
|
692
|
+
# The following resource types are also availble through *advanced*
|
693
|
+
# event selectors. Basic event selector resource types are valid in
|
694
|
+
# advanced event selectors, but advanced event selector resource types
|
695
|
+
# are not valid in basic event selectors. For more information, see
|
696
|
+
# AdvancedFieldSelector$Field.
|
633
697
|
#
|
634
|
-
#
|
635
|
-
#
|
636
|
-
#
|
637
|
-
#
|
698
|
+
# * `AWS::S3Outposts::Object`
|
699
|
+
#
|
700
|
+
# * `AWS::ManagedBlockchain::Node`
|
701
|
+
#
|
702
|
+
# * `AWS::S3ObjectLambda::AccessPoint`
|
703
|
+
#
|
704
|
+
# * `AWS::EC2::Snapshot`
|
705
|
+
#
|
706
|
+
# * `AWS::S3::AccessPoint`
|
707
|
+
#
|
708
|
+
# * `AWS::DynamoDB::Stream`
|
638
709
|
# @return [String]
|
639
710
|
#
|
640
711
|
# @!attribute [rw] values
|
641
712
|
# An array of Amazon Resource Name (ARN) strings or partial ARN
|
642
713
|
# strings for the specified objects.
|
643
714
|
#
|
644
|
-
# * To log data events for all objects in all S3 buckets in your
|
645
|
-
# account, specify the prefix as
|
715
|
+
# * To log data events for all objects in all S3 buckets in your
|
716
|
+
# Amazon Web Services account, specify the prefix as
|
717
|
+
# `arn:aws:s3:::`.
|
646
718
|
#
|
647
|
-
# <note markdown="1"> This
|
648
|
-
#
|
649
|
-
# performed on a bucket that belongs to another
|
719
|
+
# <note markdown="1"> This also enables logging of data event activity performed by any
|
720
|
+
# user or role in your Amazon Web Services account, even if that
|
721
|
+
# activity is performed on a bucket that belongs to another Amazon
|
722
|
+
# Web Services account.
|
650
723
|
#
|
651
724
|
# </note>
|
652
725
|
#
|
@@ -660,12 +733,13 @@ module Aws::CloudTrail
|
|
660
733
|
# trail logs data events for objects in this S3 bucket that match
|
661
734
|
# the prefix.
|
662
735
|
#
|
663
|
-
# * To log data events for all Lambda functions in your
|
664
|
-
# specify the prefix as `arn:aws:lambda`.
|
736
|
+
# * To log data events for all Lambda functions in your Amazon Web
|
737
|
+
# Services account, specify the prefix as `arn:aws:lambda`.
|
665
738
|
#
|
666
|
-
# <note markdown="1"> This
|
667
|
-
#
|
668
|
-
# performed on a function that belongs to another
|
739
|
+
# <note markdown="1"> This also enables logging of `Invoke` activity performed by any
|
740
|
+
# user or role in your Amazon Web Services account, even if that
|
741
|
+
# activity is performed on a function that belongs to another Amazon
|
742
|
+
# Web Services account.
|
669
743
|
#
|
670
744
|
# </note>
|
671
745
|
#
|
@@ -682,8 +756,8 @@ module Aws::CloudTrail
|
|
682
756
|
#
|
683
757
|
# </note>
|
684
758
|
#
|
685
|
-
# * To log data events for all DynamoDB tables in your
|
686
|
-
# specify the prefix as `arn:aws:dynamodb`.
|
759
|
+
# * To log data events for all DynamoDB tables in your Amazon Web
|
760
|
+
# Services account, specify the prefix as `arn:aws:dynamodb`.
|
687
761
|
# @return [Array<String>]
|
688
762
|
#
|
689
763
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DataResource AWS API Documentation
|
@@ -706,7 +780,7 @@ module Aws::CloudTrail
|
|
706
780
|
#
|
707
781
|
# @!attribute [rw] name
|
708
782
|
# Specifies the name or the CloudTrail ARN of the trail to be deleted.
|
709
|
-
# The format of a trail ARN
|
783
|
+
# The following is the format of a trail ARN.
|
710
784
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
711
785
|
# @return [String]
|
712
786
|
#
|
@@ -787,7 +861,7 @@ module Aws::CloudTrail
|
|
787
861
|
# configuration. For example, `SNSTopicName` and `SNSTopicARN` are
|
788
862
|
# only returned in results if a trail is configured to send SNS
|
789
863
|
# notifications. Similarly, `KMSKeyId` only appears in results if a
|
790
|
-
# trail's log files are encrypted with
|
864
|
+
# trail's log files are encrypted with KMS customer managed keys.
|
791
865
|
# @return [Array<Types::Trail>]
|
792
866
|
#
|
793
867
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DescribeTrailsResponse AWS API Documentation
|
@@ -815,9 +889,9 @@ module Aws::CloudTrail
|
|
815
889
|
# @return [String]
|
816
890
|
#
|
817
891
|
# @!attribute [rw] access_key_id
|
818
|
-
# The
|
819
|
-
# request was made with temporary security
|
820
|
-
# access key ID of the temporary credentials.
|
892
|
+
# The Amazon Web Services access key ID that was used to sign the
|
893
|
+
# request. If the request was made with temporary security
|
894
|
+
# credentials, this is the access key ID of the temporary credentials.
|
821
895
|
# @return [String]
|
822
896
|
#
|
823
897
|
# @!attribute [rw] event_time
|
@@ -825,7 +899,7 @@ module Aws::CloudTrail
|
|
825
899
|
# @return [Time]
|
826
900
|
#
|
827
901
|
# @!attribute [rw] event_source
|
828
|
-
# The
|
902
|
+
# The Amazon Web Services service to which the request was made.
|
829
903
|
# @return [String]
|
830
904
|
#
|
831
905
|
# @!attribute [rw] username
|
@@ -899,15 +973,15 @@ module Aws::CloudTrail
|
|
899
973
|
# Specify if you want your event selector to include management events
|
900
974
|
# for your trail.
|
901
975
|
#
|
902
|
-
# For more information, see [Management Events][1] in the *
|
903
|
-
#
|
976
|
+
# For more information, see [Management Events][1] in the *CloudTrail
|
977
|
+
# User Guide*.
|
904
978
|
#
|
905
979
|
# By default, the value is `true`.
|
906
980
|
#
|
907
981
|
# The first copy of management events is free. You are charged for
|
908
982
|
# additional copies of management events that you are logging on any
|
909
983
|
# subsequent trail in the same region. For more information about
|
910
|
-
# CloudTrail pricing, see [
|
984
|
+
# CloudTrail pricing, see [CloudTrail Pricing][2].
|
911
985
|
#
|
912
986
|
#
|
913
987
|
#
|
@@ -916,15 +990,15 @@ module Aws::CloudTrail
|
|
916
990
|
# @return [Boolean]
|
917
991
|
#
|
918
992
|
# @!attribute [rw] data_resources
|
919
|
-
# CloudTrail supports data event logging for Amazon S3 objects
|
920
|
-
#
|
921
|
-
# 250 resources for an individual event
|
922
|
-
# of data resources cannot exceed 250
|
923
|
-
# trail. This limit does not apply if
|
924
|
-
# for all data events.
|
993
|
+
# CloudTrail supports data event logging for Amazon S3 objects, Lambda
|
994
|
+
# functions, and Amazon DynamoDB tables with basic event selectors.
|
995
|
+
# You can specify up to 250 resources for an individual event
|
996
|
+
# selector, but the total number of data resources cannot exceed 250
|
997
|
+
# across all event selectors in a trail. This limit does not apply if
|
998
|
+
# you configure resource logging for all data events.
|
925
999
|
#
|
926
|
-
# For more information, see [Data Events][1] and [Limits in
|
927
|
-
# CloudTrail][2] in the *
|
1000
|
+
# For more information, see [Data Events][1] and [Limits in
|
1001
|
+
# CloudTrail][2] in the *CloudTrail User Guide*.
|
928
1002
|
#
|
929
1003
|
#
|
930
1004
|
#
|
@@ -935,10 +1009,11 @@ module Aws::CloudTrail
|
|
935
1009
|
# @!attribute [rw] exclude_management_event_sources
|
936
1010
|
# An optional list of service event sources from which you do not want
|
937
1011
|
# management events to be logged on your trail. In this release, the
|
938
|
-
# list can be empty (disables the filter), or it can filter out
|
939
|
-
#
|
940
|
-
#
|
941
|
-
#
|
1012
|
+
# list can be empty (disables the filter), or it can filter out Key
|
1013
|
+
# Management Service or Amazon RDS Data API events by containing
|
1014
|
+
# `kms.amazonaws.com` or `rdsdata.amazonaws.com`. By default,
|
1015
|
+
# `ExcludeManagementEventSources` is empty, and KMS and Amazon RDS
|
1016
|
+
# Data API events are logged to your trail.
|
942
1017
|
# @return [Array<String>]
|
943
1018
|
#
|
944
1019
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/EventSelector AWS API Documentation
|
@@ -1111,7 +1186,7 @@ module Aws::CloudTrail
|
|
1111
1186
|
# Specifies the name or the CloudTrail ARN of the trail for which you
|
1112
1187
|
# are requesting status. To get the status of a shadow trail (a
|
1113
1188
|
# replication of the trail in another region), you must specify its
|
1114
|
-
# ARN. The format of a trail ARN
|
1189
|
+
# ARN. The following is the format of a trail ARN.
|
1115
1190
|
#
|
1116
1191
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
1117
1192
|
# @return [String]
|
@@ -1128,20 +1203,21 @@ module Aws::CloudTrail
|
|
1128
1203
|
# returns an error.
|
1129
1204
|
#
|
1130
1205
|
# @!attribute [rw] is_logging
|
1131
|
-
# Whether the CloudTrail is currently logging
|
1206
|
+
# Whether the CloudTrail trail is currently logging Amazon Web
|
1207
|
+
# Services API calls.
|
1132
1208
|
# @return [Boolean]
|
1133
1209
|
#
|
1134
1210
|
# @!attribute [rw] latest_delivery_error
|
1135
1211
|
# Displays any Amazon S3 error that CloudTrail encountered when
|
1136
1212
|
# attempting to deliver log files to the designated bucket. For more
|
1137
|
-
# information see
|
1213
|
+
# information, see [Error Responses][1] in the Amazon S3 API
|
1138
1214
|
# Reference.
|
1139
1215
|
#
|
1140
1216
|
# <note markdown="1"> This error occurs only when there is a problem with the destination
|
1141
|
-
# S3 bucket and
|
1142
|
-
# create a new bucket and call `UpdateTrail` to
|
1143
|
-
# bucket
|
1144
|
-
# write to the bucket.
|
1217
|
+
# S3 bucket, and does not occur for requests that time out. To resolve
|
1218
|
+
# the issue, create a new bucket, and then call `UpdateTrail` to
|
1219
|
+
# specify the new bucket; or fix the existing objects so that
|
1220
|
+
# CloudTrail can again write to the bucket.
|
1145
1221
|
#
|
1146
1222
|
# </note>
|
1147
1223
|
#
|
@@ -1173,12 +1249,12 @@ module Aws::CloudTrail
|
|
1173
1249
|
#
|
1174
1250
|
# @!attribute [rw] start_logging_time
|
1175
1251
|
# Specifies the most recent date and time when CloudTrail started
|
1176
|
-
# recording API calls for an
|
1252
|
+
# recording API calls for an Amazon Web Services account.
|
1177
1253
|
# @return [Time]
|
1178
1254
|
#
|
1179
1255
|
# @!attribute [rw] stop_logging_time
|
1180
1256
|
# Specifies the most recent date and time when CloudTrail stopped
|
1181
|
-
# recording API calls for an
|
1257
|
+
# recording API calls for an Amazon Web Services account.
|
1182
1258
|
# @return [Time]
|
1183
1259
|
#
|
1184
1260
|
# @!attribute [rw] latest_cloud_watch_logs_delivery_error
|
@@ -1199,14 +1275,14 @@ module Aws::CloudTrail
|
|
1199
1275
|
# @!attribute [rw] latest_digest_delivery_error
|
1200
1276
|
# Displays any Amazon S3 error that CloudTrail encountered when
|
1201
1277
|
# attempting to deliver a digest file to the designated bucket. For
|
1202
|
-
# more information see
|
1203
|
-
#
|
1278
|
+
# more information, see [Error Responses][1] in the Amazon S3 API
|
1279
|
+
# Reference.
|
1204
1280
|
#
|
1205
1281
|
# <note markdown="1"> This error occurs only when there is a problem with the destination
|
1206
|
-
# S3 bucket and
|
1207
|
-
# create a new bucket and call `UpdateTrail` to
|
1208
|
-
# bucket
|
1209
|
-
# write to the bucket.
|
1282
|
+
# S3 bucket, and does not occur for requests that time out. To resolve
|
1283
|
+
# the issue, create a new bucket, and then call `UpdateTrail` to
|
1284
|
+
# specify the new bucket; or fix the existing objects so that
|
1285
|
+
# CloudTrail can again write to the bucket.
|
1210
1286
|
#
|
1211
1287
|
# </note>
|
1212
1288
|
#
|
@@ -1278,12 +1354,12 @@ module Aws::CloudTrail
|
|
1278
1354
|
# data as a hash:
|
1279
1355
|
#
|
1280
1356
|
# {
|
1281
|
-
# insight_type: "ApiCallRateInsight", # accepts ApiCallRateInsight
|
1357
|
+
# insight_type: "ApiCallRateInsight", # accepts ApiCallRateInsight, ApiErrorRateInsight
|
1282
1358
|
# }
|
1283
1359
|
#
|
1284
1360
|
# @!attribute [rw] insight_type
|
1285
|
-
# The type of
|
1286
|
-
#
|
1361
|
+
# The type of Insights events to log on a trail. The valid Insights
|
1362
|
+
# type in this release is `ApiCallRateInsight`.
|
1287
1363
|
# @return [String]
|
1288
1364
|
#
|
1289
1365
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/InsightSelector AWS API Documentation
|
@@ -1322,15 +1398,15 @@ module Aws::CloudTrail
|
|
1322
1398
|
#
|
1323
1399
|
class InsufficientS3BucketPolicyException < Aws::EmptyStructure; end
|
1324
1400
|
|
1325
|
-
# This exception is thrown when the policy on the SNS topic is
|
1326
|
-
# sufficient.
|
1401
|
+
# This exception is thrown when the policy on the Amazon SNS topic is
|
1402
|
+
# not sufficient.
|
1327
1403
|
#
|
1328
1404
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/InsufficientSnsTopicPolicyException AWS API Documentation
|
1329
1405
|
#
|
1330
1406
|
class InsufficientSnsTopicPolicyException < Aws::EmptyStructure; end
|
1331
1407
|
|
1332
|
-
# This exception is thrown when the provided CloudWatch log group
|
1333
|
-
# valid.
|
1408
|
+
# This exception is thrown when the provided CloudWatch Logs log group
|
1409
|
+
# is not valid.
|
1334
1410
|
#
|
1335
1411
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/InvalidCloudWatchLogsLogGroupArnException AWS API Documentation
|
1336
1412
|
#
|
@@ -1373,7 +1449,7 @@ module Aws::CloudTrail
|
|
1373
1449
|
# selectors for a trail.
|
1374
1450
|
#
|
1375
1451
|
# * Specify a valid value for a parameter. For example, specifying the
|
1376
|
-
# `ReadWriteType` parameter with a value of `read-only` is
|
1452
|
+
# `ReadWriteType` parameter with a value of `read-only` is not valid.
|
1377
1453
|
#
|
1378
1454
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/InvalidEventSelectorsException AWS API Documentation
|
1379
1455
|
#
|
@@ -1395,27 +1471,27 @@ module Aws::CloudTrail
|
|
1395
1471
|
#
|
1396
1472
|
class InvalidInsightSelectorsException < Aws::EmptyStructure; end
|
1397
1473
|
|
1398
|
-
# This exception is thrown when the KMS key ARN is
|
1474
|
+
# This exception is thrown when the KMS key ARN is not valid.
|
1399
1475
|
#
|
1400
1476
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/InvalidKmsKeyIdException AWS API Documentation
|
1401
1477
|
#
|
1402
1478
|
class InvalidKmsKeyIdException < Aws::EmptyStructure; end
|
1403
1479
|
|
1404
|
-
# Occurs when
|
1480
|
+
# Occurs when a lookup attribute is specified that is not valid.
|
1405
1481
|
#
|
1406
1482
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/InvalidLookupAttributesException AWS API Documentation
|
1407
1483
|
#
|
1408
1484
|
class InvalidLookupAttributesException < Aws::EmptyStructure; end
|
1409
1485
|
|
1410
|
-
# This exception is thrown if the limit specified is
|
1486
|
+
# This exception is thrown if the limit specified is not valid.
|
1411
1487
|
#
|
1412
1488
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/InvalidMaxResultsException AWS API Documentation
|
1413
1489
|
#
|
1414
1490
|
class InvalidMaxResultsException < Aws::EmptyStructure; end
|
1415
1491
|
|
1416
|
-
#
|
1417
|
-
# different parameters. This exception is thrown if the
|
1418
|
-
#
|
1492
|
+
# A token that is not valid, or a token that was previously used in a
|
1493
|
+
# request with different parameters. This exception is thrown if the
|
1494
|
+
# token is not valid.
|
1419
1495
|
#
|
1420
1496
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/InvalidNextTokenException AWS API Documentation
|
1421
1497
|
#
|
@@ -1456,8 +1532,8 @@ module Aws::CloudTrail
|
|
1456
1532
|
#
|
1457
1533
|
class InvalidTagParameterException < Aws::EmptyStructure; end
|
1458
1534
|
|
1459
|
-
# Occurs if the timestamp values are
|
1460
|
-
# occurs after the end time or the time range is outside the range of
|
1535
|
+
# Occurs if the timestamp values are not valid. Either the start time
|
1536
|
+
# occurs after the end time, or the time range is outside the range of
|
1461
1537
|
# possible values.
|
1462
1538
|
#
|
1463
1539
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/InvalidTimeRangeException AWS API Documentation
|
@@ -1481,7 +1557,7 @@ module Aws::CloudTrail
|
|
1481
1557
|
# * Be between 3 and 128 characters
|
1482
1558
|
#
|
1483
1559
|
# * Have no adjacent periods, underscores or dashes. Names like
|
1484
|
-
# `my-_namespace` and `my--namespace` are
|
1560
|
+
# `my-_namespace` and `my--namespace` are not valid.
|
1485
1561
|
#
|
1486
1562
|
# * Not be in IP address format (for example, 192.168.5.4)
|
1487
1563
|
#
|
@@ -1502,10 +1578,10 @@ module Aws::CloudTrail
|
|
1502
1578
|
#
|
1503
1579
|
class KmsKeyDisabledException < Aws::EmptyStructure; end
|
1504
1580
|
|
1505
|
-
# This exception is thrown when the
|
1506
|
-
#
|
1507
|
-
#
|
1508
|
-
#
|
1581
|
+
# This exception is thrown when the KMS key does not exist, when the S3
|
1582
|
+
# bucket and the KMS key are not in the same region, or when the KMS key
|
1583
|
+
# associated with the Amazon SNS topic either does not exist or is not
|
1584
|
+
# in the same region.
|
1509
1585
|
#
|
1510
1586
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/KmsKeyNotFoundException AWS API Documentation
|
1511
1587
|
#
|
@@ -1584,7 +1660,7 @@ module Aws::CloudTrail
|
|
1584
1660
|
#
|
1585
1661
|
# @!attribute [rw] resource_id_list
|
1586
1662
|
# Specifies a list of trail ARNs whose tags will be listed. The list
|
1587
|
-
# has a limit of 20 ARNs. The format of a trail ARN
|
1663
|
+
# has a limit of 20 ARNs. The following is the format of a trail ARN.
|
1588
1664
|
#
|
1589
1665
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
1590
1666
|
# @return [Array<String>]
|
@@ -1798,10 +1874,11 @@ module Aws::CloudTrail
|
|
1798
1874
|
#
|
1799
1875
|
class MaximumNumberOfTrailsExceededException < Aws::EmptyStructure; end
|
1800
1876
|
|
1801
|
-
# This exception is thrown when the
|
1802
|
-
# create or update an organization trail is not the
|
1803
|
-
# an organization in
|
1804
|
-
# [Prepare For Creating a Trail For Your
|
1877
|
+
# This exception is thrown when the Amazon Web Services account making
|
1878
|
+
# the request to create or update an organization trail is not the
|
1879
|
+
# management account for an organization in Organizations. For more
|
1880
|
+
# information, see [Prepare For Creating a Trail For Your
|
1881
|
+
# Organization][1].
|
1805
1882
|
#
|
1806
1883
|
#
|
1807
1884
|
#
|
@@ -1818,9 +1895,9 @@ module Aws::CloudTrail
|
|
1818
1895
|
#
|
1819
1896
|
class OperationNotPermittedException < Aws::EmptyStructure; end
|
1820
1897
|
|
1821
|
-
# This exception is thrown when
|
1822
|
-
# support all features. All features must be enabled in
|
1823
|
-
#
|
1898
|
+
# This exception is thrown when Organizations is not configured to
|
1899
|
+
# support all features. All features must be enabled in Organizations to
|
1900
|
+
# support creating an organization trail. For more information, see
|
1824
1901
|
# [Prepare For Creating a Trail For Your Organization][1].
|
1825
1902
|
#
|
1826
1903
|
#
|
@@ -1831,9 +1908,10 @@ module Aws::CloudTrail
|
|
1831
1908
|
#
|
1832
1909
|
class OrganizationNotInAllFeaturesModeException < Aws::EmptyStructure; end
|
1833
1910
|
|
1834
|
-
# This exception is thrown when the request is made from an
|
1835
|
-
# that is not a member of an organization. To make this
|
1836
|
-
# using the credentials of an account that belongs to
|
1911
|
+
# This exception is thrown when the request is made from an Amazon Web
|
1912
|
+
# Services account that is not a member of an organization. To make this
|
1913
|
+
# request, sign in using the credentials of an account that belongs to
|
1914
|
+
# an organization.
|
1837
1915
|
#
|
1838
1916
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/OrganizationsNotInUseException AWS API Documentation
|
1839
1917
|
#
|
@@ -1916,11 +1994,11 @@ module Aws::CloudTrail
|
|
1916
1994
|
# * Be between 3 and 128 characters
|
1917
1995
|
#
|
1918
1996
|
# * Have no adjacent periods, underscores or dashes. Names like
|
1919
|
-
# `my-_namespace` and `my--namespace` are
|
1997
|
+
# `my-_namespace` and `my--namespace` are not valid.
|
1920
1998
|
#
|
1921
1999
|
# * Not be in IP address format (for example, 192.168.5.4)
|
1922
2000
|
#
|
1923
|
-
# If you specify a trail ARN, it must be in the format
|
2001
|
+
# If you specify a trail ARN, it must be in the following format.
|
1924
2002
|
#
|
1925
2003
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
1926
2004
|
# @return [String]
|
@@ -1942,8 +2020,8 @@ module Aws::CloudTrail
|
|
1942
2020
|
# `EventSelectors`, but not both. If you apply
|
1943
2021
|
# `AdvancedEventSelectors` to a trail, any existing `EventSelectors`
|
1944
2022
|
# are overwritten. For more information about advanced event
|
1945
|
-
# selectors, see [Logging data events for trails][1] in the
|
1946
|
-
# CloudTrail User Guide*.
|
2023
|
+
# selectors, see [Logging data events for trails][1] in the
|
2024
|
+
# *CloudTrail User Guide*.
|
1947
2025
|
#
|
1948
2026
|
#
|
1949
2027
|
#
|
@@ -1962,7 +2040,7 @@ module Aws::CloudTrail
|
|
1962
2040
|
|
1963
2041
|
# @!attribute [rw] trail_arn
|
1964
2042
|
# Specifies the ARN of the trail that was updated with event
|
1965
|
-
# selectors. The format of a trail ARN
|
2043
|
+
# selectors. The following is the format of a trail ARN.
|
1966
2044
|
#
|
1967
2045
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
1968
2046
|
# @return [String]
|
@@ -1992,7 +2070,7 @@ module Aws::CloudTrail
|
|
1992
2070
|
# trail_name: "String", # required
|
1993
2071
|
# insight_selectors: [ # required
|
1994
2072
|
# {
|
1995
|
-
# insight_type: "ApiCallRateInsight", # accepts ApiCallRateInsight
|
2073
|
+
# insight_type: "ApiCallRateInsight", # accepts ApiCallRateInsight, ApiErrorRateInsight
|
1996
2074
|
# },
|
1997
2075
|
# ],
|
1998
2076
|
# }
|
@@ -2003,9 +2081,9 @@ module Aws::CloudTrail
|
|
2003
2081
|
# @return [String]
|
2004
2082
|
#
|
2005
2083
|
# @!attribute [rw] insight_selectors
|
2006
|
-
# A JSON string that contains the
|
2007
|
-
# trail.
|
2008
|
-
#
|
2084
|
+
# A JSON string that contains the Insights types that you want to log
|
2085
|
+
# on a trail. The valid Insights type in this release is
|
2086
|
+
# `ApiCallRateInsight`.
|
2009
2087
|
# @return [Array<Types::InsightSelector>]
|
2010
2088
|
#
|
2011
2089
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/PutInsightSelectorsRequest AWS API Documentation
|
@@ -2023,9 +2101,9 @@ module Aws::CloudTrail
|
|
2023
2101
|
# @return [String]
|
2024
2102
|
#
|
2025
2103
|
# @!attribute [rw] insight_selectors
|
2026
|
-
# A JSON string that contains the
|
2027
|
-
# trail.
|
2028
|
-
#
|
2104
|
+
# A JSON string that contains the Insights event types that you want
|
2105
|
+
# to log on a trail. The valid Insights type in this release is
|
2106
|
+
# `ApiCallRateInsight`.
|
2029
2107
|
# @return [Array<Types::InsightSelector>]
|
2030
2108
|
#
|
2031
2109
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/PutInsightSelectorsResponse AWS API Documentation
|
@@ -2085,9 +2163,10 @@ module Aws::CloudTrail
|
|
2085
2163
|
# The type of a resource referenced by the event returned. When the
|
2086
2164
|
# resource type cannot be determined, null is returned. Some examples
|
2087
2165
|
# of resource types are: **Instance** for EC2, **Trail** for
|
2088
|
-
# CloudTrail, **DBInstance** for RDS, and **AccessKey** for
|
2089
|
-
# learn more about how to look up and filter events by the
|
2090
|
-
# types supported for a service, see [Filtering CloudTrail
|
2166
|
+
# CloudTrail, **DBInstance** for Amazon RDS, and **AccessKey** for
|
2167
|
+
# IAM. To learn more about how to look up and filter events by the
|
2168
|
+
# resource types supported for a service, see [Filtering CloudTrail
|
2169
|
+
# Events][1].
|
2091
2170
|
#
|
2092
2171
|
#
|
2093
2172
|
#
|
@@ -2148,8 +2227,8 @@ module Aws::CloudTrail
|
|
2148
2227
|
#
|
2149
2228
|
class S3BucketDoesNotExistException < Aws::EmptyStructure; end
|
2150
2229
|
|
2151
|
-
# The request to CloudTrail to start logging
|
2152
|
-
# account.
|
2230
|
+
# The request to CloudTrail to start logging Amazon Web Services API
|
2231
|
+
# calls for an account.
|
2153
2232
|
#
|
2154
2233
|
# @note When making an API call, you may pass StartLoggingRequest
|
2155
2234
|
# data as a hash:
|
@@ -2160,7 +2239,8 @@ module Aws::CloudTrail
|
|
2160
2239
|
#
|
2161
2240
|
# @!attribute [rw] name
|
2162
2241
|
# Specifies the name or the CloudTrail ARN of the trail for which
|
2163
|
-
# CloudTrail logs
|
2242
|
+
# CloudTrail logs Amazon Web Services API calls. The following is the
|
2243
|
+
# format of a trail ARN.
|
2164
2244
|
#
|
2165
2245
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
2166
2246
|
# @return [String]
|
@@ -2180,8 +2260,8 @@ module Aws::CloudTrail
|
|
2180
2260
|
#
|
2181
2261
|
class StartLoggingResponse < Aws::EmptyStructure; end
|
2182
2262
|
|
2183
|
-
# Passes the request to CloudTrail to stop logging
|
2184
|
-
# specified account.
|
2263
|
+
# Passes the request to CloudTrail to stop logging Amazon Web Services
|
2264
|
+
# API calls for the specified account.
|
2185
2265
|
#
|
2186
2266
|
# @note When making an API call, you may pass StopLoggingRequest
|
2187
2267
|
# data as a hash:
|
@@ -2192,8 +2272,8 @@ module Aws::CloudTrail
|
|
2192
2272
|
#
|
2193
2273
|
# @!attribute [rw] name
|
2194
2274
|
# Specifies the name or the CloudTrail ARN of the trail for which
|
2195
|
-
# CloudTrail will stop logging
|
2196
|
-
#
|
2275
|
+
# CloudTrail will stop logging Amazon Web Services API calls. The
|
2276
|
+
# following is the format of a trail ARN.
|
2197
2277
|
#
|
2198
2278
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
2199
2279
|
# @return [String]
|
@@ -2270,7 +2350,7 @@ module Aws::CloudTrail
|
|
2270
2350
|
# @!attribute [rw] s3_key_prefix
|
2271
2351
|
# Specifies the Amazon S3 key prefix that comes after the name of the
|
2272
2352
|
# bucket you have designated for log file delivery. For more
|
2273
|
-
# information, see [Finding Your CloudTrail Log Files][1].The maximum
|
2353
|
+
# information, see [Finding Your CloudTrail Log Files][1]. The maximum
|
2274
2354
|
# length is 200 characters.
|
2275
2355
|
#
|
2276
2356
|
#
|
@@ -2284,15 +2364,15 @@ module Aws::CloudTrail
|
|
2284
2364
|
#
|
2285
2365
|
# @!attribute [rw] sns_topic_arn
|
2286
2366
|
# Specifies the ARN of the Amazon SNS topic that CloudTrail uses to
|
2287
|
-
# send notifications when log files are delivered. The
|
2288
|
-
# topic ARN
|
2367
|
+
# send notifications when log files are delivered. The following is
|
2368
|
+
# the format of a topic ARN.
|
2289
2369
|
#
|
2290
2370
|
# `arn:aws:sns:us-east-2:123456789012:MyTopic`
|
2291
2371
|
# @return [String]
|
2292
2372
|
#
|
2293
2373
|
# @!attribute [rw] include_global_service_events
|
2294
|
-
# Set to **True** to include
|
2295
|
-
# such as IAM. Otherwise, **False**.
|
2374
|
+
# Set to **True** to include Amazon Web Services API calls from Amazon
|
2375
|
+
# Web Services global services such as IAM. Otherwise, **False**.
|
2296
2376
|
# @return [Boolean]
|
2297
2377
|
#
|
2298
2378
|
# @!attribute [rw] is_multi_region_trail
|
@@ -2305,7 +2385,8 @@ module Aws::CloudTrail
|
|
2305
2385
|
# @return [String]
|
2306
2386
|
#
|
2307
2387
|
# @!attribute [rw] trail_arn
|
2308
|
-
# Specifies the ARN of the trail. The format of a
|
2388
|
+
# Specifies the ARN of the trail. The following is the format of a
|
2389
|
+
# trail ARN.
|
2309
2390
|
#
|
2310
2391
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
2311
2392
|
# @return [String]
|
@@ -2327,7 +2408,7 @@ module Aws::CloudTrail
|
|
2327
2408
|
# @!attribute [rw] kms_key_id
|
2328
2409
|
# Specifies the KMS key ID that encrypts the logs delivered by
|
2329
2410
|
# CloudTrail. The value is a fully specified ARN to a KMS key in the
|
2330
|
-
# format
|
2411
|
+
# following format.
|
2331
2412
|
#
|
2332
2413
|
# `arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012`
|
2333
2414
|
# @return [String]
|
@@ -2386,7 +2467,7 @@ module Aws::CloudTrail
|
|
2386
2467
|
# @return [String]
|
2387
2468
|
#
|
2388
2469
|
# @!attribute [rw] home_region
|
2389
|
-
# The
|
2470
|
+
# The Amazon Web Services Region in which a trail was created.
|
2390
2471
|
# @return [String]
|
2391
2472
|
#
|
2392
2473
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/TrailInfo AWS API Documentation
|
@@ -2450,11 +2531,11 @@ module Aws::CloudTrail
|
|
2450
2531
|
# * Be between 3 and 128 characters
|
2451
2532
|
#
|
2452
2533
|
# * Have no adjacent periods, underscores or dashes. Names like
|
2453
|
-
# `my-_namespace` and `my--namespace` are
|
2534
|
+
# `my-_namespace` and `my--namespace` are not valid.
|
2454
2535
|
#
|
2455
2536
|
# * Not be in IP address format (for example, 192.168.5.4)
|
2456
2537
|
#
|
2457
|
-
# If `Name` is a trail ARN, it must be in the format
|
2538
|
+
# If `Name` is a trail ARN, it must be in the following format.
|
2458
2539
|
#
|
2459
2540
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
2460
2541
|
# @return [String]
|
@@ -2505,7 +2586,7 @@ module Aws::CloudTrail
|
|
2505
2586
|
# false.
|
2506
2587
|
#
|
2507
2588
|
# <note markdown="1"> When you disable log file integrity validation, the chain of digest
|
2508
|
-
# files is broken after one hour. CloudTrail
|
2589
|
+
# files is broken after one hour. CloudTrail does not create digest
|
2509
2590
|
# files for log files that were delivered during a period in which log
|
2510
2591
|
# file integrity validation was disabled. For example, if you enable
|
2511
2592
|
# log file integrity validation at noon on January 1, disable it at
|
@@ -2520,8 +2601,8 @@ module Aws::CloudTrail
|
|
2520
2601
|
# @!attribute [rw] cloud_watch_logs_log_group_arn
|
2521
2602
|
# Specifies a log group name using an Amazon Resource Name (ARN), a
|
2522
2603
|
# unique identifier that represents the log group to which CloudTrail
|
2523
|
-
# logs
|
2524
|
-
# CloudWatchLogsRoleArn
|
2604
|
+
# logs are delivered. Not required unless you specify
|
2605
|
+
# `CloudWatchLogsRoleArn`.
|
2525
2606
|
# @return [String]
|
2526
2607
|
#
|
2527
2608
|
# @!attribute [rw] cloud_watch_logs_role_arn
|
@@ -2535,6 +2616,10 @@ module Aws::CloudTrail
|
|
2535
2616
|
# fully specified ARN to an alias, a fully specified ARN to a key, or
|
2536
2617
|
# a globally unique identifier.
|
2537
2618
|
#
|
2619
|
+
# CloudTrail also supports KMS multi-Region keys. For more information
|
2620
|
+
# about multi-Region keys, see [Using multi-Region keys][1] in the
|
2621
|
+
# *Key Management Service Developer Guide*.
|
2622
|
+
#
|
2538
2623
|
# Examples:
|
2539
2624
|
#
|
2540
2625
|
# * alias/MyAliasName
|
@@ -2544,19 +2629,24 @@ module Aws::CloudTrail
|
|
2544
2629
|
# * arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
|
2545
2630
|
#
|
2546
2631
|
# * 12345678-1234-1234-1234-123456789012
|
2632
|
+
#
|
2633
|
+
#
|
2634
|
+
#
|
2635
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html
|
2547
2636
|
# @return [String]
|
2548
2637
|
#
|
2549
2638
|
# @!attribute [rw] is_organization_trail
|
2550
2639
|
# Specifies whether the trail is applied to all accounts in an
|
2551
|
-
# organization in
|
2552
|
-
# account. The default is false, and cannot be true unless
|
2553
|
-
# made on behalf of an
|
2554
|
-
# organization in
|
2555
|
-
# organization trail and this is set to true
|
2556
|
-
# created in all
|
2557
|
-
#
|
2558
|
-
#
|
2559
|
-
#
|
2640
|
+
# organization in Organizations, or only for the current Amazon Web
|
2641
|
+
# Services account. The default is false, and cannot be true unless
|
2642
|
+
# the call is made on behalf of an Amazon Web Services account that is
|
2643
|
+
# the management account for an organization in Organizations. If the
|
2644
|
+
# trail is not an organization trail and this is set to `true`, the
|
2645
|
+
# trail will be created in all Amazon Web Services accounts that
|
2646
|
+
# belong to the organization. If the trail is an organization trail
|
2647
|
+
# and this is set to `false`, the trail will remain in the current
|
2648
|
+
# Amazon Web Services account but be deleted from all member accounts
|
2649
|
+
# in the organization.
|
2560
2650
|
# @return [Boolean]
|
2561
2651
|
#
|
2562
2652
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/UpdateTrailRequest AWS API Documentation
|
@@ -2592,7 +2682,7 @@ module Aws::CloudTrail
|
|
2592
2682
|
# @!attribute [rw] s3_key_prefix
|
2593
2683
|
# Specifies the Amazon S3 key prefix that comes after the name of the
|
2594
2684
|
# bucket you have designated for log file delivery. For more
|
2595
|
-
# information, see [Finding Your
|
2685
|
+
# information, see [Finding Your IAM Log Files][1].
|
2596
2686
|
#
|
2597
2687
|
#
|
2598
2688
|
#
|
@@ -2600,13 +2690,13 @@ module Aws::CloudTrail
|
|
2600
2690
|
# @return [String]
|
2601
2691
|
#
|
2602
2692
|
# @!attribute [rw] sns_topic_name
|
2603
|
-
# This field is no longer in use. Use SnsTopicARN.
|
2693
|
+
# This field is no longer in use. Use UpdateTrailResponse$SnsTopicARN.
|
2604
2694
|
# @return [String]
|
2605
2695
|
#
|
2606
2696
|
# @!attribute [rw] sns_topic_arn
|
2607
2697
|
# Specifies the ARN of the Amazon SNS topic that CloudTrail uses to
|
2608
|
-
# send notifications when log files are delivered. The
|
2609
|
-
# topic ARN
|
2698
|
+
# send notifications when log files are delivered. The following is
|
2699
|
+
# the format of a topic ARN.
|
2610
2700
|
#
|
2611
2701
|
# `arn:aws:sns:us-east-2:123456789012:MyTopic`
|
2612
2702
|
# @return [String]
|
@@ -2621,8 +2711,8 @@ module Aws::CloudTrail
|
|
2621
2711
|
# @return [Boolean]
|
2622
2712
|
#
|
2623
2713
|
# @!attribute [rw] trail_arn
|
2624
|
-
# Specifies the ARN of the trail that was updated. The
|
2625
|
-
# trail ARN
|
2714
|
+
# Specifies the ARN of the trail that was updated. The following is
|
2715
|
+
# the format of a trail ARN.
|
2626
2716
|
#
|
2627
2717
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
2628
2718
|
# @return [String]
|
@@ -2633,7 +2723,7 @@ module Aws::CloudTrail
|
|
2633
2723
|
#
|
2634
2724
|
# @!attribute [rw] cloud_watch_logs_log_group_arn
|
2635
2725
|
# Specifies the Amazon Resource Name (ARN) of the log group to which
|
2636
|
-
# CloudTrail logs
|
2726
|
+
# CloudTrail logs are delivered.
|
2637
2727
|
# @return [String]
|
2638
2728
|
#
|
2639
2729
|
# @!attribute [rw] cloud_watch_logs_role_arn
|
@@ -2644,7 +2734,7 @@ module Aws::CloudTrail
|
|
2644
2734
|
# @!attribute [rw] kms_key_id
|
2645
2735
|
# Specifies the KMS key ID that encrypts the logs delivered by
|
2646
2736
|
# CloudTrail. The value is a fully specified ARN to a KMS key in the
|
2647
|
-
# format
|
2737
|
+
# following format.
|
2648
2738
|
#
|
2649
2739
|
# `arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012`
|
2650
2740
|
# @return [String]
|