4.1. CloudWatchアラームステータスの更新 (handson-cli-cloudwatch-custom-alarm)¶
作業の目的 [why]¶
CloudWatchアラーム"handson-cli-cloudwatch-custom-alarm"のステータスを更新します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
CloudWatchアラーム"handson-cli-cloudwatch-custom-alarm"のステータスが"ALARM"である。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
CloudWatchアラーム"handson-cli-cloudwatch-custom-alarm"が存在する。
- 事前条件2
CloudWatchアラーム"handson-cli-cloudwatch-custom-alarm"のステータスが"OK"である。
作業対象 [what]¶
CloudWatchアラーム
標準時間(合計)¶
8分
パラメータ設定¶
- パラメータ設定の標準時間
2分
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: CloudWatchアラーム名
ステータスを変更するCloudWatchアラームの名称です。
今回は"handson-cli-cloudwatch-custom-alarm"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.1. CloudWatchアラーム名の指定¶
CloudWatchアラーム名を指定します。
変数の設定:
CLOUDWATCH_ALARM_NAME='handson-cli-cloudwatch-custom-alarm'
0.2. CloudWatchアラームステータスの指定¶
CloudWatchアラームの更新後のステータスを指定します。
変数の設定:
CLOUDWATCH_ALARM_STATE_VALUE='ALARM'
0.3. CloudWatchアラームステータス理由の指定¶
CloudWatchアラームのステータス更新の理由を指定します。
変数の設定:
CLOUDWATCH_ALARM_STATE_REASON='test alarm.'
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-cloudwatch-custom" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-cloudwatch-alarm_state-update.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli-cloudwatch-custom/2020-03-02-cloudwatch-alarm_state-update.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. CLOUDWATCH_ALARM_NAME:"handson-cli-cloudwatch-custom-alarm" CLOUDWATCH_ALARM_NAME="${CLOUDWATCH_ALARM_NAME}" # 0.2. CLOUDWATCH_ALARM_STATE_VALUE:"ALARM" CLOUDWATCH_ALARM_STATE_VALUE="${CLOUDWATCH_ALARM_STATE_VALUE}" # 0.3. CLOUDWATCH_ALARM_STATE_REASON:"test alarm." CLOUDWATCH_ALARM_STATE_REASON="${CLOUDWATCH_ALARM_STATE_REASON}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
- タスク標準時間
6分
1. 前処理¶
処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: CloudWatchアラーム"handson-cli-cloudwatch-custom-alarm"が存在する。
「CloudWatchアラーム"handson-cli-cloudwatch-custom-alarm"が存在する。」ことを確認します。
コマンド:
aws cloudwatch describe-alarms \ --alarm-names ${CLOUDWATCH_ALARM_NAME} \ --query 'MetricAlarms[].AlarmName' \ --output text
結果(例):
handson-cli-cloudwatch-custom-alarm
事前条件2: CloudWatchアラーム"handson-cli-cloudwatch-custom-alarm"のステータスが"OK"である。
「CloudWatchアラーム"handson-cli-cloudwatch-custom-alarm"のステータスが"OK"である。」ことを確認します。
コマンド:
aws cloudwatch describe-alarms \ --alarm-names ${CLOUDWATCH_ALARM_NAME} \ --query 'MetricAlarms[].StateValue' \ --output text
結果(例):
OK
2. 主処理¶
CloudWatchアラームのステータス更新¶
変数の確認:
cat << ETX # CLOUDWATCH_ALARM_NAME:"handson-cli-cloudwatch-custom-alarm" CLOUDWATCH_ALARM_NAME="${CLOUDWATCH_ALARM_NAME}" # CLOUDWATCH_ALARM_STATE_VALUE:"ALARM" CLOUDWATCH_ALARM_STATE_VALUE="${CLOUDWATCH_ALARM_STATE_VALUE}" # CLOUDWATCH_ALARM_STATE_REASON:"test alarm." CLOUDWATCH_ALARM_STATE_REASON="${CLOUDWATCH_ALARM_STATE_REASON}" ETX
コマンド:
aws cloudwatch set-alarm-state \ --alarm-name ${CLOUDWATCH_ALARM_NAME} \ --state-value ${CLOUDWATCH_ALARM_STATE_VALUE} \ --state-reason "${CLOUDWATCH_ALARM_STATE_REASON}"
結果:
(戻り値なし)
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: CloudWatchアラーム"handson-cli-cloudwatch-custom-alarm"のステータスが"ALARM"である。
「CloudWatchアラーム"handson-cli-cloudwatch-custom-alarm"のステータスが"ALARM"である。」ことを確認します。
コマンド:
aws cloudwatch describe-alarms \ --alarm-names ${CLOUDWATCH_ALARM_NAME} \ --query 'MetricAlarms[].StateValue' \ --output text
結果(例):
ALARM