AWS health documentation change
Summary
Rewrote documentation to focus on programmatic integration (API/CLI) instead of console steps. Added security use case guidance, removed detailed GUI instructions, and added JSON event pattern examples for EC2 issues/action-required events/multi-service monitoring.
Security assessment
Added explicit guidance about filtering AWS Health events with 'SECURITY' persona fields and Abuse events for security use cases, but no evidence this addresses a specific vulnerability. Changes primarily restructure documentation to emphasize API/CLI usage and provide security-oriented filtering examples.
Diff
diff --git a/health/latest/ug/creating-event-bridge-events-rule-for-aws-health.md b/health/latest/ug/creating-event-bridge-events-rule-for-aws-health.md index 082c71e93..1a06b8e38 100644 --- a//health/latest/ug/creating-event-bridge-events-rule-for-aws-health.md +++ b//health/latest/ug/creating-event-bridge-events-rule-for-aws-health.md @@ -5 +5 @@ -Creating a rule for multiple services and categories +Using the API or AWS Command Line Interface @@ -9 +9 @@ Creating a rule for multiple services and categories -You can create an EventBridge rule to get notified for AWS Health events in your account. Before you create event rules for AWS Health, do the following: +You can create an Amazon EventBridge rule to programmatically integrate AWS Health events with other services, applications, and workloads. EventBridge provides a drag and drop console interface and an API to set up rules that trigger when a matching AWS Health event is created for your account or organization. To learn how to set up a rule in EventBridge to capture AWS Health events, see [Creating rules in Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-visual.html) and [Creating rules that react to events in Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-wizard.html) in the _Amazon EventBridge User Guide_. @@ -11 +11 @@ You can create an EventBridge rule to get notified for AWS Health events in your - * Familiarize yourself with events, rules, and targets in EventBridge. For more information, see [ What is Amazon EventBridge? ](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is.html) in the _Amazon EventBridge User Guide_ and [ New EventBridge – Track and Respond to Changes to Your AWS Resources ](https://aws.amazon.com/blogs/aws/new-cloudwatch-events-track-and-respond-to-changes-to-your-aws-resources/). +Depending on your integration, EventBridge allows you to add parameters to the EventBridge rule to filter only the AWS Health events that you want to integrate with your use case. For incident response use cases, you might want to focus on the `issue` event category and certain critical services. For change management use cases such as planned lifecycle events, you might want to focus on AWS Health events with `ACTION_REQUIRED` in the **Actionability** field. For integrating with security use cases, you might want to focus on all AWS Health Abuse events and AWS Health events with the `SECURITY` persona field. @@ -13 +13 @@ You can create an EventBridge rule to get notified for AWS Health events in your - * Create the target or targets to use in your event rules. +You can use sample use cases to verify that your rule captures the events you need. Sample use cases are available in [Reference: AWS Health events Amazon EventBridge schema](./aws-health-events-eventbridge-schema.html). You can also find them in the EventBridge console under the **Use Sample events provided** option in the **Test event pattern - optional** panel @@ -14,0 +15 @@ You can create an EventBridge rule to get notified for AWS Health events in your +## Using the API or AWS Command Line Interface @@ -15,0 +17 @@ You can create an EventBridge rule to get notified for AWS Health events in your +For a new or existing rule, use the [PutRule](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutRule.html) API operation or the `aws events put-rule` command to update the event pattern. To view an example AWS CLI command, see [put-rule](https://docs.aws.amazon.com//cli/latest/reference/events/put-rule.html) in the _AWS CLI Command Reference_. @@ -16,0 +19 @@ You can create an EventBridge rule to get notified for AWS Health events in your +###### Example: Setting up rules for issues for only the Amazon EC2 service @@ -18 +21 @@ You can create an EventBridge rule to get notified for AWS Health events in your -###### To create an EventBridge rule for AWS Health +The following event pattern creates a rule to monitor issue events for the Amazon EC2 service. @@ -20,122 +22,0 @@ You can create an EventBridge rule to get notified for AWS Health events in your - 1. Open the Amazon EventBridge console at [https://console.aws.amazon.com/events/](https://console.aws.amazon.com/events/). - - 2. To change the AWS Region, use the **Region selector** in the upper-right corner of the page. Choose the Region in which you want to track AWS Health events. - - 3. In the navigation pane, choose **Rules**. - - 4. Choose **Create rule**. - - 5. On the **Define rule detail** page, enter a name and description for your rule. - - 6. Keep the default values for **Event bus** and **Rule type** , and then choose **Next**. - - 7. On the **Build event pattern** page, for **Event source** , choose **AWS events and EventBridge partner events**. - - 8. Under **Event pattern** , for **Event source** , choose **AWS services**. - - 9. Under **Event pattern** , for **AWS service** , choose **Health**. - - 10. For **Event type** , choose one of the following options. - - * **Specific Health Abuse Events** – Create a rule for AWS Health events that have the word `Abuse` in the event type name. - - * **Specific Health events** – Create a rule for events for a specific AWS service, such as Amazon EC2. - - 11. You can choose **Any service** or **Specific service(s)**. If you chose a specific service, choose one of the following options: - - * Choose **Any event type category** to create a rule that applies to all event type categories. - - * Choose **Specific event type category(s)** and then choose a value from the list, such as **issue** , **accountNotification** , or **scheduledChange**. - -###### Tip - - * To monitor all AWS Health events for a specific service, we recommend that you choose **Any event type category** and **Any resource**. This makes sures that your rule monitors for any AWS Health events, including any new event type codes, for your specified service. For an example rule, see all Amazon EC2 events. - - * You can create a rule to monitor for more than one service or event type category. To do so, you must manually update the event pattern for the rule. For more information, see Creating a rule for multiple services and categories. - - 12. If you chose a specific service and event type category, choose one of the following options for event type codes. - - * Choose **Any event type code** to create a rule that applies to all event type codes. - - * Choose **Specific event type code(s)** and then choose one or more values from the list. This creates a rule that applies only to specific event type codes. For example, if you choose **`AWS_EC2_INSTANCE_STOP_SCHEDULED`** and **`AWS_EC2_INSTANCE_RETIREMENT_SCHEDULED`** , your rule applies only to these events when they occur in your account. - - 13. Choose one of the following options for affected resources. - - * Choose **Any resource** to create a rule that applies to all resources. - - * Choose **Specific resource(s)** and enter the IDs of one or more resources. For example, you might specify an Amazon EC2 instance ID, such as `i-EXAMPLEa1b2c3de4`, to monitor for events that affect only this resource. - - 14. Review your rule setup so that it meets your event-monitoring requirements. - - 15. Choose **Next**. - - 16. On the **Select target(s)** page, choose the target type that you created for this rule, and then configure any additional options that are required for that type. For example, you might send the event to an Amazon SQS queue or an Amazon SNS topic. - - 17. Choose **Next**. - - 18. (Optional) On the **Configure tags** page, add any tags and then choose **Next**. - - * Note: Tags are currently not sent by the aws.health source in EventBridge. - - 19. On the **Review and create** page, review your rule setup and make sure that it meets your event monitoring requirements. - - 20. Choose **Create rule**. - - - - -###### Example: Rule for all Amazon EC2 events - -The following example creates a rule so that EventBridge monitors for all Amazon EC2 events, including the event type categories, event codes, and resources. - - - -###### Example: Rule for specific Amazon EC2 events - -The following example creates a rule so that EventBridge monitors the following: - - * The Amazon EC2 service - - * The **scheduledChange** event type category - - * The event type codes for `AWS_EC2_INSTANCE_TERMINATION_SCHEDULED` and `AWS_EC2_INSTANCE_RETIREMENT_SCHEDULED` - - * The instance with the ID `i-EXAMPLEa1b2c3de4` - - - - - - -## Creating a rule for multiple services and categories - -The examples in the previous procedure show you how to create a rule for a single service and event type category. You can also create a rule for multiple services and event type categories. This means that you don't have to create a separate rule for each service and category that you want to monitor. To do so, you must edit the event pattern and then enter your changes manually. - -You can use one of the following options. - -###### To add services and categories for an existing rule - - 1. In the EventBridge console, on the **Rules** page, choose the rule name. - - 2. In the upper-right corner, choose **Edit**. - - 3. Choose **Next**. - - 4. For **Event pattern** , choose **Edit pattern** , and then enter your changes into the text field. - - 5. Choose **Next** until you reach the **Review and update** page. - - 6. Choose **Update rule** to save your changes. - - - - -###### To add services and categories for a new rule - - 1. Follow the procedure in [Configuring an EventBridge rule to send notifications about events in AWS Health](./creating-event-bridge-events-rule-for-aws-health.html) to step 9. - - 2. Instead of choosing a single service or category from the lists, for **Event pattern** , choose **Edit pattern**. - - 3. Enter your changes into the text field. See the following example pattern as a model for creating your own event pattern. - - 4. Review your event pattern, and then follow the rest of the procedure in [Configuring an EventBridge rule to send notifications about events in AWS Health](./creating-event-bridge-events-rule-for-aws-health.html) to create your rule. @@ -142,0 +24,16 @@ You can use one of the following options. + { + "detail": { + "eventTypeCategory": [ + "issue" + ], + "service": [ + "EC2" + ] + }, + "detail-type": [ + "AWS Health Event" + ], + "source": [ + "aws.health" + ] + } @@ -143,0 +41 @@ You can use one of the following options. +###### Example: Setting up rules for all action required AWS Health events, including planned lifecycle events @@ -144,0 +43 @@ You can use one of the following options. +The following event pattern creates a rule to monitor all AWS Health events that require action, including planned lifecycle events. @@ -146 +44,0 @@ You can use one of the following options. -###### Use the API or AWS Command Line Interface (AWS CLI) @@ -148 +46,17 @@ You can use one of the following options. -For a new or existing rule, use the [PutRule](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutRule.html) API operation or the `aws events put-rule` command to update the event pattern. For an example AWS CLI command, see [put-rule](https://docs.aws.amazon.com//cli/latest/reference/events/put-rule.html) in the _AWS CLI Command Reference_. + { + "detail": { + "eventTypeCategory": [ + "accountNotification", + "scheduledChange" + ], + "actionability": [ + "ACTION_REQUIRED" + ] + }, + "detail-type": [ + "AWS Health Event" + ], + "source": [ + "aws.health" + ] + } @@ -150 +64 @@ For a new or existing rule, use the [PutRule](https://docs.aws.amazon.com/eventb -###### Example: Multiple services and event type categories +###### Example: Setting up rules for all AWS Health events for multiple services and event type categories @@ -152 +66 @@ For a new or existing rule, use the [PutRule](https://docs.aws.amazon.com/eventb -The following event pattern creates a rule to monitor events for the `issue`, `accountNotification`, and `scheduledChange` event type categories for three AWS services: Amazon EC2, Amazon EC2 Auto Scaling, and Amazon VPC. +The following event pattern creates a rule to monitor events for the `issue`, `accountNotification`, and `scheduledChange` event type categories for three AWS services: Amazon EC2 Auto Scaling, Amazon VPC, and Amazon EC2.