AWS
RDS
lambda

2018年版:lambdaでRDSを自動起動・停止

きっかけ

久しぶりにlambdaを触ろうと思ったら記憶はないし昔と大分違っているので改めて記事にまとめます

やりたいこと

ある時刻になったらRDSを自動起動・停止したいです。

lambdaとは

https://aws.amazon.com/jp/lambda/

サーバーレスでコードを実行できるサービス。
サーバーがいらないのでサーバーを立てるよりやすい!
色々制約がありますが、今回は1日1回自動でRDSを停止させるだけなので、特に気にしません。
ちょくちょくアップデートされているようで、2018年にまた色々と変わったようです。そのためタイトルに「2018年版」とつけました。

lambda実行に必要な操作

lambdaを実行できる状態にするには以下の操作が必要です。

  • ロールの作成
  • lambdaの実装
  • デプロイ

今回は上記の操作を経てlambdaを実行できる状態を作り、cloudwatchで定期的にlambdaを実行します。

ロールの作成

lambdaを実行する為のロールを作成する必要があります。

ロールについての簡単な説明

https://docs.aws.amazon.com/ja_jp/IAM/latest/UserGuide/id_roles_terms-and-concepts.html
ロールやポリシーに関する説明はドキュメントを参照してください。

ここではlambdaに必要なロールについて説明します。

lambda実行時に他のリソースを操作する場合、lambda関数に他のリソースのアクセス権をつけてあげる必要があります。
必要なアクセス権をロールとして定義し、lambda実行時にロールを指定してあげることで他のリソースを操作可能にします。

今回の場合lambdaにはRDSを起動・停止してもらいたいので、RDS起動・停止を許可するロールを作成し、付与します。

ロール作成手順

  1. IAMのコンソールからポリシーを作成する画面を開く
    iam_policy.png

  2. JSONタブを開き、以下のJSONをコピペする
    json.png

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "rds:StopDBInstance",
                "rds:StartDBInstance"
            ],
            "Resource": "arn:aws:rds:*:*:db:*"
        }
    ]
}

3.「Review Policy」をクリック。適当な名前を指定し、「Create Policy」をクリック。

lambda関数の実装

boto3を使用する

AWSのリソースを操作する為にpython3のboto3というライブラリを使用します。

そのため、lambdaの実装はpython3で行います。

使い方はドキュメントにあるとおり、とても簡単です。
以下の実装をローカルで動かせばDBを停止させることができます。(あらかじめboto3のインストールが必要です)

import boto3

dbinstance = 'testdb'

# 使用したいサービスを指定する
client = boto3.client('rds')
# 行いたい操作を実行
response = client.stop_db_instance(DBInstanceIdentifier=dbinstance)
print(response)

lambdaの実装ルール

lambda実装時にはハンドラーを実装する必要があります。

lambda実行時にこのハンドラー関数が呼び出されます。

ハンドラーは以下の形で記載します。

def handler_name(event, context): 
    ...
    return some_value

eventやcontextとありますが、今回はlambdaにパラメータを渡す必要がないので省略します。詳しくはドキュメントを参照してください。

先ほどboto3を用いた実装をこのハンドラーで指定すると以下の実装になります。

import boto3


def lambda_handler(event, context):
    dbinstance = 'testdb'
    client = boto3.client('rds')
    response = client.stop_db_instance(DBInstanceIdentifier=dbinstance)
    print(response)
    return 0

まあ簡単!

lambda関数をデプロイする

いくつかデプロイ方法がありますが、今回はすぐ動かしたいのでコードのコピペをします。

  1. lambdaのダッシュボードから「関数の作成」をクリックする
    スクリーンショット 2018-10-11 23.32.28.png

  2. 「一から作成」を選択し、以下の値を選択する
    ランタイム:Python3.6
    ロール:既存のロールを選択
    既存のロール:ロールの作成ステップで作成したロール
    スクリーンショット 2018-10-11 23.32.51.png

  3. 「関数の作成」をクリックする

  4. lambda関数の実装ステップの実装を「関数コード」にコピペする

スクリーンショット 2018-10-11 23.40.15.png
5. 右上の「保存」をクリックして完成!

Cloudwatchで定期実行

CloudWatchとは

AWSのリソースをモニタリングできるサービスです。
請求額を超えそうになったら通知したり、リソースを監視して何かあったら通知したりできます。
今回はこのCloudWatchのイベントを利用して定期的にlambdaを実行したいと思います。

イベントを登録する

  1. CloudWatchのイベント画面を開きます
    cloudwatch.png

  2. 「ルールの作成」をクリックする
    rule.png

  3. 「スケジュール」、「Cron式」を選択し、ドキュメントに基づき設定したい条件を書く
    schedule.png

※式を入力する際の注意事項
checkpoint.png
・上のキャプチャを見ていただければわかりますが、GMTで指定してください
・cron 式の日フィールドと曜日フィールドを同時に指定することはできません。一方のフィールドに値 (または *) を指定する場合、もう一方のフィールドで ? (疑問符) を使用する必要があります。

linuxのcron設定の感覚でやると「パラメータ間違ってるよ!!!」と出てきてしまうので注意してください。

5.「ターゲットの追加」をクリックし、先ほど作成したtestdbを選択する

6.「設定の詳細」をクリックし、適当な名前を付けて「ルールの作成」

あとは時間まで待つ・・・

rds.png

testdbが停止中になっています。
無事lambdaが動きましたね!