aws-chatbot: ISlackChannelConfiguration should include addNotificationTopic() method

[polastre]

Describe the feature

#15588 and #16643 added the method addNotificationTopic() to the SlackChannelConfiguration construct. This allows the SNS topic to be added to an existing configuration.

For an existing slack channel, it can be imported with SlackChannelConfiguration. fromSlackChannelConfigurationArn. This returns SlackChannelConfiguration.

If you create a new SlackChannelConfiguration construct, then you can use addNotificationTopic since it returns that construct object. If you use fromSlackChannelConfigurationArn, then you get ISlackChannelConfiguration which does not have addNotificationTopic.

The request to is add addNotificationTopic to ISlackChannelConfiguration so that it can used with existing slack channel configurations.

Use Case

A stack where the slack channel configuration is already defined, and the stack seeks to add notification topics to that existing slack channel configuration.

Proposed Solution

Add addNotificationTopic to the interface in https://github.com/xykkong/aws-cdk/blob/master/packages/@aws-cdk/aws-chatbot/lib/slack-channel-configuration.ts#L109

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

CDK version used

2.32.0

Environment details (OS name and version, etc.)

typescript

[kaizencc]

This sounds reasonable @polastre! Are you interested in contributing this?

[daschaa]

@kaizencc I tried working on this but I'm not sure how to properly test this. Do you have an idea/hint how to do it?

[debnon]

I implemented this change, but when unit testing realized that adding an SNS topic to a Slack Config retrieved by ARN from another stack doesn't actually seem to add it to the existing Slack Config.

Does it go against best practices to modify one stack from another like this, and if not, is there an established way to trigger the changes to Cloudformation after calling the method to add SNS topics? Thanks.

[sercantor]

I also had the same thing @debnon, when I added the method and tried to use it, it created the sns topics, but they weren't in slack channel topics. can anyone show an example similar to this so we can just add it?

[zentavr]

Is there any workaround to use shared stack which creates slack notifications and attach the new SNS topics inside?

[ben-buitendijk]

@larskinder
That is Python, right? I'm using Typescript and it seems like the construct doesn't have that method...

Also it doesn't show in the documentation:
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_chatbot.ISlackChannelConfiguration.html

[larskinder]

Sry, re-added my previous post, that you were referencing to.

This is how you can add SNS topics to an existing Slack config.

slack_bot = chatbot.SlackChannelConfiguration(
    chatbot.SlackChannelConfiguration.from_slack_channel_configuration_arn(
        self,
        "SlackNotifications",
        slack_channel_configuration_arn=(
            f"arn:aws:chatbot::{account}:chat-configuration/slack-channel/test-channel-config"
        ),
    )
)

slack_bot.add_notification_topic(sns_topic)
slack_bot.add_notification_topic(another_sns_topic)

[larskinder]

@ben-buitendijk what version of cdk are you using?
In general, this method (fromSlackChannelConfigurationArn(scope, id, slackChannelConfigurationArn)) is available.

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_chatbot.SlackChannelConfiguration.html#static-fromwbrslackwbrchannelwbrconfigurationwbrarnscope-id-slackchannelconfigurationarn

[ben-buitendijk]

That is the page when you create a new SlackChannelConfiguration, but the construct when you import it from an ARN doesn't have that method

[ollesumonto]

Need this for the interface.

[sercantor]

no response? this shouldn't be that hard I feel like 😁

[github-actions]

This issue has received a significant amount of attention so we are automatically upgrading its priority. A member of the community will see the re-prioritization and provide an update on the issue.

[mayconfrr]

Bump

[luiscastillocr]

I think this is already implemented by now

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_chatbot.SlackChannelConfiguration.html#addwbrnotificationwbrtopicnotificationtopic

but now i am wondering if there is a way to obtain the SlackChannelConfiguration topics? so somehow get the list of subscribed topics for a given SlackChannelConfiguration using CDK or CLI!

EDIT: typo

[sercantor]

@luiscastillocr I don't think it's been added, look at the last commits. https://github.com/aws/aws-cdk/commits/26dcc1e11a07d93681145049aa06d80a7d2114b9/packages/aws-cdk-lib/aws-chatbot/lib/slack-channel-configuration.ts

not sure even if it's possible, the resource is created, we'd be wanting to manipulate the resource we created in one stack in another stack.

an alternative to this would be to do Alarms -> SNS -> Lambda (provide your webhook url & stuff, write your custom message) -> Slack

[luiscastillocr]

hey @sercantor you are right, i was looking at the SlackChannelConfiguration construct when you actually were talking about the ISlackChannelConfiguration contructor, my apologies, in my case as a workaround i decided to create my own SlackConfiguration from CDK along with a custom Topic so I can have the ARN to send custom notifications from codebuild using the aws CLI

const events = [
            // actions
            'codepipeline-pipeline-action-execution-failed',
            'codepipeline-pipeline-action-execution-canceled',

            // stages
            'codepipeline-pipeline-stage-execution-resumed',
            'codepipeline-pipeline-stage-execution-canceled',
            'codepipeline-pipeline-stage-execution-failed',

            // pipeline
            'codepipeline-pipeline-pipeline-execution-failed',
            'codepipeline-pipeline-pipeline-execution-canceled',
            'codepipeline-pipeline-pipeline-execution-started',
            'codepipeline-pipeline-pipeline-execution-resumed',
            'codepipeline-pipeline-pipeline-execution-succeeded'
        ];

const slackChannelConfigurationTopic = new sns.Topic(this, slackChannelTopicName);

const slackChannelConfiguration = new chatbot.SlackChannelConfiguration(this, slackChannelConfigurationName, {
            slackChannelConfigurationName: slackChannelConfigurationName,
            slackWorkspaceId: slackChatbotWorkspaceId,
            slackChannelId: slackChannelId,
            notificationTopics: [snsTopic]
        });

const notificationRule = new code_star_notifications.NotificationRule(this,
            codestarNotificationRuleName,
            {
                events: events,
                source: pipeline.pipeline,
                targets: [slackChannelConfiguration]
            }
        );

notificationRule.node.addDependency(pipeline);

then i can do something like this in a CodeBuildStep command

aws sns publish --topic-arn "${SLACK_TOPIC_ARN}" --message file://cdk/lib/slack-msg.json

😉

[luiscastillocr]

well looks like I am going to need this method after all, happen that there are co-workers that have their slack channel pre-configured in their sanboxes so if someone have it pointing to the same slack channel ID, the SlackChannelConfiguration will throw an error saying the channel is already configured.

Sry, re-added my previous post, that you were referencing to.

This is how you can add SNS topics to an existing Slack config.

slack_bot = chatbot.SlackChannelConfiguration(
    chatbot.SlackChannelConfiguration.from_slack_channel_configuration_arn(
        self,
        "SlackNotifications",
        slack_channel_configuration_arn=(
            f"arn:aws:chatbot::{account}:chat-configuration/slack-channel/test-channel-config"
        ),
    )
)

slack_bot.add_notification_topic(sns_topic)
slack_bot.add_notification_topic(another_sns_topic)

@larskinder I don't think this is possible in NodeJS since you have to mandatory pass the SlackChannelConfigurationProps along with a name, so i think i am back to the waiting room for this feature!

[larskinder]

Hey, sorry for not getting back to you sooner. About your last question, I only tried it back in the day with Python, sadly never with TS. :(
I believe other ppl in this channel, when they write that it is not possible in TS. Out of curiosity and because I have to work with TS soon again, I might still take another look at it. ^^

[vaughan-rich]

+1

[YotillaAntoni]

Same issue here.

[GavinZZ]

After team discussion, we are not able to support this feature.

fromSlackChannelConfigurationArn will import an existing slack channel configuration that was created using any means (i.e. from another stack, or manual creation, or etc.). If we now add addNotificationTopic method, it is essentially trying to modify this resource.

If this resource is created/managed using CloudFormation, this will cause CloudFormation stack drift, which should be avoided. If this resource is not managed by CloudFormation, it's impossible to modify the property.

In CDK, resources referenced via fromAbc method are read-only. The interfaces can only have methods that are read-only or that are creating a different resource.

[YotillaAntoni]

I guess as a workaround one could instead import a topic connected to the slack channel configuration with Topic.fromArn into CDK

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

[tallpaul-embark]

I understand not wanting to support the addNotificationTopic in some ways, but if that is the case I feel like we should not be locking down the new slack channel configuration to a channel only being allowed to be used once.