RDS: DBインスタンスを停止

概要

「RDS: DBインスタンスを停止」アクションでは、起動しているAmazon RDS DB インスタンス(以下DB インスタンス)を停止することが出来ます。
他のアクションと同様に、リソース IDまたは DB インスタンスに付与されているタグで停止する DB インスタンスを指定することができます。

設定時のオプション

No. オプション 説明
1 リージョン 停止したい DB インスタンスが存在する AWS リージョンを一覧から選択します
2 DBインスタンス 停止したい DB インスタンスを一覧から選択します。
一覧に「Can’t find any rds instances in this region or aws account」と表示される場合には、AWSアカウントやリージョンの選択が正しいかどうかご確認ください
特定のタグが付いたDBインスタンス
  • 停止したい DB インスタンスを key と value を入力してタグを使って指定します。指定されたリージョン内で、入力された key と value に一致するタグが付いているすべての DB インスタンスが対象となります。
  • 指定されたリージョン内で、入力された key と value に一致するタグがついたすべての DB インスタンスが対象となります。
3 ジョブ実行後のリソースの状態までチェックする
  • ジョブ実行後のリソースの状態までチェックする場合
    • DescribeDBInstance API リクエストが成功且つ、 起動した DB インスタンスの状態が stopped になった場合、ジョブが成功したと判断されます
    • DescribeDBInstance API リクエストが成功且つ、 起動した DB インスタンスの状態が stopped 以外になった場合、ジョブが失敗したと判断されます

    ※DescribeDBInstance API を利用して約5分間隔で DB インスタンスの状態を確認します

  • ジョブ実行後のリソースの状態までチェックしない場合
    • StopDBInstance API リクエストの正否がジョブの実行結果正否となります

設定例

「RDS: DBインスタンスを停止」アクションを使ったジョブを作成してみます。

  1. Cloud Automator の運用ジョブ画面から「ジョブの追加」ボタンをクリックします
  2. ジョブを所属させるグループを選択します
  3. トリガーの選択で、任意のトリガーを選択下さい
  4. アクションの選択で「RDS: DBインスタンスを停止」アクションを選択します
  5. AWS アカウントの選択で、任意の AWS アカウントを選択します
  6. アクションのパラメーターを設定します

    No. オプション 設定値の例
    1 リージョン アジアパシフィック (東京)
    2 DBインスタンス 任意の DB インスタンス
    3 ジョブ実行後のリソースの状態までチェックする チェック
    stop-rds-instance-20230905.png
  7. 成功時、失敗時の後処理を設定します
  8. ジョブ名を入力し、「作成する」をクリックします

動作確認

  1. 作成したジョブのログボタンをクリックします
  2. 実行ログ一覧から該当の実行ログの詳細をクリックします
  3. ログの詳細にて結果を確認します
    「成功」となっていれば該当のジョブが実行されて成功していることが確認できます。
    「実行中」となっている場合はジョブの実行中なのでしばらく経ってから確認してください。
  4. それぞれのリソースの操作結果は「リソース操作結果」の項目で確認できます

以上で「RDS: DBインスタンスを停止」アクションを使ったジョブの動作確認が出来ました。

ログのステータス条件

No. ステータス 説明
1 成功 ジョブ実行後のリソースの状態までチェックする場合、StopDBInstance API の実行が完了し、DB インスタンスが停止状態になるのを確認できた場合に成功となります。
ジョブ実行後のリソースの状態までチェックしない場合、StopDBInstance API の実行が完了した場合に成功となります。
2 失敗 ジョブ実行後のリソースの状態までチェックする場合、以下の場合に失敗となります。
  • ジョブで指定された DB インスタンスが存在しない場合
  • 1回のジョブ実行で操作出来るリソースの上限をオーバーしたとき(詳しくはこちらのページをご確認下さい)
  • StopDBInstance API の実行に失敗した場合
  • 対象の DB インスタンスが利用可能以外の状態になった場合
ジョブ実行後のリソースの状態までチェックしない場合、以下の場合に失敗となります。
  • ジョブで指定された DB インスタンスが存在しない場合
  • 1回のジョブ実行で操作出来るリソースの上限をオーバーしたとき(詳しくはこちらのページをご確認下さい)
  • StopDBInstance API の実行に失敗した場合

リソース操作履歴のステータス条件

No. ステータス 説明
1 Completed ジョブ実行後のリソースの状態までチェックする場合、StopDBInstance API の実行が完了し、DB インスタンスが停止状態になるのを確認できた場合に Completed となります。
ジョブ実行後のリソースの状態までチェックしない場合、StopDBInstance API の実行が完了した場合に Completed となります。
2 Failed ジョブ実行後のリソースの状態までチェックする場合、以下の場合に Failed となります。
  • StopDBInstance API の実行に失敗した場合
  • 対象の DB インスタンスが停止以外の状態になった場合
ジョブ実行後のリソースの状態までチェックしない場合、以下の場合に Failed となります。
  • StopDBInstance API の実行に失敗した場合

注意事項

このアクションには次の制約があります。詳しくは Amazon RDS ユーザーガイドをご参照ください。

  • リードレプリカが含まれているか、リードレプリカである DB インスタンスは停止できません
  • マルチ AZ 配置のMicrosoft SQL Server の DB インスタンスは停止できません
  • DB インスタンスの状態が利用可能/停止以外 (バックアップ中や再起動中など) の場合は停止できません
  • DB インスタンスは最大で7日間停止でき、7日を超えると自動的に起動されます

このアクションで利用されるAWS API

当アクションの実行には以下のAWS APIを利用しています。
実行するAWSアカウントにはこれらのAPIを実行可能なIAMポリシーがアタッチされている必要があります。

この記事は役に立ちましたか?
0人中0人がこの記事が役に立ったと言っています
他にご質問がございましたら、リクエストを送信してください