# SlackChannelConfiguration

A new Slack channel configuration.

Extends: Construct › Resource › SlackChannelConfiguration
Implements: IResource, ISlackChannelConfiguration, INotificationRuleTarget, IGrantable, IEnvironmentAware, ISlackChannelConfigurationRef, IConstruct, IDependable

- CloudFormation: [`AWS::Chatbot::SlackChannelConfiguration`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-chatbot-slackchannelconfiguration.html)
- L1 type: [`CfnSlackChannelConfiguration`](/cdk/api/v2/docs/aws-cdk-lib.aws_chatbot.CfnSlackChannelConfiguration.html)
- Source: [`aws-chatbot/lib/slack-channel-configuration.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-chatbot/lib/slack-channel-configuration.ts#L219)
- Type last changed: v2.236.0 · 23 Jan 2026

## Example

```ts
import * as chatbot from 'aws-cdk-lib/aws-chatbot';

declare const project: codebuild.Project;

const target = new chatbot.SlackChannelConfiguration(this, 'MySlackChannel', {
  slackChannelConfigurationName: 'YOUR_CHANNEL_NAME',
  slackWorkspaceId: 'YOUR_SLACK_WORKSPACE_ID',
  slackChannelId: 'YOUR_SLACK_CHANNEL_ID',
});

const rule = project.notifyOnBuildSucceeded('NotifyOnBuildSucceeded', target);
```

## Initializer

```ts
new SlackChannelConfiguration(scope: Construct, id: string, props: SlackChannelConfigurationProps)
```

## Construct Props

- `guardrailPolicies`: [IManagedPolicy](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IManagedPolicy.html)[] — 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.

- `loggingLevel`: [LoggingLevel](/cdk/api/v2/docs/aws-cdk-lib.aws_chatbot.LoggingLevel.html) = LoggingLevel.NONE — Specifies the logging level for this configuration.

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

- `logRetention`: [RetentionDays](/cdk/api/v2/docs/aws-cdk-lib.aws_logs.RetentionDays.html) = logs.RetentionDays.INFINITE — 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`.

- `logRetentionRetryOptions`: [LogRetentionRetryOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogRetentionRetryOptions.html) — When log retention is specified, a custom resource attempts to create the CloudWatch log group.

  **Default:** Default AWS SDK retry options.

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

- `logRetentionRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — The IAM role for the Lambda function associated with the custom resource that sets the retention policy.

  **Default:** A new role is created.

- `notificationTopics`: [ITopic](/cdk/api/v2/docs/aws-cdk-lib.aws_sns.ITopic.html)[] = None — The SNS topics that deliver notifications to AWS Chatbot.

- `role`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — The permission role of Slack channel configuration.

  **Default:** A role will be created.

- `slackChannelConfigurationName`: string (required) — The name of Slack channel configuration.

- `slackChannelId`: string (required) — 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.

- `slackWorkspaceId`: string (required) — 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.

- `userRoleRequired`: boolean = false — Enables use of a user role requirement in your chat configuration.

## Properties

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `grantPrincipal`: [IPrincipal](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IPrincipal.html) — The principal to grant permissions to.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `role`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — The permission role of Slack channel configuration.

- `slackChannelConfigurationArn`: string — The ARN of the Slack channel configuration In the form of arn:aws:chatbot:{region}:{account}:chat-configuration/slack-channel/{slackChannelName}.

- `slackChannelConfigurationName`: string — The name of Slack channel configuration.

- `slackChannelConfigurationRef`: [SlackChannelConfigurationReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_chatbot.SlackChannelConfigurationReference.html) — A reference to a SlackChannelConfiguration resource.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

## Methods

- `addNotificationTopic(notificationTopic: ITopic): void` — Adds a SNS topic that deliver notifications to AWS Chatbot.

- `addToRolePolicy(statement: PolicyStatement): void` — Adds extra permission to iam-role of Slack channel configuration.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `bindAsNotificationRuleTarget(_scope: Construct): NotificationRuleTargetConfig` — Returns a target configuration for notification rule.

- `fromSlackChannelConfigurationArn(scope: Construct, id: string, slackChannelConfigurationArn: string): ISlackChannelConfiguration` (static) — Import an existing Slack channel configuration provided an ARN.

  **Parameters**

  - `scope` — The parent creating construct.
  - `id` — The construct's name.
  - `slackChannelConfigurationArn` — configuration ARN (i.e. arn:aws:chatbot::123456789012:chat-configuration/slack-channel/my-slack).

  **Returns:** a reference to the existing Slack channel configuration

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `metric(metricName: string, props?: MetricOptions): Metric` — Return the given named metric for this SlackChannelConfiguration.

- `metricAll(metricName: string, props?: MetricOptions): Metric` (static) — Return the given named metric for All SlackChannelConfigurations.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.