AWS cost-management documentation change
Summary
Restructured documentation to separate Amazon Chime and Slack configuration processes, updated steps for webhook management, IAM role configuration, and SNS topic integration. Added detailed instructions for Amazon Q Developer setup in both platforms.
Security assessment
Changes focus on improving setup instructions and clarifying configuration steps. While IAM role/policy template details are security-related configurations, there's no evidence of addressing a specific security vulnerability. The updates represent standard security best practices documentation rather than patching a security issue.
Diff
diff --git a/cost-management/latest/userguide/cad-alert-chime.md b/cost-management/latest/userguide/cad-alert-chime.md index 224cd88b4..015553470 100644 --- a/cost-management/latest/userguide/cad-alert-chime.md +++ b/cost-management/latest/userguide/cad-alert-chime.md @@ -5 +5 @@ -# Receiving anomaly alerts in Amazon Chime and Slack +# Receiving anomaly alerts in chat applications @@ -7 +7 @@ -You can receive your AWS Cost Anomaly Detection alerts in Amazon Chime and Slack by using Amazon Q Developer in chat applications. +You can use Amazon Q Developer to receive your AWS Cost Anomaly Detection alerts in Amazon Chime and Slack. @@ -9 +9 @@ You can receive your AWS Cost Anomaly Detection alerts in Amazon Chime and Slack -You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly into your designated Slack channel or Amazon Chime chat room. +Amazon Chime @@ -11 +11,2 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in -###### To begin receiving your anomaly alerts in Slack and Amazon Chime + +###### To begin receiving your AWS Cost Anomaly Detection alerts in Amazon Chime @@ -19 +20 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in - 4. Attach the alert subscription to the monitor that you want to receive Slack or Amazon Chime alerts for. + 4. Attach the alert subscription to the monitor that you want to receive Amazon Chime alerts for. @@ -21 +22 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in - 5. Open the [AWS Chatbot console](https://us-east-2.console.aws.amazon.com/chatbot/home?region=us-east-2#/chat-clients). + 5. Open [Amazon Chime](http://app.chime.aws/). @@ -23 +24 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in - 6. Choose either Slack or Amazon Chime as your chat client. + 6. For **Amazon Chime** , choose the chat room that you want to set up to receive notifications through Amazon Q Developer. @@ -24,0 +26 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in + 7. Choose the Room settings icon on the top right and choose **Manage webhooks and bots**. @@ -25,0 +28 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in +Amazon Chime displays the webhooks associated with the chat room. @@ -26,0 +30 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in + 8. For the webhook, choose **Copy URL** , and then choose **Done**. @@ -28 +32 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in -###### To configure a Slack channel +If you need to create a new webhook for the chat room, choose **Add webhook** , enter a name for the webhook in the **Name** field, and then choose **Create**. @@ -30 +34 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in - 1. Choose **Configure new channel**. + 9. Open the [Amazon Q Developer in chat applications console](https://us-east-2.console.aws.amazon.com/chatbot/home?region=us-east-2#/chat-clients). @@ -32 +36 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in - 2. Enter a **Configuration name**. + 10. Choose **Configure new client**. @@ -34 +38 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in - 3. Choose your **Slack Channel ID**. + 11. Choose **Amazon Chime** , and then choose **Configure**. @@ -36 +40 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in - 4. In the **Permissions** section, choose a **Role setting**. Role settings determine what permissions channel members have. + 12. Under **Configuration details** , enter a name for your configuration. The name must be unique across your account and can't be edited later. @@ -38 +42 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in - * **Channel IAM role** : This role is appropriate if channel members need the same permissions. + 13. To configure Amazon Chime webhook, do the following: @@ -40 +44 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in - * **User role** : This role is appropriate if channel members require different permissions. + 1. For **Webhook URL** , paste the webhook URL that you copied from Amazon Chime. @@ -42 +46 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in - 5. (For Channel IAM role setting) Choose an existing IAM role for AWS Chatbot to assign or create a new IAM role. + 2. For **Webhook description** , use the following naming convention to describe the purpose of the webhook: **Chat_room_name/Webhook_name**. This helps you associate Amazon Chime webhooks with their Amazon Q Developer configurations. @@ -44 +48 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in - 6. Choose a **Policy template**. By default, the `Notification` permissions template is selected. + 14. If you want to enable logging for this configuration, choose **Publish logs to Amazon CloudWatch Logs**. For more information, see Amazon CloudWatch Logs for Amazon Q Developer. @@ -46 +50 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in - 7. Choose a **Channel Guardrail**. Channel guardrails provide detailed control over what actions your channel members can take. +###### Note @@ -48 +52 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in - 8. Select an **SNS topic**. +There is an additional charge for using Amazon CloudWatch Logs. @@ -50 +54 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in -###### Note + 15. For **Permissions** , set the IAM permissions as follows: @@ -52 +56 @@ You can use AWS Chatbot to receive AWS Cost Anomaly Detection alerts directly in -Amazon SNS topics are scoped to specific AWS Regions. Choose the appropriate Region to see a list of Amazon SNS topics that are available in that Region. + 1. For **IAM role** , choose **Create an IAM role using a template**. If you want to use an existing role instead, choose it from the **IAM role** list. To use an existing IAM role, you might need to modify it for use with Amazon Q Developer. For more information, see Configuring an IAM Role for Amazon Q Developer. @@ -54 +58 @@ Amazon SNS topics are scoped to specific AWS Regions. Choose the appropriate Reg -Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving your anomaly alerts in Slack and Amazon Chime** process (Step 3). + 2. For **Role name** , enter a name. Valid characters: a-z, A-Z, 0-9. @@ -56 +60 @@ Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving y - 9. Choose **Configure**. + 3. For **Policy templates** , choose **Notification permissions**. This is the IAM policy provided by Amazon Q Developer. It provides the necessary Read and List permissions for CloudWatch alarms, events, and logs, and for Amazon SNS topics. @@ -57,0 +62 @@ Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving y + 16. Set up the SNS topics that will send notifications to the Amazon Chime webhook. @@ -58,0 +64 @@ Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving y + 1. For **SNS Region** , choose the AWS Region that hosts the SNS topics for this Amazon Q Developer subscription. @@ -59,0 +66 @@ Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving y + 2. For **SNS topics** , choose the SNS topic for the client subscription. This topic determines the content that's sent to the Amazon Chime webhook. If the region has additional SNS topics, you can choose them from the same dropdown list. @@ -61 +68 @@ Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving y -###### To configure an Amazon Chime webhook + 3. If you want to add an SNS topic from another Region to the notification subscription, choose **Add another Region**. @@ -63 +70 @@ Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving y - 1. Choose **Configure a new webhook**. + 17. Choose **Configure**. @@ -65 +71,0 @@ Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving y - 2. Enter a **Configuration name**. @@ -67 +72,0 @@ Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving y - 3. Enter a **Chime Webhook URL**. You can identify a webhook URL by following the onscreen instructions. @@ -69 +73,0 @@ Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving y - 4. (Optional) Enter a description for your configuration. @@ -71 +75 @@ Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving y - 5. In the **Permissions** section, configure an IAM role. Choose an existing IAM role, or create a new IAM role. +For any additional details, see [Tutorial: Get started with Amazon Chime](https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html) in the _Amazon Q Developer in chat applications Administrator Guide_. @@ -73 +77 @@ Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving y - 6. Enter a **Role name**. +Slack @@ -75 +78,0 @@ Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving y - 7. Choose a **Policy template**. By default, the `Notification` permissions template is selected. @@ -77 +80 @@ Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving y - 8. Select an **SNS topic**. +###### To begin receiving your AWS Cost Anomaly Detection alerts in Slack @@ -79 +82,15 @@ Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving y -###### Note + 1. Follow [Getting started with AWS Cost Anomaly Detection](./getting-started-ad.html) to create a monitor. + + 2. Create an alert subscription using the `Individual alerts` type. Amazon SNS topics can be configured for `individual alerts` only. + + 3. Add an Amazon SNS topic as an alert recipient to a specific alert or alerts. To ensure that Cost Anomaly Detection has permissions to publish to your Amazon SNS topics, see [Creating an Amazon SNS topic for anomaly notifications](./ad-SNS.html). + + 4. Attach the alert subscription to the monitor that you want to receive Slack alerts for. + + 5. Add Amazon Q Developer to the Slack workspace. + + 6. Open the [Amazon Q Developer in chat applications console](https://us-east-2.console.aws.amazon.com/chatbot/home?region=us-east-2#/chat-clients). + + 7. Choose **Configure new client**. + + 8. Choose **Slack** , and then choose **Configure**. @@ -81 +98 @@ Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving y -Amazon SNS topics are scoped to specific AWS Regions. Choose the appropriate Region to see a list of Amazon SNS topics that are available in that Region. + 9. From the dropdown list at the top right, choose the Slack workspace that you want to use with Amazon Q Developer. @@ -83 +100 @@ Amazon SNS topics are scoped to specific AWS Regions. Choose the appropriate Reg -Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving your anomaly alerts in Slack and Amazon Chime** process (Step 3). + 10. Choose **Allow**. @@ -85 +101,0 @@ Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving y - 9. Choose **Configure**. @@ -88,0 +105 @@ Your Amazon SNS topic must match the Amazon SNS topic in the **Begin receiving y +For any additional details, see [Tutorial: Get started with Slack](https://docs.aws.amazon.com/chatbot/latest/adminguide/slack-setup.html) in the _Amazon Q Developer in chat applications Administrator Guide_.