EC2 のメンテナンスイベント通知メールにタグを含める方法

記事タイトルとURLをコピーする

CI部 佐竹です。
本日は EC2 インスタンスのメンテナンス(イベント)通知に関するちょっとしたオプションについて記載します。

はじめに

先日以下の記事でご説明した通り、EC2 インスタンスにはメンテナンスが行われることがあります。

blog.serverworks.co.jp

またメンテナンスが予定された時は、EC2 のコンソールにある「Events」に記載されることをご紹介しました。加えてこのメンテナンスイベントの通知はメールでも送付されます。

今回はその「Events」から設定可能なちょっとした便利機能の紹介です。

イベント通知を管理

EC2 のコンソールのメニューの1つである「Events」を開くと、画面右上に「アクション」ボタンが存在します。このメニューの最下部に「イベント通知を管理 (Manage event notifications) 」という機能が存在します。一体この機能はどのようなものでしょうか?

f:id:swx-satake:20210708172031p:plain

結論を記載すると、この機能は『 EC2 インスタンスのメンテナンス(イベント)通知がスケジュールされた時に「送付されるメール」への機能強化』を提供するものです。具体的には、通知メール本文にその EC2 インスタンスに付与されているタグを併記してくれるようになります。

実際に設定してみます。

「イベント通知を管理」を押下して進むと以下の画面が表示されます。

f:id:swx-satake:20210708172100p:plain

「イベント通知にタグを含める」のボタンを有効化すると、以下の通り2つの選択肢が表示されます。

f:id:swx-satake:20210708172259p:plain

  • すべてのタグを含める (Include all tags):影響を受けるリソースに関連付けられているすべてのタグをイベント通知に含めるには、このオプションを選択します。
  • 含めるタグを選択します (Choose the tags to include):影響を受けるリソースに関連付けられた特定のタグをイベント通知に含めるには、このオプションを選択します。

2つの選択肢が表示されました。

全てのタグを含めたいのか、必要なものだけを選びたいのかという選択が可能となっています。例えば CloudFormation で付与されたタグがあると通知時に少々見にくくなる可能性があるため、そのようなタグを選択除外できるようになっています。

最後に「保存」を押下して設定は終了です。

設定後のメンテナンス通知メールを確認する

以下は、「イベント通知にタグを含める」機能を設定する前に届いていたメールです。

Hello,

One or more of your Amazon EC2 instances associated with your AWS account (AWS Account ID: 123412341234) are scheduled for maintenance between 2021-07-22 00:00:00 UTC and 2021-07-22 02:00:00 UTC. During this time, the following instances in the ap-northeast-1 region will be unavailable and rebooted.

The affected instances are listed below:
i-12341234

これが以下の通り変化しました。

Hello,

One or more of your Amazon EC2 instances associated with your AWS account (AWS Account ID: 123412341234) are scheduled for maintenance between 2021-07-22 18:00:00 UTC and 2021-07-22 20:00:00 UTC. During this time, the following instances in the ap-northeast-1 region will be unavailable and rebooted. The tags associated with these instances are included below.

The affected instances are listed below:
i-12341234
Target:Production
Name:i-12341234
Company:STK
System:STK
CostCenter:1234

The tags associated with these instances are included below. という文言が添えられ、メール本文には Instance-id の直後にタグが併記されるようになりました。

このようにメール本文にタグが付与されていれば、タグによってどのシステムが影響を受けるのかすぐに判断できます。つまり、マネジメントコンソールにログインしてタグを確認する手間が省けます。個人的にはこの設定は EC2 インスタンスを利用する全てのユーザで有効にすべきなのではと思ってしまうくらいの良い機能だと感じます。

注意点

全てのタグを含めた場合、メール本文にタグの Value が全て記載されてしまいます。バッドプラクティスなのですが、タグに OS のログインパスワードなどを記載しているような場合は、それも含めてメールで通知される可能性があることに注意してください。記載されたくないタグがある場合は、「含めるタグを選択します」を利用し、必要なタグのみを選択してください。

また、以下でご紹介しました Event Bridge と Chatbot を活用したメンテナンスイベントの Slack 通知にはこの設定は反映されません。

blog.serverworks.co.jp

公式ドキュメント

本設定について以下のドキュメントに記載があります。「スケジュールされたイベント通知のカスタマイズ」の項目をご確認ください。

docs.aws.amazon.com

まとめ

本日は EC2 インスタンスのメンテナンス(イベント)通知に関するちょっとしたオプション「イベント通知メールにタグを含める」について記載しました。

先にも記載した通り、タグが付与されることで調査の手間が削減されます。是非とも EC2 インスタンスを運用されている方は有効化してみてください。

また、将来的には AWS Chatbot におけるメンテナンス(イベント)通知にも、同様にタグが付与されれば嬉しいなと思うところです。

ではまたお会いしましょう。

佐竹 陽一 (Yoichi Satake) エンジニアブログの記事一覧はコチラ

営業部カスタマーサクセス課所属。AWS資格12冠。2010年1月からAWSを利用してきました。2021 Japan APN Ambassador /2020-2021 APN ALL AWS Certifications Engineer。AWSのコスト削減、最適化を得意としています。