SlackChannelConfigurationProps

class aws_cdk.aws_chatbot.SlackChannelConfigurationProps(*, slack_channel_configuration_name, slack_channel_id, slack_workspace_id, logging_level=None, log_retention=None, log_retention_retry_options=None, log_retention_role=None, notification_topics=None, role=None)

Bases: object

(experimental) Properties for a new Slack channel configuration.

Parameters
  • slack_channel_configuration_name (str) – (experimental) The name of Slack channel configuration.

  • slack_channel_id (str) – (experimental) The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.

  • slack_workspace_id (str) – (experimental) The ID of the Slack workspace authorized with AWS Chatbot. To get the workspace ID, you must perform the initial authorization flow with Slack in the AWS Chatbot console. Then you can copy and paste the workspace ID from the console. For more details, see steps 1-4 in Setting Up AWS Chatbot with Slack in the AWS Chatbot User Guide.

  • logging_level (Optional[LoggingLevel]) – (experimental) Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs. Default: LoggingLevel.NONE

  • log_retention (Optional[RetentionDays]) – (experimental) The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn’t remove the log retention policy. To remove the retention policy, set the value to INFINITE. Default: logs.RetentionDays.INFINITE

  • log_retention_retry_options (Optional[LogRetentionRetryOptions]) – (experimental) When log retention is specified, a custom resource attempts to create the CloudWatch log group. These options control the retry policy when interacting with CloudWatch APIs. Default: - Default AWS SDK retry options.

  • log_retention_role (Optional[IRole]) – (experimental) The IAM role for the Lambda function associated with the custom resource that sets the retention policy. Default: - A new role is created.

  • notification_topics (Optional[List[ITopic]]) – (experimental) The SNS topics that deliver notifications to AWS Chatbot. Default: None

  • role (Optional[IRole]) – (experimental) The permission role of Slack channel configuration. Default: - A role will be created.

Stability

experimental

Attributes

log_retention

(experimental) The number of days log events are kept in CloudWatch Logs.

When updating this property, unsetting it doesn’t remove the log retention policy. To remove the retention policy, set the value to INFINITE.

Default

logs.RetentionDays.INFINITE

Stability

experimental

Return type

Optional[RetentionDays]

log_retention_retry_options

(experimental) When log retention is specified, a custom resource attempts to create the CloudWatch log group.

These options control the retry policy when interacting with CloudWatch APIs.

Default
  • Default AWS SDK retry options.

Stability

experimental

Return type

Optional[LogRetentionRetryOptions]

log_retention_role

(experimental) The IAM role for the Lambda function associated with the custom resource that sets the retention policy.

Default
  • A new role is created.

Stability

experimental

Return type

Optional[IRole]

logging_level

(experimental) Specifies the logging level for this configuration.

This property affects the log entries pushed to Amazon CloudWatch Logs.

Default

LoggingLevel.NONE

Stability

experimental

Return type

Optional[LoggingLevel]

notification_topics

(experimental) The SNS topics that deliver notifications to AWS Chatbot.

Default

None

Stability

experimental

Return type

Optional[List[ITopic]]

role

(experimental) The permission role of Slack channel configuration.

Default
  • A role will be created.

Stability

experimental

Return type

Optional[IRole]

slack_channel_configuration_name

(experimental) The name of Slack channel configuration.

Stability

experimental

Return type

str

slack_channel_id

(experimental) The ID of the Slack channel.

To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.

Stability

experimental

Return type

str

slack_workspace_id

(experimental) The ID of the Slack workspace authorized with AWS Chatbot.

To get the workspace ID, you must perform the initial authorization flow with Slack in the AWS Chatbot console. Then you can copy and paste the workspace ID from the console. For more details, see steps 1-4 in Setting Up AWS Chatbot with Slack in the AWS Chatbot User Guide.

See

https://docs.aws.amazon.com/chatbot/latest/adminguide/setting-up.html#Setup_intro

Stability

experimental

Return type

str