後始末2. SNSトピックの破棄 (handson-cli-cloudwatch-custom-topic)

作業の目的 [why]

SNSトピック"handson-cli-cloudwatch-custom-topic"を破棄します。

完了条件/事前条件 [設計者用情報]

完了条件 [after]

主処理は、以下を満たしたときに成功したものとします。

完了条件1

SNSトピック"handson-cli-cloudwatch-custom-topic"が存在しない。

事前条件 [before]

主処理の実施は、以下の状態であることを前提とします。

事前条件1

SNSトピック"handson-cli-cloudwatch-custom-topic"が存在する。

作業対象 [what]

  • SNSサービス

標準時間(合計)

8分

パラメータ設定

パラメータ設定の標準時間

2分

作業に必要なモノ・情報 [resource]

作業開始には、以下が全て揃っていることが必要です。

リソース1: SNSトピック名

  • 破棄するSNSトピックの名称です。

  • 今回は"handson-cli-cloudwatch-custom-topic"とします。

パラメータの指定

作業に必要なパラメータを変数に格納をします。

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. SNSトピック名の指定

SNSトピック名を指定します。

変数の設定:

SNS_TOPIC_NAME='handson-cli-cloudwatch-custom-topic'

パラメータの保存

設定されている変数の保存先となるファイル名を指定します。

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-cloudwatch-custom"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-sns-topic-delete.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli-cloudwatch-custom/2020-03-02-sns-topic-delete.env

各変数に正しいパラメータ値が格納されていることを確認しながら保存します。

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1. SNS_TOPIC_NAME:"handson-cli-cloudwatch-custom-topic"
         SNS_TOPIC_NAME="${SNS_TOPIC_NAME}"

EOF

cat ${FILE_PARAMETER}

下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。

タスクの実施

タスク標準時間

6分

1. 前処理

1.1. 処理対象の状態確認

主処理の実施は、以下の状態であることを前提とします。

前提と異なることが判明した場合、直ちに処理を中止します。

事前条件1: SNSトピック"handson-cli-cloudwatch-custom-topic"が存在する。

「SNSトピック"handson-cli-cloudwatch-custom-topic"が存在する。」ことを確認します。

コマンド:

aws sns list-topics \
  --query "Topics[?contains(TopicArn, \`${SNS_TOPIC_NAME}\`)].TopicArn" \
  --output text

結果(例):

arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson-cli-cloudwatch-custom-topic

1.2. 主処理に必要な情報の取得

SNSトピックのARN取得

変数の設定:

SNS_TOPIC_ARN=$( \
  aws sns list-topics \
    --query "Topics[?contains(TopicArn, \`${SNS_TOPIC_NAME}\`)].TopicArn" \
    --output text \
) \
  && echo ${SNS_TOPIC_ARN}

結果(例):

arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson-cli-cloudwatch-custom-topic

2. 主処理

SNSトピックの破棄

変数の確認:

cat << ETX

  # SNS_TOPIC_ARN:"arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson-cli-cloudwatch-custom-topic"
    SNS_TOPIC_ARN="${SNS_TOPIC_ARN}"

ETX

コマンド:

aws sns delete-topic \
  --topic-arn ${SNS_TOPIC_ARN}

結果(例):

(出力なし)

3. 後処理

完了条件の確認

主処理は、以下を満たしたときに成功したものとします。

完了条件1: SNSトピック"handson-cli-cloudwatch-custom-topic"が存在しない。

「SNSトピック"handson-cli-cloudwatch-custom-topic"が存在しない。」ことを確認します。

コマンド:

aws sns list-topics \
  --query "Topics[?contains(TopicArn, \`${SNS_TOPIC_NAME}\`)].TopicArn" \
  --output text

結果(例):

(出力なし)

完了