EventBridgeからmarkdown形式でChatbot通知するCDKスタック
CloudWatch EventsからEventBridgeに名前が変わったのは2019年（さっき調べました）。
イベント駆動のサービスとしてサポートするソース・ターゲットが増えているので、復習ついでに触りました。
今回作ったもの
左側に表示されているスタックが今回作った部分です。（右側は機会があれば別途...）
Powered by https://pypi.org/project/aws-pdk/
任意のイベントをEventBridgeでトリガーする
よくあるユースケースですが、AWSのイベント通知すぐにでも設定できます。
ただ、通知メッセージをmarkdown形式にして見やすくすることを重視して、それをCDKで実装し直してみました。
ちょっとした見やすくする作業は大抵後回しにしがちですが、その分、実用性は高まるのでCDK実装で使い回しが効く形を作っておくと先々で役立ってくれそうです。
今回の場合、RuleTargetInputを使うことになり、markdown形式ではstatic fromObject(obj)が必要になっています。
そのインターフェイスがドキュメント不足で迷いましたが・・出来たものはこちら。（抜粋）
from_objectの中身は、上記ページあたりが何とか参考になりました。
# event rule at Console Login
login_event = events.Rule(
self, "ConsoleLoginEventRule",
enabled=True,
rule_name="ConsoleLogin_ChatbotNotify",
description="Console Login",
event_pattern={
"source": ["aws.signin"],
"detail": {
"eventSource": ["signin.amazonaws.com"],
"eventName": ["ConsoleLogin"],
},
}
)
login_event.add_target(events_targets.SnsTopic(
chatbot_topic,
# custom markdown
message=events.RuleTargetInput.from_object({
"version": "1.0",
"source": "custom",
"content": {
"text_type": "client-markdown",
"title": f"{events.EventField.from_path('$.detail.eventType')}, {account_id} at {events.EventField.from_path('$.detail.awsRegion')}",
"description": f"""
*EventTime:* {events.EventField.from_path('$.detail.eventTime')}
*EventName:* {events.EventField.from_path('$.detail.eventName')}
*UserArn:* {events.EventField.from_path('$.detail.userIdentity.arn')}
*SourceIP:* {events.EventField.from_path('$.detail.sourceIPAddress')}""",
}
})
))
コードでは省略していますがdescriptionに@hereを含めたら、メンション扱いになるので便利です。
Slack通知例
終わりに
以前から「inputTransformerのパターンをサポートしたL2コンストラクが欲しい」というissueはあるものの、ドキュメントで補足する程度で決着しそうでした。
2024/12現在、EventBridge targetsに記載されたAWSサービスは30個ですが、AWS services that send events to EventBridgeは数える気が起きないくらい膨大になっています。。
AWSパートナーのSaaSからもイベント受信したり(*1)、Pipes機能でターゲットへのイベント送信時にデータ補完したり、Scheduler機能でAWS APIを直接実行したり(*2)、、ユースケースは大量に用意されているので、それらを効果的に使う実装を考える必要性は高くなったと再認識しました。
(*1)
(*2)
Discussion