AWS cost-management documentation change
Summary
Updated documentation to replace AWS Chatbot with Amazon Q Developer for budget alerts, expanded support to Microsoft Teams, and restructured setup instructions with detailed steps for Amazon Chime, Microsoft Teams, and Slack integrations.
Security assessment
The changes include instructions for configuring IAM roles and permissions (e.g., 'Notification permissions' policy template) and references to SNS topic security policies. However, these are standard security practices for service integration rather than addressing a specific vulnerability.
Diff
diff --git a/cost-management/latest/userguide/sns-alert-chime.md b/cost-management/latest/userguide/sns-alert-chime.md index 4e3872d8c..dfd603088 100644 --- a/cost-management/latest/userguide/sns-alert-chime.md +++ b/cost-management/latest/userguide/sns-alert-chime.md @@ -5 +5 @@ -# Receiving budget alerts in Amazon Chime and Slack +# Receiving budget alerts in chat applications @@ -7 +7 @@ -You can receive your AWS Budgets alerts in Amazon Chime and Slack by using AWS Chatbot. +You can use Amazon Q Developer to receive and monitor your budget alerts in Amazon Chime, Microsoft Teams, and Slack. @@ -9 +9 @@ You can receive your AWS Budgets alerts in Amazon Chime and Slack by using AWS C -AWS Chatbot enables you to receive AWS Budgets alerts directly into your designated Slack channel or Amazon Chime chat room. +Amazon Chime @@ -11 +10,0 @@ AWS Chatbot enables you to receive AWS Budgets alerts directly into your designa -###### To begin receiving your budget alerts in Slack and Amazon Chime @@ -13 +12 @@ AWS Chatbot enables you to receive AWS Budgets alerts directly into your designa - 1. Follow [Creating a budget](./budgets-create.html) or [Editing a budget](./budgets-edit.html) and select **Configure alerts**. +###### To begin receiving your budget alerts in Amazon Chime @@ -15 +14 @@ AWS Chatbot enables you to receive AWS Budgets alerts directly into your designa - 2. Add an Amazon SNS topic as an alert recipient to a specific alert or alerts. To ensure that AWS Budgets has permissions to publish to your Amazon SNS topics, see [Creating an Amazon SNS Topic for Budget Notifications](./budgets-sns-policy.html). + 1. Go to AWS Budgets and either create a new budget or edit an existing one. @@ -17 +16 @@ AWS Chatbot enables you to receive AWS Budgets alerts directly into your designa - 3. Select **Confirm Budget**. + 2. In the budget configuration, choose **Configure alerts**. @@ -19 +18 @@ AWS Chatbot enables you to receive AWS Budgets alerts directly into your designa - 4. Select **Done**. + 3. Add an Amazon SNS topic as an alert recipient to a specific alert or alerts. @@ -21 +20,29 @@ AWS Chatbot enables you to receive AWS Budgets alerts directly into your designa - 5. Open the [AWS Chatbot console](https://us-east-2.console.aws.amazon.com/chatbot/home?region=us-east-2#/chat-clients). +###### Note + +To ensure AWS Budgets has permissions to publish to your Amazon SNS topics, see [Creating an Amazon SNS topic for budget notifications](./budgets-sns-policy.html). + + 4. Complete and save your budget configuration. + + 5. Open [Amazon Chime](http://app.chime.aws/). + + 6. For **Amazon Chime** , choose the chat room that you want to set up to receive notifications through Amazon Q Developer. + + 7. Choose the Room settings icon on the top right and choose **Manage webhooks and bots**. + +Amazon Chime displays the webhooks associated with the chat room. + + 8. For the webhook, choose **Copy URL** , and then choose **Done**. + +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**. + + 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). + + 10. Choose **Configure new client**. + + 11. Choose **Amazon Chime** , and then choose **Configure**. + + 12. Under **Configuration details** , enter a name for your configuration. The name must be unique across your account and can't be edited later. + + 13. To configure Amazon Chime webhook, do the following: + + 1. For **Webhook URL** , paste the webhook URL that you copied from Amazon Chime. @@ -23 +50 @@ AWS Chatbot enables you to receive AWS Budgets alerts directly into your designa - 6. Select your chat client. + 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. @@ -25 +52 @@ AWS Chatbot enables you to receive AWS Budgets alerts directly into your designa - 7. Choose **Configure**. + 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. @@ -27 +54 @@ AWS Chatbot enables you to receive AWS Budgets alerts directly into your designa -There are specific authorization processes for each endpoint: for example, Slack channel, Amazon Chime rooms, AWS Chatbot IAM permissions, and SNS topics receiving the budget alerts. +###### Note @@ -29 +56 @@ There are specific authorization processes for each endpoint: for example, Slack - 8. Choose **Slack workspace**. +There is an additional charge for using Amazon CloudWatch Logs. @@ -31 +58 @@ There are specific authorization processes for each endpoint: for example, Slack - 9. Choose a **channel type**. + 15. For **Permissions** , set the IAM permissions as follows: @@ -33 +60 @@ There are specific authorization processes for each endpoint: for example, Slack - * **Public** : Everyone in your workspace can see or join the channel + 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. @@ -35 +62 @@ There are specific authorization processes for each endpoint: for example, Slack - * **Private** : The channel is viewable only by invitation + 2. For **Role name** , enter a name. Valid characters: a-z, A-Z, 0-9. @@ -37 +64 @@ There are specific authorization processes for each endpoint: for example, Slack - 10. Either select an existing IAM role for AWS Chatbot to assign or create a new IAM role. + 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. @@ -39 +66 @@ There are specific authorization processes for each endpoint: for example, Slack - 11. Choose a **role name**. + 16. Set up the SNS topics that will send notifications to the Amazon Chime webhook. @@ -41 +68 @@ There are specific authorization processes for each endpoint: for example, Slack - 12. Select the Amazon SNS Region. + 1. For **SNS Region** , choose the AWS Region that hosts the SNS topics for this Amazon Q Developer subscription. @@ -43 +70 @@ There are specific authorization processes for each endpoint: for example, Slack - 13. Select the **SNS topic**. + 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. @@ -47 +74 @@ There are specific authorization processes for each endpoint: for example, Slack -You can send AWS Budgets alerts to multiple Amazon SNS topics and Regions. +You can send budget alerts to multiple Amazon SNS topics and Regions. @@ -51 +78,74 @@ At least one of the Amazon SNS topics must match the Amazon SNS topic or topics - 14. Select **Configure**. + 3. If you want to add an SNS topic from another Region to the notification subscription, choose **Add another Region**. + + 17. Choose **Configure**. + + + + +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_. + +Microsoft Teams + + +###### To begin receiving your budget alerts in Microsoft Teams + + 1. Go to AWS Budgets and either create a new budget or edit an existing one. + + 2. In the budget configuration, choose **Configure alerts**. + + 3. Add an Amazon SNS topic as an alert recipient to a specific alert or alerts. + +###### Note + +To ensure AWS Budgets has permissions to publish to your Amazon SNS topics, see [Creating an Amazon SNS topic for budget notifications](./budgets-sns-policy.html). + + 4. Complete and save your budget configuration. + + 5. Add Amazon Q Developer to your team. + + 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 **Microsoft Teams** , and then choose **Configure**. + + 9. Copy and paste your Microsoft Teams channel URL. + + 10. Choose **Configure**. + + 11. On the Microsoft Teams authorization page, choose **Accept**. + + + + +For any additional details, see [Tutorial: Get started with Microsoft Teams](https://docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html) in the _Amazon Q Developer in chat applications Administrator Guide_. + +Slack + + +###### To begin receiving your budget alerts in Slack + + 1. Go to AWS Budgets and either create a new budget or edit an existing one. + + 2. In the budget configuration, choose **Configure alerts**. + + 3. Add an Amazon SNS topic as an alert recipient to a specific alert or alerts. + +###### Note + +To ensure AWS Budgets has permissions to publish to your Amazon SNS topics, see [Creating an Amazon SNS topic for budget notifications](./budgets-sns-policy.html). + + 4. Complete and save your budget configuration. + + 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**. + + 9. From the dropdown list at the top right, choose the Slack workspace that you want to use with Amazon Q Developer. + + 10. Choose **Allow**. + @@ -54,0 +155 @@ At least one of the Amazon SNS topics must match the Amazon SNS topic or topics +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_.