AWS eventbridge documentation change
Summary
Restructured archive creation documentation with expanded step-by-step guidance, added event pattern configuration details, and removed encryption implementation note
Security assessment
The change removes a previous statement about default AES-256 encryption using AWS-owned CMKs, but there's no explicit evidence this relates to addressing a security vulnerability. The modification appears focused on improving operational documentation rather than responding to security issues.
Diff
diff --git a/eventbridge/latest/userguide/eb-archive-event.md index 3022e01c8..81948d943 100644 --- a/eventbridge/latest/userguide/eb-archive-event.md +++ b/eventbridge/latest/userguide/eb-archive-event.md @@ -3 +3 @@ -# Creating an archive for events in Amazon EventBridge +Define the archiveBuild the event pattern (optional) @@ -5 +5 @@ -When you create an archive in EventBridge, you can determine which [events](./eb-events.html) are sent to the archive by specifying an [event pattern](./eb-event-patterns.html). EventBridge sends events that match the event pattern to the archive. You also set the retention period to store events in the archive before they are discarded. +# Creating event archives in Amazon EventBridge @@ -7 +7,9 @@ When you create an archive in EventBridge, you can determine which [events](./eb -By default, EventBridge encrypts event data in an archive using 256-bit Advanced Encryption Standard (AES-256) under an [AWS owned CMK](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk), which helps secure your data from unauthorized access. +When you create an archive in EventBridge, you can determine which events are sent to the archive by specifying an [event pattern](./eb-event-patterns.html). EventBridge sends events that match the event pattern to the archive. You also set the retention period to store events in the archive before they are discarded. + +You can also create archives as part of [creating an event bus](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-event-bus.html). These archives have an indefinite retention policy and no event filter, although this can be [updated](https://docs.aws.amazon.com/eventbridge/latest/userguide/event-bus-update-archive.html) once the archive is created. + +###### Steps + + * Define the archive + + * Build the event pattern (optional) @@ -9 +16,0 @@ By default, EventBridge encrypts event data in an archive using 256-bit Advanced -###### Note @@ -11 +17,0 @@ By default, EventBridge encrypts event data in an archive using 256-bit Advanced -The `EventCount` and `SizeBytes` values of the [`DescribeArchive`](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeArchive.html) operation have a reconciliation period of 24 hours. Therefore, any recently-expired or newly-archived events may not be immediately reflected in these values. @@ -13 +19,6 @@ The `EventCount` and `SizeBytes` values of the [`DescribeArchive`](https://docs. -###### To create an archive + +## Define the archive + +First, enter a name and description for archive, and specify the event bus from which it receives events. Optionally, you can also set how long to retain events in the archive. + +###### To define the archive @@ -17 +28,7 @@ The `EventCount` and `SizeBytes` values of the [`DescribeArchive`](https://docs. - 2. In the left navigation pane, choose **Archives**. + 2. Navigate to the source event bus, or create the archive directly: + + * In the navigation pane, choose **Event buses**. + +On the events bus details page, choose the **Archives** tab. + + * In the navigation pane, choose **Archives**. @@ -21 +38,3 @@ The `EventCount` and `SizeBytes` values of the [`DescribeArchive`](https://docs. - 4. Under **Archive detail** , enter a **Name** for the archive. The name must be unique to your account in the selected Region. + 4. Under **Archive detail** , enter a name and optionally, a description for the archive. + +The name must be unique to your account in the selected Region. You can't change the name after you create the archive. @@ -23 +42 @@ The `EventCount` and `SizeBytes` values of the [`DescribeArchive`](https://docs. -You can't change the name after you create the archive. + 5. For **Source** , select the event bus you want to send events to the archive @@ -25 +44 @@ You can't change the name after you create the archive. - 5. (Optional) Enter a **Description** for the archive. +If you navigated from an existing event bus details page, the name of that event bus appears by default. @@ -27 +46 @@ You can't change the name after you create the archive. - 6. For **Source** , select the event bus that emits the events to send to the archive. +You cannot change the source event bus once you have created the archive. @@ -29 +48 @@ You can't change the name after you create the archive. - 7. For **Retention period** , do one of the following: + 6. For **Retention period** , specify how long to retain the events in the archive: @@ -33 +52,113 @@ You can't change the name after you create the archive. - * Enter the number of days to retain the events. After the number of days specified, EventBridge deletes the events from the archive. + * For a set retention period, enter the number of days after which EventBridge should delete the events from the archive. + + 7. Choose **Next**. + + + + +## Build the event pattern (optional) + +Next, as an optional step, you can build an event pattern to filter which events EventBridge sends to the archive. To do this, specify the event source, choose the basis for the event pattern, and define the attributes and values to match on. You can also generate the event pattern in JSON and test it against a sample event. + +For more information on event patterns, see [](./eb-event-patterns.html). + +###### To build the event pattern + + 1. For **Event source** , choose **AWS events or EventBridge partner events**. + + 2. (Optional) In the **Sample events** section, choose a **Sample event type** against which you want to test your event pattern. + +The following sample event types are available: + + * **AWS events** – Select from events emitted from supported AWS services. + + * **EventBridge partner events** – Select from events emitted from third-party services that support EventBridge, such as Salesforce. + + * **Enter my own** – Enter your own event in JSON text. + +You can also use an AWS or partner event as the starting point for creating your own custom event. + + 1. Select **AWS events** or **EventBridge partner events**. + + 2. Use the **Sample events** dropdown to select the event you want to use as a starting point for your custom event. + +EventBridge displays the sample event. + + 3. Select **Copy**. + + 4. Select **Enter my own** for **Event type.** + + 5. Delete the sample event structure in the JSON editing pane, and paste the AWS or partner event in its place. + + 6. Edit the event JSON to create your own sample event. + + 3. Choose a **Creation method**. You can create an event pattern from an EventBridge schema or template, or you can create a custom event pattern. + +Existing schema + + +To use an existing EventBridge schema to create the event pattern, do the following: + + 1. In the **Creation method** section, for **Method** , select **Use schema**. + + 2. In the **Event pattern** section, for **Schema type** , select **Select schema from Schema registry**. + + 3. For **Schema registry** , choose the dropdown box and enter the name of a schema registry, such as `aws.events`. You can also select an option from the dropdown list that appears. + + 4. For **Schema** , choose the dropdown box and enter the name of the schema to use. For example, `aws.s3@ObjectDeleted`. You can also select an option from the dropdown list that appears. + + 5. In the **Models** section, choose the **Edit** button next to any attribute to open its properties. Set the **Relationship** and **Value** fields as needed, then choose **Set** to save the attribute. + +###### Note + +For information about an attribute's definition, choose the **Info** icon next to the attribute's name. For a reference on how to set attribute properties in your event, open the **Note** section of the attribute properties dialog box. + +To delete an attribute's properties, choose the **Edit** button for that attribute, then choose **Clear**. + + 6. Choose **Generate event pattern in JSON** to generate and validate your event pattern as JSON text. + + 7. (Optional) To test the sample event against your test pattern, choose **Test pattern**. + +EventBridge displays a message box stating whether your sample event matches the event pattern. + +You can also choose any of the following options: + + * **Copy** – Copy the event pattern to your device's clipboard. + + * **Prettify** – Makes the JSON text easier to read by adding line breaks, tabs, and spaces. + +Custom schema + + +To write a custom schema and convert it to an event pattern, do the following: + + 1. In the **Creation method** section, for **Method** , choose **Use schema**. + + 2. In the **Event pattern** section, for **Schema type** , choose **Enter schema**. + + 3. Enter your schema into the text box. You must format the schema as valid JSON text. + + 4. In the **Models** section, choose the **Edit** button next to any attribute to open its properties. Set the **Relationship** and **Value** fields as needed, then choose **Set** to save the attribute. + +###### Note + +For information about an attribute's definition, choose the **Info** icon next to the attribute's name. For a reference on how to set attribute properties in your event, open the **Note** section of the attribute properties dialog box. + +To delete an attribute's properties, choose the **Edit** button for that attribute, then choose **Clear**. + + 5. Choose **Generate event pattern in JSON** to generate and validate your event pattern as JSON text. + + 6. (Optional) To test the sample event against your test pattern, choose **Test pattern**. + +EventBridge displays a message box stating whether your sample event matches the event pattern. + +You can also choose any of the following options: + + * **Copy** – Copy the event pattern to your device's clipboard. + + * **Prettify** – Makes the JSON text easier to read by adding line breaks, tabs, and spaces. + +Event pattern + + +To write a custom event pattern in JSON format, do the following: @@ -35 +166 @@ You can't change the name after you create the archive. - 8. Choose **Next**. + 1. In the **Creation method** section, for **Method** , choose **Custom pattern (JSON editor)**. @@ -37 +168 @@ You can't change the name after you create the archive. - 9. For **Event pattern** , do one of the following: + 2. For **Event pattern** , enter your custom event pattern in JSON-formatted text. @@ -39 +170 @@ You can't change the name after you create the archive. - * To archive all events, choose **No event filtering**. + 3. (Optional) To test the sample event against your test pattern, choose **Test pattern**. @@ -41 +172 @@ You can't change the name after you create the archive. - * To archive specific events, specify an event pattern: +EventBridge displays a message box stating whether your sample event matches the event pattern. @@ -43 +174 @@ You can't change the name after you create the archive. - 1. Choose **Filtering events by event pattern matching** +You can also choose any of the following options: @@ -45 +176 @@ You can't change the name after you create the archive. - 2. Do one of the following: + * **Copy** – Copy the event pattern to your device's clipboard. @@ -47 +178 @@ You can't change the name after you create the archive. - * Select **Pattern builder** , then choose the **Service provider**. If you choose **AWS** , also select the **AWS service name** and **Event type** to use in the pattern. + * **Prettify** – Makes the JSON text easier to read by adding line breaks, tabs, and spaces. @@ -49 +180 @@ You can't change the name after you create the archive. - * Select **JSON editor** to create a pattern manually. You can also copy the pattern from a rule and then paste it into the JSON editor. + * **Event pattern form** – Opens the event pattern in Pattern Builder. If the pattern can't be rendered in Pattern Builder as-is, EventBridge warns you before it opens Pattern Builder. @@ -51 +182 @@ You can't change the name after you create the archive. - 10. Choose **Create archive**.