AWS Lambda を使って雨の日を通知する Twitter bot を作る

つくったもの

もしよければ使ってやってください
傘いるで bot（東京）@kasairu_tokyo
傘いるで bot（大阪）@kasairu_osaka

1. 毎朝午前 6 時にお天気情報を取得
2. 雨が降る場合はツイート（降らない日は無言）

今日、傘いるで

10/31 06:00:43
6 時 小雨
9 時 厚い雲
12 時 厚い雲
15 時 小雨
18 時 小雨
21 時 小雨

— 傘いるでbot（東京） (@kasairu_tokyo) October 30, 2021

ソースコード(Github)

きっかけ

最近、AWS のお勉強をしていて Lambda をちょっと使ってみたいと思い作りました。
何作ろうか考えましたが、ひとまず自分が使いそうでかつ簡単に作れそうな Twitter bot を作ることにしました。

構成図

それぞれの役割

• Lambda
  • 主役
  • イベント発生時にプログラムを起動
  • プログラム実行用のサーバーを用意しなくていいので楽
  • 今回はお天気情報を取得して、必要応じてツイートするプログラムが稼働
• EventBridge
  • トリガーを設定してイベントを起動
  • 今回は時間をトリガーにして Lambda を起動
• System Manager
  • パラメータストアの機能を仕様
  • 今回は Twitter API の API key などの外部に公開できない情報を保存
• Open Weather Map
  • お天気情報 API
  • 無料版では、1 カ月 500 回, 1 分間 10 回のリクエスト制限
  • 今回は 3 時間毎の天気を取得できる API を仕様
• Twitter
  • ツイッター

処理フロー

1. EventBridge が午前 6 時に Lambda を起動
2. System Manager から Open Weather Map と Twitter API の API key を取得
3. Open Weather Map からお天気情報を取得
4. 当日の天気が雨ならばツイート、雨以外ならツイートしない

作り方（備忘録）

細かい部分は端折ってますが。。

手順概要：

• AWS アカウント作成
• IAM の作成
• 各種インストール
• Open Weather Map の API key 取得
• Twitter API の API key 取得
• System Manager に API key を設定
• プログラム書く
• デプロイ
• テスト

環境

Windows10 (WSL2 Ubuntu 20.04)

AWS アカウント作成

AWS トップページからアカウント作成

アカウント作成後、しばらくはサービスが使用できない（支払情報の確認？？）

IAM の作成

1. IAM ダッシュボードのアクセス管理 -> ユーザーを選択
2. ユーザーを追加をクリック
3. ユーザー名等の設定
   
4. 権限の設定
   • 今回は「AdministratorAccess」を使用してますが、ちゃんと必要最小限の権限設定にしましょう..
     
5. タグなどは設定せず、ユーザー作成までクリック
6. ユーザーの完成
   • アクセスキーとシークレットアクセスキーは誰にも教えないようにしましょう（マジで）
     

各種インストール

AWS SAM CLI

参考ページ

# ファイルダウンロード
curl -OL https://github.com/aws/aws-sam-cli/releases/latest/download/aws-sam-cli-linux-x86_64.zip

# 展開
unzip aws-sam-cli-linux-x86_64.zip -d sam-installation

# インストール
sudo ./sam-installation/install

# 確認
sam --version

nodejs 14

どうやってインストールしたか忘れた...

素直に apt install nodejs だと v10.x.x がインストールされる（2021/10/28 時点）ので、何かしたんだけど何したか忘れた。

参考ページ（これかな？知らんけど）

Open Weather Map の API key 取得

1. Open Weather Map にアクセス
2. アカウント登録して再度 Open Weather Map にアクセスすると 「X-RapidAPI-Key」が発行されているはず。その下の「X-RapidAPI-HOST」も保管しておく。
   

Twitter API の API key 取得

API を使うために以下のキー情報を取得する

• consumer_key (API Key)
• consumer_secret (API Key Secret)
• access_token_key (Access Token)
• access_token_secret (Access Token Secret)

手順：

1. Twitter にログインした状態で Twitter Developers にアクセス
2. 「Create an app」をクリック
3. Hobbyist -> Making a bot を選択
   
4. 使用用途などの作文
5. Create Project をクリック
   
6. プロジェクト名などの設定
7. App permissions から権限を変更して書き込み権限を与える
   
8. 画像のボタンを押して各種キー情報を取得
   

System Manager に API key を設定

Lambda で必要な API key をパラメータストアに設定する。（どこに API key を置くのがいいのかよくわからなかったので、とりあえずパラメータストアに置いといた。）

設定する API は以下の 6 つ

名前	取得元
CONSUMER_KEY	Twitter
CONSUMER_SECRET	Twitter
ACCESS_TOKEN_KEY	Twitter
ACCESS_TOKEN_SECRET	Twitter
X_RAPIDAPI_HOST	Open Weather Map
X_RAPIDAPI_KEY	Open Weather Map

1. AWS Systems Manager -> パラメータストア にアクセス
2. パラメータの作成をクリック
3. パラメータ情報入力
   

最終的に以下のようになる。

プログラム書く

テンプレート作成

AWS SAM CLI を使用して任意のフォルダにテンプレートを作成する

1. sam init を打つ
2. テンプレートは AWS Quick Start Templates を選択
3. パッケージタイプは Zip を選択
4. runtime は nodejs14.x を選択
5. Project name は kasairude
6. クイックスタートテンプレートはスケジュールイベントを選択

こんな感じ ↓

$ sam init
Which template source would you like to use?
        1 - AWS Quick Start Templates
        2 - Custom Template Location
Choice: 1
What package type would you like to use?
        1 - Zip (artifact is a zip uploaded to S3)
        2 - Image (artifact is an image uploaded to an ECR image repository)
Package type: 1

Which runtime would you like to use?
        1 - nodejs14.x
        2 - python3.9
        3 - ruby2.7
        4 - go1.x
        5 - java11
        6 - dotnetcore3.1
        7 - nodejs12.x
        8 - nodejs10.x
        9 - python3.8
        10 - python3.7
        11 - python3.6
        12 - python2.7
        13 - ruby2.5
        14 - java8.al2
        15 - java8
        16 - dotnetcore2.1
Runtime: 1

Project name [sam-app]: kasairude

Cloning from https://github.com/aws/aws-sam-cli-app-templates

AWS quick start application templates:
        1 - Hello World Example
        2 - Step Functions Sample App (Stock Trader)
        3 - Quick Start: From Scratch
        4 - Quick Start: Scheduled Events
        5 - Quick Start: S3
        6 - Quick Start: SNS
        7 - Quick Start: SQS
        8 - Quick Start: Web Backend
Template selection: 4

    -----------------------
    Generating application:
    -----------------------
    Name: kasairude
    Runtime: nodejs14.x
    Architectures: x86_64
    Dependency Manager: npm
    Application Template: quick-start-cloudwatch-events
    Output Directory: .

    Next steps can be found in the README file at ./kasairude/README.md

コーディング

テンプレートから変更したファイルは以下のもの

• package.json
• src/handlers/scheduled-event-logger.js
• __tests__/unit/handlers/scheduled-event-logger.test.js
• template.yml
  • cron の設定はこれでする。設定時間は GMT になっていることに注意

動くか確認

# 先ほどの手順で設定したProject nameのフォルダができているはず
cd kasairude

# パッケージインストール（脆弱性の警告が出るがスルー）
npm install

# テストを実行
npm run test

テストがパスしたら OK

デプロイ

# ビルド
sam build

# デプロイ
sam deploy --guided

1. AWS Lambda 関数一覧 のページで確認
2. デフォルトの実行ロールだとパラメータストアにアクセスできないので、権限追加
   
3. ポリシーのアタッチをクリック
   
4. AmazonSSMReadOnlyAccess をアタッチ
   

テスト

1. テストタブクリック
2. テストボタンクリック（ペイロードは読んでないので適当で OK）
   
3. 実行結果が成功ならば OK
4. Cloud Watch でログを確認できる
   

あとは、template.yml で設定した時間にちゃんと実行されるか見守る。。

費用

無料でできているはず（間違っていたらすみません。。）

使用したサービス	無料枠
Open Weather Map	500 リクエスト / 月
Twitter	500K ツイート / 月
AWS Lambda	1M リクエスト / 月
AWS System Manager（標準バラメータ）	無料

他にも、デプロイの過程で S3 などのサービスを使用していますが、死ぬほどデプロイしない限りは無料枠に収まるはず。
また、Cloudwatch に関しても 7 日程度でログを自動で削除するようにしておけば無料枠の範囲に収まるはず。

この程度の bot 作成は無料でできる世の中でよかった。

2 週間程度放置した際の AWS の請求

作ってから思ったこと

Lambda 素人が Lambda 使ってみたの印象

• サーバーの環境構築いらないのが嬉しい
• 開発環境の整備とかのノウハウで良さそうなのがいまいち見つからない
• API key などのシークレットな情報はどのように持つがよいのか悩んだ
  • 環境変数で持つ
  • パラメータストアで持つ
• 次は DynamoDB とかと連携する API 作ってみたい（ネタがない）