AWS eventbridge: Editorial rewrite of EventBridge CloudTrail logging guide
Summary
Rewords the EventBridge CloudTrail integration page for clarity and concision, covering CloudTrail event capture, Event history, data events, advanced event selectors, and bus-to-bus forwarding data event delivery. No new security controls, configuration guidance, or vulnerability fixes are introduced.
Security assessment
The page documents CloudTrail audit logging for EventBridge API calls (an existing security/audit feature), but the diff only rephrases existing sentences (e.g., 'CloudTrail captures all API calls' becomes 'It captures all API calls') without adding or changing any security control, permission, or remediation. No vulnerability or incident is referenced.
Evidence
+Amazon EventBridge is integrated with [AWS CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html). CloudTrail records the actions taken by a user, role, or an AWS service. It captures all API calls for EventBridge as events. These include calls from the EventBridge console and calls to the EventBridge API operations. The information that CloudTrail collects shows you the request that was made to EventBridge, the source IP address, the time of the request, and more.
Diff
diff --git a/eventbridge/latest/userguide/logging-using-cloudtrail.md b/eventbridge/latest/userguide/logging-using-cloudtrail.md index 3c480c9..1a01ba5 100644 --- a//eventbridge/latest/userguide/logging-using-cloudtrail.md +++ b//eventbridge/latest/userguide/logging-using-cloudtrail.md @@ -11 +11 @@ Management eventsData eventsManagement event examplesData event examplesEvents f -Amazon EventBridge is integrated with [AWS CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html), a service that provides a record of actions taken by a user, role, or an AWS service. CloudTrail captures all API calls for EventBridge as events. The calls captured include calls from the EventBridge console and code calls to the EventBridge API operations. Using the information collected by CloudTrail, you can determine the request that was made to EventBridge, the IP address from which the request was made, when it was made, and additional details. +Amazon EventBridge is integrated with [AWS CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html). CloudTrail records the actions taken by a user, role, or an AWS service. It captures all API calls for EventBridge as events. These include calls from the EventBridge console and calls to the EventBridge API operations. The information that CloudTrail collects shows you the request that was made to EventBridge, the source IP address, the time of the request, and more. @@ -13 +13 @@ Amazon EventBridge is integrated with [AWS CloudTrail](https://docs.aws.amazon.c -Every event or log entry contains information about who generated the request. The identity information helps you determine the following: +Every event or log entry contains information about who generated the request. This identity information helps you determine the following: @@ -26 +26 @@ Every event or log entry contains information about who generated the request. T -CloudTrail is active in your AWS account when you create the account and you automatically have access to the CloudTrail **Event history**. The CloudTrail **Event history** provides a viewable, searchable, downloadable, and immutable record of the past 90 days of recorded management events in an AWS Region. For more information, see [Working with CloudTrail Event history](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html) in the _AWS CloudTrail User Guide_. There are no CloudTrail charges for viewing the **Event history**. +CloudTrail is active in your AWS account when you create the account. You automatically have access to the CloudTrail **Event history**. **Event history** gives you a viewable, searchable, downloadable, and immutable record of the past 90 days of recorded management events in an AWS Region. For more information, see [Working with CloudTrail Event history](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html) in the _AWS CloudTrail User Guide_. There are no CloudTrail charges for viewing the **Event history**. @@ -56 +56 @@ For a complete list of Custom Event Bus API operations, see [Actions](https://do -[Data events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#logging-data-events) provide information about the resource operations performed on or in a resource (for example, publishing events to an event bus). These are also known as data plane operations. Data events are often high-volume activities. By default, CloudTrail doesn't log data events. The CloudTrail **Event history** doesn't record data events. +[Data events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#logging-data-events) show you the resource operations performed on or in a resource. An example is publishing events to an event bus. These are also known as data plane operations, and they are often high-volume activities. By default, CloudTrail doesn't log data events. The CloudTrail **Event history** doesn't record data events. @@ -62 +62 @@ You can log data events for the EventBridge resource types by using the CloudTra -The following table lists the EventBridge resource types for which you can log data events. The **Resource type (console)** column shows the value to choose from the **Resource type** list on the CloudTrail console. The **resources.type value** column shows the `resources.type` value, which you would specify when configuring advanced event selectors using the AWS CLI or CloudTrail APIs. The **Data APIs logged to CloudTrail** column shows the API calls logged to CloudTrail for the resource type. +The following table lists the EventBridge resource types for which you can log data events. The **Resource type (console)** column shows the value to choose from the **Resource type** list on the CloudTrail console. The **resources.type value** column shows the `resources.type` value. You specify this value when you configure advanced event selectors with the AWS CLI or CloudTrail APIs. The **Data APIs logged to CloudTrail** column shows the API calls that CloudTrail logs for the resource type. @@ -64 +64 @@ The following table lists the EventBridge resource types for which you can log d -Resource type (console) | resources.type value | Data APIs logged to CloudTrail +EventBridge resource types for data events Resource type (console) | resources.type value | Data APIs logged to CloudTrail @@ -82 +82 @@ Resource type (console) | resources.type value | Data APIs logged to CloudTrail -You can configure advanced event selectors to filter on the `eventName`, `readOnly`, and `resources.ARN` fields to log only those events that are important to you. For more information about these fields, see [AdvancedFieldSelector](https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedFieldSelector.html) in the _AWS CloudTrail API Reference_. +You can configure advanced event selectors to filter on the `eventName`, `readOnly`, and `resources.ARN` fields. This way, you log only the events that are important to you. For more information about these fields, see [AdvancedFieldSelector](https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedFieldSelector.html) in the _AWS CloudTrail API Reference_. @@ -98 +98 @@ CloudTrail sends data events only to the AWS account that called the API. -When an account that you granted permission to via a resource policy calls `PutEvents` to your bus, only the caller's account receives the CloudTrail data event. Your account (the bus owner) does not. +You can use a resource policy to grant another account permission to your bus. When that account calls `PutEvents` to your bus, only the caller's account receives the CloudTrail data event. Your account (the bus owner) does not. @@ -104 +104 @@ Up to four accounts can be involved in a bus-to-bus forwarding scenario. The fol -Account role | Receives CloudTrail data event +CloudTrail data event delivery for bus-to-bus forwarding Account role | Receives CloudTrail data event @@ -108 +108 @@ The account that owns the source bus (the source bus owner) | No. -The account that owns the rule and the IAM role on the rule target (the rule owner) | Yes, but only for cross-Region forwarding. For cross-Region forwarding, EventBridge uses the IAM role on the rule target to call `PutEvents` on the destination Region. This makes the rule owner's account the effective API caller. Same-Region forwarding does not generate an additional data event. +The account that owns the rule and the IAM role on the rule target (the rule owner) | Yes, but only for cross-Region forwarding. For cross-Region forwarding, EventBridge uses the IAM role on the rule target to call `PutEvents` in the destination Region. This makes the rule owner's account the API caller. Same-Region forwarding does not generate an additional data event. @@ -113 +113 @@ The account that owns the destination bus (the destination bus owner) | No. -For cross-Region forwarding, the original `PutEvents` call and the forwarding `PutEvents` call are recorded as separate CloudTrail data events in their respective Regions. To capture both, ensure that CloudTrail is configured to log data events in both Regions. +For cross-Region forwarding, CloudTrail records the original `PutEvents` call and the forwarding `PutEvents` call as separate data events in their respective Regions. To capture both, make sure that CloudTrail logs data events in both Regions. @@ -117 +117 @@ For cross-Region forwarding, the original `PutEvents` call and the forwarding `P -When you use a global endpoint with event replication enabled, EventBridge creates a managed rule that forwards events cross-Region to the secondary bus. This is a cross-Region bus-to-bus forwarding scenario, so the same rules from the table above apply: +When you use a global endpoint with event replication enabled, EventBridge creates a managed rule. This rule forwards events cross-Region to the secondary bus. This is a cross-Region bus-to-bus forwarding scenario, so the same rules described in Bus-to-bus forwarding apply: @@ -121 +121 @@ When you use a global endpoint with event replication enabled, EventBridge creat - * Secondary Region: Because you own the managed rule and the IAM role used to replicate events, your account receives a data event for the replication `PutEvents` call. The event includes only the event bus ARN. The endpoint resource ARN is not included. + * Secondary Region: Your account owns the managed rule and the IAM role that replicates events. As a result, your account receives a data event for the replication `PutEvents` call. This event includes only the event bus ARN. It does not include the endpoint resource ARN. @@ -466 +466 @@ The following example shows a CloudTrail data event for a successful `PutPartner -EventBridge Pipes assumes the provided IAM role when reading events from sources, invoking enrichments, or invoking targets. For CloudTrail entries related to actions taken in your account on all enrichments, targets, and Amazon SQS, Kinesis, and DynamoDB sources, the `sourceIPAddress` and `invokedBy` fields will include `pipes.amazonaws.com`. +EventBridge Pipes assumes the provided IAM role when it reads events from sources, invokes enrichments, or invokes targets. Some CloudTrail entries cover actions taken in your account on all enrichments, targets, and Amazon SQS, Kinesis, and DynamoDB sources. For these entries, the `sourceIPAddress` and `invokedBy` fields include `pipes.amazonaws.com`. @@ -513 +513 @@ EventBridge Pipes assumes the provided IAM role when reading events from sources -For all other sources, the `sourceIPAddress` field of the CloudTrail log entries will have a dynamic IP address and shouldn't be relied upon for any integration or event categorization. In addition, these entries won't have the `invokedBy` field. +For all other sources, the `sourceIPAddress` field of the CloudTrail log entries has a dynamic IP address. Don't rely on this field for any integration or event categorization. These entries also don't have the `invokedBy` field.