AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

SlackChannelConfiguration

A new Slack channel configuration.

Import

import { SlackChannelConfiguration } from 'aws-cdk-lib/aws-chatbot';

Or use the module namespace:

import * as chatbot from 'aws-cdk-lib/aws-chatbot';
// chatbot.SlackChannelConfiguration

Properties

Configuration passed to the constructor as SlackChannelConfigurationProps.

slackChannelConfigurationNameRequired
string

The name of Slack channel configuration.

slackChannelIdRequired
string

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.

slackWorkspaceIdRequired
string

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.

guardrailPoliciesOptional
IManagedPolicy[]

A list of IAM managed policies that are applied as channel guardrails.

Default: - The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.

loggingLevelOptional
LoggingLevel

Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.

Default: LoggingLevel.NONE

logRetentionOptional
RetentionDays

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

logRetentionRetryOptionsOptional
LogRetentionRetryOptions

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.

logRetentionRoleOptional
IRole

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

Default: - A new role is created.

notificationTopicsOptional
ITopic[]

The SNS topics that deliver notifications to AWS Chatbot.

Default: None

roleOptional
IRole

The permission role of Slack channel configuration.

Default: - A role will be created.

userRoleRequiredOptional
boolean

Enables use of a user role requirement in your chat configuration.

Default: false

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter