docs(client-cloudtrail): Doc-only update for CloudTrail network activ…

…ity events release (in preview)
aws · Sep 25, 2024 · 082bad8 · 082bad8
1 parent b92df20
commit 082bad8
Show file tree

Hide file tree

Showing 7 changed files with 281 additions and 690 deletions.
diff --git a/clients/client-cloudtrail/src/commands/GetEventSelectorsCommand.ts b/clients/client-cloudtrail/src/commands/GetEventSelectorsCommand.ts
@@ -33,17 +33,21 @@ export interface GetEventSelectorsCommandOutput extends GetEventSelectorsRespons
  *          <ul>
  *             <li>
  *                <p>If your event selector includes read-only events, write-only events, or all
- *                events. This applies to both management events and data events.</p>
+ *                events. This applies to management events, data events, and network activity events.</p>
  *             </li>
  *             <li>
  *                <p>If your event selector includes management events.</p>
  *             </li>
  *             <li>
+ *                <p>If your event selector includes network activity events, the event sources
+ *                for which you are logging network activity events.</p>
+ *             </li>
+ *             <li>
  *                <p>If your event selector includes data events, the resources on which you are
  *                logging data events.</p>
  *             </li>
  *          </ul>
- *          <p>For more information about logging management and data events, see the following topics
+ *          <p>For more information about logging management, data, and network activity events, see the following topics
  *          in the <i>CloudTrail User Guide</i>:</p>
  *          <ul>
  *             <li>
@@ -56,6 +60,11 @@ export interface GetEventSelectorsCommandOutput extends GetEventSelectorsRespons
  *                   <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html">Logging data events</a>
  *                </p>
  *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-network-events-with-cloudtrail.html">Logging network activity events</a>
+ *                </p>
+ *             </li>
  *          </ul>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-cloudtrail/src/commands/PutEventSelectorsCommand.ts b/clients/client-cloudtrail/src/commands/PutEventSelectorsCommand.ts
@@ -28,20 +28,43 @@ export interface PutEventSelectorsCommandInput extends PutEventSelectorsRequest
 export interface PutEventSelectorsCommandOutput extends PutEventSelectorsResponse, __MetadataBearer {}
 
 /**
- * <p>Configures an event selector or advanced event selectors for your trail. Use event
- *          selectors or advanced event selectors to specify management and data event settings for
- *          your trail. If you want your trail to log Insights events, be sure the event selector
- *          enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html">Logging Insights events</a> in the <i>CloudTrail User Guide</i>.
+ * <p>Configures event selectors (also referred to as <i>basic event selectors</i>) or advanced event selectors for your trail. You can use
+ *          either <code>AdvancedEventSelectors</code> or <code>EventSelectors</code>, but not both. If
+ *          you apply <code>AdvancedEventSelectors</code> to a trail, any existing
+ *          <code>EventSelectors</code> are overwritten.</p>
+ *          <p>You can use <code>AdvancedEventSelectors</code> to
+ *          log management events, data events for all resource types, and network activity events.</p>
+ *          <p>You can use <code>EventSelectors</code> to log management events and data events for the following resource types:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <code>AWS::DynamoDB::Table</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>AWS::Lambda::Function</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>AWS::S3::Object</code>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>You can't use <code>EventSelectors</code> to log network activity events.</p>
+ *          <p>If you want your trail to log Insights events, be sure the event selector or advanced event selector enables
+ *          logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html">Logging Insights events</a> in the <i>CloudTrail User Guide</i>.
  *          By default, trails created without specific event selectors are configured to
- *          log all read and write management events, and no data events.</p>
+ *          log all read and write management events, and no data events or network activity events.</p>
  *          <p>When an event occurs in your account, CloudTrail evaluates the event selectors or
  *          advanced event selectors in all trails. For each trail, if the event matches any event
  *          selector, the trail processes and logs the event. If the event doesn't match any event
  *          selector, the trail doesn't log the event.</p>
  *          <p>Example</p>
  *          <ol>
  *             <li>
- *                <p>You create an event selector for a trail and specify that you want write-only
+ *                <p>You create an event selector for a trail and specify that you want to log write-only
  *                events.</p>
  *             </li>
  *             <li>
@@ -63,16 +86,13 @@ export interface PutEventSelectorsCommandOutput extends PutEventSelectorsRespons
  *          <p>The <code>PutEventSelectors</code> operation must be called from the Region in which the
  *          trail was created; otherwise, an <code>InvalidHomeRegionException</code> exception is
  *          thrown.</p>
- *          <p>You can configure up to five event selectors for each trail. For more information, see
- *             <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html">Logging management events</a>, <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html">Logging
- *             data events</a>, and <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html">Quotas in CloudTrail</a> in the <i>CloudTrail User
- *          Guide</i>.</p>
+ *          <p>You can configure up to five event selectors for each trail.</p>
  *          <p>You can add advanced event selectors, and conditions for your advanced event selectors,
- *          up to a maximum of 500 values for all conditions and selectors on a trail. You can use
- *          either <code>AdvancedEventSelectors</code> or <code>EventSelectors</code>, but not both. If
- *          you apply <code>AdvancedEventSelectors</code> to a trail, any existing
- *             <code>EventSelectors</code> are overwritten. For more information about advanced event
- *          selectors, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html">Logging data events</a> in the <i>CloudTrail User Guide</i>.</p>
+ *          up to a maximum of 500 values for all conditions and selectors on a trail. For more information, see
+ *          <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html">Logging management events</a>, <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html">Logging
+ *                data events</a>, <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-network-events-with-cloudtrail.html">Logging
+ *                   network activity events</a>, and <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html">Quotas in CloudTrail</a> in the <i>CloudTrail User
+ *                            Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-cloudtrail/src/commands/StartEventDataStoreIngestionCommand.ts b/clients/client-cloudtrail/src/commands/StartEventDataStoreIngestionCommand.ts
@@ -34,7 +34,7 @@ export interface StartEventDataStoreIngestionCommandOutput
 
 /**
  * <p>Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store <code>Status</code> must be <code>STOPPED_INGESTION</code>
- *          and the <code>eventCategory</code> must be <code>Management</code>, <code>Data</code>, or <code>ConfigurationItem</code>.</p>
+ *          and the <code>eventCategory</code> must be <code>Management</code>, <code>Data</code>, <code>NetworkActivity</code>, or <code>ConfigurationItem</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-cloudtrail/src/commands/StopEventDataStoreIngestionCommand.ts b/clients/client-cloudtrail/src/commands/StopEventDataStoreIngestionCommand.ts
@@ -31,7 +31,7 @@ export interface StopEventDataStoreIngestionCommandOutput
 
 /**
  * <p>Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To stop ingestion, the event data store <code>Status</code> must be <code>ENABLED</code>
- *          and the <code>eventCategory</code> must be <code>Management</code>, <code>Data</code>, or <code>ConfigurationItem</code>.</p>
+ *          and the <code>eventCategory</code> must be <code>Management</code>, <code>Data</code>, <code>NetworkActivity</code>, or <code>ConfigurationItem</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-cloudtrail/src/commands/UpdateEventDataStoreCommand.ts b/clients/client-cloudtrail/src/commands/UpdateEventDataStoreCommand.ts
@@ -34,7 +34,7 @@ export interface UpdateEventDataStoreCommandOutput extends UpdateEventDataStoreR
  *             <code>RetentionPeriod</code> is in days, and valid values are integers between 7 and
  *          3653 if the <code>BillingMode</code> is set to <code>EXTENDABLE_RETENTION_PRICING</code>, or between 7 and 2557 if <code>BillingMode</code> is set to <code>FIXED_RETENTION_PRICING</code>. By default, <code>TerminationProtection</code> is enabled.</p>
  *          <p>For event data stores for CloudTrail events, <code>AdvancedEventSelectors</code>
- *          includes or excludes management or data events in your event data store. For more
+ *          includes or excludes management, data, or network activity events in your event data store. For more
  *          information about <code>AdvancedEventSelectors</code>, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.html">AdvancedEventSelectors</a>.</p>
  *          <p> For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,
  *             <code>AdvancedEventSelectors</code> includes events of that type in your event data store.</p>