AWS.Tools.CloudTrail.XML

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
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>AWS.Tools.CloudTrail</name>
    </assembly>
    <members>
        <member name="T:Amazon.PowerShell.Cmdlets.CT.AddCTResourceTagCmdlet">
            <summary>
            Adds one or more tags to a trail, up to a limit of 50. Tags must be unique per trail.
            Overwrites an existing tag's value when a new value is specified for an existing tag
            key. If you specify a key without a value, the tag will be created with the specified
            key and a value of null. You can tag a trail that applies to all regions only from
            the region in which the trail was created (that is, from its home region).
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.AddCTResourceTagCmdlet.ResourceId">
            <summary>
            <para>
            <para>Specifies the ARN of the trail to which one or more tags will be added. The format
            of a trail ARN is:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.AddCTResourceTagCmdlet.TagsList">
            <summary>
            <para>
            <para>Contains a list of CloudTrail tags, up to a limit of 50</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.AddCTResourceTagCmdlet.PassThru">
            <summary>
            Returns the value passed to the ResourceId parameter.
            By default, this cmdlet does not generate any output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.AddCTResourceTagCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CT.FindCTEventCmdlet">
            <summary>
            Looks up <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-management-events">management
            events</a> captured by CloudTrail. Events for a region can be looked up in that region
            during the last 90 days. Lookup supports the following attributes:
             
             <ul><li><para>
            AWS access key
            </para></li><li><para>
            Event ID
            </para></li><li><para>
            Event name
            </para></li><li><para>
            Event source
            </para></li><li><para>
            Read only
            </para></li><li><para>
            Resource name
            </para></li><li><para>
            Resource type
            </para></li><li><para>
            User name
            </para></li></ul><para>
            All attributes are optional. The default number of results returned is 50, with a
            maximum of 50 possible. The response includes a token that you can use to get the
            next page of results.
            </para><important><para>
            The rate of lookup requests is limited to one per second per account. If this limit
            is exceeded, a throttling error occurs.
            </para></important><important><para>
            Events that occurred during the selected time range will not be available for lookup
            if CloudTrail logging was not enabled when the events occurred.
            </para></important><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.FindCTEventCmdlet.EndTime">
            <summary>
            <para>
            <para>Specifies that only events that occur before or at the specified time are returned.
            If the specified end time is before the specified start time, an error is returned.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.FindCTEventCmdlet.LookupAttribute">
            <summary>
            <para>
            <para>Contains a list of lookup attributes. Currently the list can contain only one item.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.FindCTEventCmdlet.StartTime">
            <summary>
            <para>
            <para>Specifies that only events that occur after or at the specified time are returned.
            If the specified start time is after the specified end time, an error is returned.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.FindCTEventCmdlet.MaxResult">
            <summary>
            <para>
            <para>The number of events to return. Possible values are 1 through 50. The default is 50.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.FindCTEventCmdlet.NextToken">
            <summary>
            <para>
            <para>The token to use to get the next page of results after a previous API call. This token
            must be passed in with the same parameters that were specified in the the original
            call. For example, if the original call specified an AttributeKey of 'Username' with
            a value of 'root', the call with NextToken should include those same parameters.</para>
            </para>
            <para>
            <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call.
            <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTEventSelectorCmdlet">
            <summary>
            Describes the settings for the event selectors that you configured for your trail.
            The information returned for your event selectors includes the following:
             
             <ul><li><para>
            If your event selector includes read-only events, write-only events, or all events.
            This applies to both management events and data events.
            </para></li><li><para>
            If your event selector includes management events.
            </para></li><li><para>
            If your event selector includes data events, the Amazon S3 objects or AWS Lambda functions
            that you are logging for data events.
            </para></li></ul><para>
            For more information, see <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html">Logging
            Data and Management Events for Trails </a> in the <i>AWS CloudTrail User Guide</i>.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTEventSelectorCmdlet.TrailName">
            <summary>
            <para>
            <para>Specifies the name of the trail or trail ARN. If you specify a trail name, the string
            must meet the following requirements:</para><ul><li><para>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_),
            or dashes (-)</para></li><li><para>Start with a letter or number, and end with a letter or number</para></li><li><para>Be between 3 and 128 characters</para></li><li><para>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code>
            and <code>my--namespace</code> are not valid.</para></li><li><para>Not be in IP address format (for example, 192.168.5.4)</para></li></ul><para>If you specify a trail ARN, it must be in the format:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para>
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTPublicKeyCmdlet">
            <summary>
            Returns all public keys whose private keys were used to sign the digest files within
            the specified time range. The public key is needed to validate digest files that were
            signed with its corresponding private key.
             
             <note><para>
            CloudTrail uses different private/public key pairs per region. Each digest file is
            signed with a private key unique to its region. Therefore, when you validate a digest
            file from a particular region, you must look in the same region for its corresponding
            public key.
            </para></note><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTPublicKeyCmdlet.EndTime">
            <summary>
            <para>
            <para>Optionally specifies, in UTC, the end of the time range to look up public keys for
            CloudTrail digest files. If not specified, the current time is used.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTPublicKeyCmdlet.StartTime">
            <summary>
            <para>
            <para>Optionally specifies, in UTC, the start of the time range to look up public keys for
            CloudTrail digest files. If not specified, the current time is used, and the current
            public key is returned.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTPublicKeyCmdlet.NextToken">
            <summary>
            <para>
            <para>Reserved for future use.</para>
            </para>
            <para>
            <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call.
            <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTResourceTagCmdlet">
            <summary>
            Lists the tags for the trail in the current region.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTResourceTagCmdlet.ResourceIdList">
            <summary>
            <para>
            <para>Specifies a list of trail ARNs whose tags will be listed. The list has a limit of
            20 ARNs. The format of a trail ARN is:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTResourceTagCmdlet.NextToken">
            <summary>
            <para>
            <para>Reserved for future use.</para>
            </para>
            <para>
            <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call.
            <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTTrailCmdlet">
            <summary>
            Retrieves settings for the trail associated with the current region for your account.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTrailCmdlet.IncludeShadowTrail">
            <summary>
            <para>
            <para>Specifies whether to include shadow trails in the response. A shadow trail is the
            replication in a region of a trail that was created in a different region, or in the
            case of an organization trail, the replication of an organization trail in member
            accounts. If you do not include shadow trails, organization trails in a member account
            and region replication trails will not be returned. The default is true.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTrailCmdlet.TrailNameList">
            <summary>
            <para>
            <para>Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The
            format of a trail ARN is:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para><para>If an empty list is specified, information for the trail in the current region is
            returned.</para><ul><li><para>If an empty list is specified and <code>IncludeShadowTrails</code> is false, then
            information for all trails in the current region is returned.</para></li><li><para>If an empty list is specified and IncludeShadowTrails is null or true, then information
            for all trails in the current region and any associated shadow trails in other regions
            is returned.</para></li></ul><note><para>If one or more trail names are specified, information is returned only if the names
            match the names of trails belonging only to the current region. To return information
            about a trail in another region, you must specify its trail ARN.</para></note>
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTTrailStatusCmdlet">
            <summary>
            Returns a JSON-formatted list of information about the specified trail. Fields include
            information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop
            logging times for each trail. This operation returns trail status from a single region.
            To return trail status from all regions, you must call the operation on each region.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTrailStatusCmdlet.Name">
            <summary>
            <para>
            <para>Specifies the name or the CloudTrail ARN of the trail for which you are requesting
            status. To get the status of a shadow trail (a replication of the trail in another
            region), you must specify its ARN. The format of a trail ARN is:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para>
            </para>
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet">
            <summary>
            Creates a trail that specifies the settings for delivery of log data to an Amazon
            S3 bucket. A maximum of five trails can exist in a region, irrespective of the region
            in which they were created.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.CloudWatchLogsLogGroupArn">
            <summary>
            <para>
            <para>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier
            that represents the log group to which CloudTrail logs will be delivered. Not required
            unless you specify CloudWatchLogsRoleArn.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.CloudWatchLogsRoleArn">
            <summary>
            <para>
            <para>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's
            log group.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.EnableLogFileValidation">
            <summary>
            <para>
            <para>Specifies whether log file integrity validation is enabled. The default is false.</para><note><para>When you disable log file integrity validation, the chain of digest files is broken
            after one hour. CloudTrail will not create digest files for log files that were delivered
            during a period in which log file integrity validation was disabled. For example,
            if you enable log file integrity validation at noon on January 1, disable it at noon
            on January 2, and re-enable it at noon on January 10, digest files will not be created
            for the log files delivered from noon on January 2 to noon on January 10. The same
            applies whenever you stop CloudTrail logging or delete a trail.</para></note>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.IncludeGlobalServiceEvent">
            <summary>
            <para>
            <para>Specifies whether the trail is publishing events from global services such as IAM
            to the log files.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.IsMultiRegionTrail">
            <summary>
            <para>
            <para>Specifies whether the trail is created in the current region or in all regions. The
            default is false.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.IsOrganizationTrail">
            <summary>
            <para>
            <para>Specifies whether the trail is created for all accounts in an organization in AWS
            Organizations, or only for the current AWS account. The default is false, and cannot
            be true unless the call is made on behalf of an AWS account that is the master account
            for an organization in AWS Organizations.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.KmsKeyId">
            <summary>
            <para>
            <para>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value
            can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully
            specified ARN to a key, or a globally unique identifier.</para><para>Examples:</para><ul><li><para>alias/MyAliasName</para></li><li><para>arn:aws:kms:us-east-2:123456789012:alias/MyAliasName</para></li><li><para>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</para></li><li><para>12345678-1234-1234-1234-123456789012</para></li></ul>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.Name">
            <summary>
            <para>
            <para>Specifies the name of the trail. The name must meet the following requirements:</para><ul><li><para>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_),
            or dashes (-)</para></li><li><para>Start with a letter or number, and end with a letter or number</para></li><li><para>Be between 3 and 128 characters</para></li><li><para>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code>
            and <code>my--namespace</code> are invalid.</para></li><li><para>Not be in IP address format (for example, 192.168.5.4)</para></li></ul>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.S3BucketName">
            <summary>
            <para>
            <para>Specifies the name of the Amazon S3 bucket designated for publishing log files. See
            <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon
            S3 Bucket Naming Requirements</a>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.S3KeyPrefix">
            <summary>
            <para>
            <para>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have
            designated for log file delivery. For more information, see <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding
            Your CloudTrail Log Files</a>. The maximum length is 200 characters.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.SnsTopicName">
            <summary>
            <para>
            <para>Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
            The maximum length is 256 characters.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CT.RemoveCTResourceTagCmdlet">
            <summary>
            Removes the specified tags from a trail.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTResourceTagCmdlet.ResourceId">
            <summary>
            <para>
            <para>Specifies the ARN of the trail from which tags should be removed. The format of a
            trail ARN is:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTResourceTagCmdlet.TagsList">
            <summary>
            <para>
            <para>Specifies a list of tags to be removed.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTResourceTagCmdlet.PassThru">
            <summary>
            Returns the value passed to the ResourceId parameter.
            By default, this cmdlet does not generate any output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTResourceTagCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CT.RemoveCTTrailCmdlet">
            <summary>
            Deletes a trail. This operation must be called from the region in which the trail
            was created. <code>DeleteTrail</code> cannot be called on the shadow trails (replicated
            trails in other regions) of a trail that is enabled in all regions.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTTrailCmdlet.Name">
            <summary>
            <para>
            <para>Specifies the name or the CloudTrail ARN of the trail to be deleted. The format of
            a trail ARN is: <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTTrailCmdlet.PassThru">
            <summary>
            Returns the value passed to the Name parameter.
            By default, this cmdlet does not generate any output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTTrailCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CT.StartCTLoggingCmdlet">
            <summary>
            Starts the recording of AWS API calls and log file delivery for a trail. For a trail
            that is enabled in all regions, this operation must be called from the region in which
            the trail was created. This operation cannot be called on the shadow trails (replicated
            trails in other regions) of a trail that is enabled in all regions.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTLoggingCmdlet.Name">
            <summary>
            <para>
            <para>Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs AWS
            API calls. The format of a trail ARN is:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTLoggingCmdlet.PassThru">
            <summary>
            Returns the value passed to the Name parameter.
            By default, this cmdlet does not generate any output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTLoggingCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CT.StopCTLoggingCmdlet">
            <summary>
            Suspends the recording of AWS API calls and log file delivery for the specified trail.
            Under most circumstances, there is no need to use this action. You can update a trail
            without stopping it first. This action is the only way to stop recording. For a trail
            enabled in all regions, this operation must be called from the region in which the
            trail was created, or an <code>InvalidHomeRegionException</code> will occur. This
            operation cannot be called on the shadow trails (replicated trails in other regions)
            of a trail enabled in all regions.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTLoggingCmdlet.Name">
            <summary>
            <para>
            <para>Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop
            logging AWS API calls. The format of a trail ARN is:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTLoggingCmdlet.PassThru">
            <summary>
            Returns the value passed to the Name parameter.
            By default, this cmdlet does not generate any output.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTLoggingCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet">
            <summary>
            Updates the settings that specify delivery of log files. Changes to a trail do not
            require stopping the CloudTrail service. Use this action to designate an existing
            bucket for log delivery. If the existing bucket has previously been a target for CloudTrail
            log files, an IAM policy exists for the bucket. <code>UpdateTrail</code> must be called
            from the region in which the trail was created; otherwise, an <code>InvalidHomeRegionException</code>
            is thrown.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.CloudWatchLogsLogGroupArn">
            <summary>
            <para>
            <para>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier
            that represents the log group to which CloudTrail logs will be delivered. Not required
            unless you specify CloudWatchLogsRoleArn.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.CloudWatchLogsRoleArn">
            <summary>
            <para>
            <para>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's
            log group.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.EnableLogFileValidation">
            <summary>
            <para>
            <para>Specifies whether log file validation is enabled. The default is false.</para><note><para>When you disable log file integrity validation, the chain of digest files is broken
            after one hour. CloudTrail will not create digest files for log files that were delivered
            during a period in which log file integrity validation was disabled. For example,
            if you enable log file integrity validation at noon on January 1, disable it at noon
            on January 2, and re-enable it at noon on January 10, digest files will not be created
            for the log files delivered from noon on January 2 to noon on January 10. The same
            applies whenever you stop CloudTrail logging or delete a trail.</para></note>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.IncludeGlobalServiceEvent">
            <summary>
            <para>
            <para>Specifies whether the trail is publishing events from global services such as IAM
            to the log files.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.IsMultiRegionTrail">
            <summary>
            <para>
            <para>Specifies whether the trail applies only to the current region or to all regions.
            The default is false. If the trail exists only in the current region and this value
            is set to true, shadow trails (replications of the trail) will be created in the other
            regions. If the trail exists in all regions and this value is set to false, the trail
            will remain in the region where it was created, and its shadow trails in other regions
            will be deleted.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.IsOrganizationTrail">
            <summary>
            <para>
            <para>Specifies whether the trail is applied to all accounts in an organization in AWS Organizations,
            or only for the current AWS account. The default is false, and cannot be true unless
            the call is made on behalf of an AWS account that is the master account for an organization
            in AWS Organizations. If the trail is not an organization trail and this is set to
            true, the trail will be created in all AWS accounts that belong to the organization.
            If the trail is an organization trail and this is set to false, the trail will remain
            in the current AWS account but be deleted from all member accounts in the organization.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.KmsKeyId">
            <summary>
            <para>
            <para>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value
            can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully
            specified ARN to a key, or a globally unique identifier.</para><para>Examples:</para><ul><li><para>alias/MyAliasName</para></li><li><para>arn:aws:kms:us-east-2:123456789012:alias/MyAliasName</para></li><li><para>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</para></li><li><para>12345678-1234-1234-1234-123456789012</para></li></ul>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.Name">
            <summary>
            <para>
            <para>Specifies the name of the trail or trail ARN. If <code>Name</code> is a trail name,
            the string must meet the following requirements:</para><ul><li><para>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_),
            or dashes (-)</para></li><li><para>Start with a letter or number, and end with a letter or number</para></li><li><para>Be between 3 and 128 characters</para></li><li><para>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code>
            and <code>my--namespace</code> are invalid.</para></li><li><para>Not be in IP address format (for example, 192.168.5.4)</para></li></ul><para>If <code>Name</code> is a trail ARN, it must be in the format:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.S3BucketName">
            <summary>
            <para>
            <para>Specifies the name of the Amazon S3 bucket designated for publishing log files. See
            <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon
            S3 Bucket Naming Requirements</a>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.S3KeyPrefix">
            <summary>
            <para>
            <para>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have
            designated for log file delivery. For more information, see <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding
            Your CloudTrail Log Files</a>. The maximum length is 200 characters.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.SnsTopicName">
            <summary>
            <para>
            <para>Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
            The maximum length is 256 characters.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CT.WriteCTEventSelectorCmdlet">
            <summary>
            Configures an event selector for your trail. Use event selectors to further specify
            the management and data event settings for your trail. By default, trails created
            without specific event selectors will be configured to log all read and write management
            events, and no data events.
             
              
            <para>
            When an event occurs in your account, CloudTrail evaluates the event selectors in
            all trails. For each trail, if the event matches any event selector, the trail processes
            and logs the event. If the event doesn't match any event selector, the trail doesn't
            log the event.
            </para><para>
            Example
            </para><ol><li><para>
            You create an event selector for a trail and specify that you want write-only events.
            </para></li><li><para>
            The EC2 <code>GetConsoleOutput</code> and <code>RunInstances</code> API operations
            occur in your account.
            </para></li><li><para>
            CloudTrail evaluates whether the events match your event selectors.
            </para></li><li><para>
            The <code>RunInstances</code> is a write-only event and it matches your event selector.
            The trail logs the event.
            </para></li><li><para>
            The <code>GetConsoleOutput</code> is a read-only event but it doesn't match your event
            selector. The trail doesn't log the event.
            </para></li></ol><para>
            The <code>PutEventSelectors</code> operation must be called from the region in which
            the trail was created; otherwise, an <code>InvalidHomeRegionException</code> is thrown.
            </para><para>
            You can configure up to five event selectors for each trail. For more information,
            see <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html">Logging
            Data and Management Events for Trails </a> and <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html">Limits
            in AWS CloudTrail</a> in the <i>AWS CloudTrail User Guide</i>.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTEventSelectorCmdlet.EventSelector">
            <summary>
            <para>
            <para>Specifies the settings for your event selectors. You can configure up to five event
            selectors for a trail.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTEventSelectorCmdlet.TrailName">
            <summary>
            <para>
            <para>Specifies the name of the trail or trail ARN. If you specify a trail name, the string
            must meet the following requirements:</para><ul><li><para>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_),
            or dashes (-)</para></li><li><para>Start with a letter or number, and end with a letter or number</para></li><li><para>Be between 3 and 128 characters</para></li><li><para>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code>
            and <code>my--namespace</code> are invalid.</para></li><li><para>Not be in IP address format (for example, 192.168.5.4)</para></li></ul><para>If you specify a trail ARN, it must be in the format:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTEventSelectorCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
    </members>
</doc>