# AWS::Chatbot Construct Library
<!--BEGIN STABILITY BANNER-->---
---
<!--END STABILITY BANNER-->
AWS Chatbot is an AWS service that enables DevOps and software development teams to use Slack chat rooms to monitor and respond to operational events in their AWS Cloud. AWS Chatbot processes AWS service notifications from Amazon Simple Notification Service (Amazon SNS), and forwards them to Slack chat rooms so teams can analyze and act on them immediately, regardless of location.
This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.
```python
import aws_cdk.aws_chatbot as chatbot
import aws_cdk.aws_sns as sns
import aws_cdk.aws_iam as iam
slack_channel = chatbot.SlackChannelConfiguration(self, "MySlackChannel",
slack_channel_configuration_name="YOUR_CHANNEL_NAME",
slack_workspace_id="YOUR_SLACK_WORKSPACE_ID",
slack_channel_id="YOUR_SLACK_CHANNEL_ID"
)
slack_channel.add_to_role_policy(iam.PolicyStatement(
effect=iam.Effect.ALLOW,
actions=["s3:GetObject"
],
resources=["arn:aws:s3:::abc/xyz/123.txt"]
))
slack_channel.add_notification_topic(sns.Topic(self, "MyTopic"))
```
## Log Group
Slack channel configuration automatically create a log group with the name `/aws/chatbot/<configuration-name>` in `us-east-1` upon first execution with
log data set to never expire.
The `logRetention` property can be used to set a different expiration period. A log group will be created if not already exists.
If the log group already exists, it's expiration will be configured to the value specified in this construct (never expire, by default).
By default, CDK uses the AWS SDK retry options when interacting with the log group. The `logRetentionRetryOptions` property
allows you to customize the maximum number of retries and base backoff duration.
*Note* that, if `logRetention` is set, a [CloudFormation custom
resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html) is added
to the stack that pre-creates the log group as part of the stack deployment, if it already doesn't exist, and sets the
correct log retention period (never expire, by default).
Raw data
{
"_id": null,
"home_page": "https://github.com/aws/aws-cdk",
"name": "aws-cdk.aws-chatbot",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Amazon Web Services",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/97/9e/766146f6f817e6674dfe6bc75b0dd778df8b3ab9adfc349a34afb2b1ddf5/aws-cdk.aws-chatbot-1.203.0.tar.gz",
"platform": null,
"description": "# AWS::Chatbot Construct Library\n\n<!--BEGIN STABILITY BANNER-->---\n\n\n\n\n\n\n---\n<!--END STABILITY BANNER-->\n\nAWS Chatbot is an AWS service that enables DevOps and software development teams to use Slack chat rooms to monitor and respond to operational events in their AWS Cloud. AWS Chatbot processes AWS service notifications from Amazon Simple Notification Service (Amazon SNS), and forwards them to Slack chat rooms so teams can analyze and act on them immediately, regardless of location.\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\n```python\nimport aws_cdk.aws_chatbot as chatbot\nimport aws_cdk.aws_sns as sns\nimport aws_cdk.aws_iam as iam\n\n\nslack_channel = chatbot.SlackChannelConfiguration(self, \"MySlackChannel\",\n slack_channel_configuration_name=\"YOUR_CHANNEL_NAME\",\n slack_workspace_id=\"YOUR_SLACK_WORKSPACE_ID\",\n slack_channel_id=\"YOUR_SLACK_CHANNEL_ID\"\n)\n\nslack_channel.add_to_role_policy(iam.PolicyStatement(\n effect=iam.Effect.ALLOW,\n actions=[\"s3:GetObject\"\n ],\n resources=[\"arn:aws:s3:::abc/xyz/123.txt\"]\n))\n\nslack_channel.add_notification_topic(sns.Topic(self, \"MyTopic\"))\n```\n\n## Log Group\n\nSlack channel configuration automatically create a log group with the name `/aws/chatbot/<configuration-name>` in `us-east-1` upon first execution with\nlog data set to never expire.\n\nThe `logRetention` property can be used to set a different expiration period. A log group will be created if not already exists.\nIf the log group already exists, it's expiration will be configured to the value specified in this construct (never expire, by default).\n\nBy default, CDK uses the AWS SDK retry options when interacting with the log group. The `logRetentionRetryOptions` property\nallows you to customize the maximum number of retries and base backoff duration.\n\n*Note* that, if `logRetention` is set, a [CloudFormation custom\nresource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html) is added\nto the stack that pre-creates the log group as part of the stack deployment, if it already doesn't exist, and sets the\ncorrect log retention period (never expire, by default).\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "The CDK Construct Library for AWS::Chatbot",
"version": "1.203.0",
"project_urls": {
"Homepage": "https://github.com/aws/aws-cdk",
"Source": "https://github.com/aws/aws-cdk.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "792dbd85be33f1ba09a4b928954c9a0962aa0dc45c64818a641e18ff320a0848",
"md5": "8d7baf6081fec9efa697386ec7502931",
"sha256": "2a3030789ee9413098523336ae1f62ac1b09af5f56a77274412af122a25edd65"
},
"downloads": -1,
"filename": "aws_cdk.aws_chatbot-1.203.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8d7baf6081fec9efa697386ec7502931",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.7",
"size": 66250,
"upload_time": "2023-05-31T22:53:17",
"upload_time_iso_8601": "2023-05-31T22:53:17.661836Z",
"url": "https://files.pythonhosted.org/packages/79/2d/bd85be33f1ba09a4b928954c9a0962aa0dc45c64818a641e18ff320a0848/aws_cdk.aws_chatbot-1.203.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "979e766146f6f817e6674dfe6bc75b0dd778df8b3ab9adfc349a34afb2b1ddf5",
"md5": "50cec63d9101ffc74cb203fc49c6716d",
"sha256": "b9c80764959663ca27e83e6d5749d46fb6b4c9b59124f397ca1ca7be7a05f2fe"
},
"downloads": -1,
"filename": "aws-cdk.aws-chatbot-1.203.0.tar.gz",
"has_sig": false,
"md5_digest": "50cec63d9101ffc74cb203fc49c6716d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 67261,
"upload_time": "2023-05-31T23:01:08",
"upload_time_iso_8601": "2023-05-31T23:01:08.296687Z",
"url": "https://files.pythonhosted.org/packages/97/9e/766146f6f817e6674dfe6bc75b0dd778df8b3ab9adfc349a34afb2b1ddf5/aws-cdk.aws-chatbot-1.203.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-31 23:01:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws",
"github_project": "aws-cdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aws-cdk.aws-chatbot"
}
JSON
