1. SNSトピックのアンサブスクライブ (config-topic)

作業の目的 [why]

SNSトピック"config-topic"からLambda関数"config-monitor"をアンサブスクライブします。

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

完了条件 [after]

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

完了条件1
SNSトピック"config-topic"にLambda関数"config-monitor"がサブスクライブしていない。

事前条件 [before]

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

事前条件1
SNSトピック"config-topic"が存在する。
事前条件2
Lambda関数"config-monitor"が存在する。
事前条件3
SNSトピック"config-topic"にLambda関数"config-monitor"がサブスクライブしている。

作業対象 [what]

  • SNSトピック

標準時間(合計)

8分

パラメータ設定

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

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

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

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

  • サブスクライブの対象となるSNSトピックの名称です。
  • 今回は"config-topic"とします。

リソース2: SNS通知プロトコル名

  • サブスクライブ対象への通知プロトコルの名称です。
  • 今回は"lambda"とします。

リソース3: Lambda関数名

  • アンサブスクライブするLambda関数の名称です。
  • 今回は"config-monitor"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='<リージョン名>'

0.1. SNSトピック名の指定

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

変数の設定:

SNS_TOPIC_NAME='config-topic'

0.2. SNS通知プロトコル名の指定

SNS通知プロトコル名を指定します。

変数の設定:

SNS_NOTIFICATION_PROTOCOL='lambda'

0.3. Lambda関数名の指定

Lambda関数名を指定します。

変数の設定:

LAMBDA_FUNCTION_NAME='config-monitor'

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-sns-subscribe-delete-expand-lambda.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.0. AWS_DEFAULT_REGION:"<リージョン名>"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1. SNS_TOPIC_NAME:"config-topic"
         SNS_TOPIC_NAME="${SNS_TOPIC_NAME}"
  # 0.2. SNS_NOTIFICATION_PROTOCOL:"lambda"
         SNS_NOTIFICATION_PROTOCOL="${SNS_NOTIFICATION_PROTOCOL}"
  # 0.3. LAMBDA_FUNCTION_NAME:"config-monitor"
         LAMBDA_FUNCTION_NAME="${LAMBDA_FUNCTION_NAME}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

1.1. 処理対象の状態確認

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

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

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

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

コマンド:

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

結果(例):

arn:aws:sns:<リージョン名>:XXXXXXXXXXXX:config-topic

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:<リージョン名>:XXXXXXXXXXXX:config-topic

事前条件2: Lambda関数"config-monitor"が存在する。

「Lambda関数"config-monitor"が存在する。」ことを確認します。

コマンド:

aws lambda list-functions \
  --query "Functions[?FunctionName == \`${LAMBDA_FUNCTION_NAME}\`].FunctionName" \
  --output text

結果(例):

config-monitor

Lambda関数のARNを取得します。

コマンド:

LAMBDA_FUNCTION_ARN=$( \
  aws lambda get-function \
    --function-name ${LAMBDA_FUNCTION_NAME} \
    --query 'Configuration.FunctionArn' \
    --output text \
) \
  && echo ${LAMBDA_FUNCTION_ARN}

結果(例):

arn:aws:lambda:<リージョン名>:XXXXXXXXXXXX:function:config-monitor

通知エンドポイントにLambda関数のARNを指定します。

変数の設定:

SNS_NOTIFICATION_ENDPOINT="${LAMBDA_FUNCTION_ARN}" \
  && echo ${SNS_NOTIFICATION_ENDPOINT}

結果(例):

arn:aws:lambda:<リージョン名>:XXXXXXXXXXXX:function:config-monitor

事前条件3: SNSトピック"config-topic"にLambda関数"config-monitor"がサブスクライブしている。

「SNSトピック"config-topic"にLambda関数"config-monitor"がサブスクライブしている。」ことを確認します。

コマンド:

aws sns list-subscriptions-by-topic \
  --topic-arn ${SNS_TOPIC_ARN} \
  --query "Subscriptions[?Endpoint == \`${SNS_NOTIFICATION_ENDPOINT}\`].SubscriptionArn" \
  --output text

結果(例):

arn:aws:sns:<リージョン名>:XXXXXXXXXXXX:config-topic:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

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

sample

変数の設定:

SNS_SUBSCRIPTION_ARN=$( \
  aws sns list-subscriptions-by-topic \
    --topic-arn ${SNS_TOPIC_ARN} \
    --query "Subscriptions[?Endpoint == \`${SNS_ENDPOINT}\`].SubscriptionArn" \
    --output text \
) \
  && echo ${SNS_SUBSCRIPTION_ARN}

結果(例):

arn:aws:sns:<リージョン名>:XXXXXXXXXXXX:config-topic:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

2. 主処理

SNSトピックのアンサブスクライブ

変数の確認:

cat << ETX

  # SNS_SUBSCRIPTION_ARN:"arn:aws:sns:<リージョン名>:XXXXXXXXXXXX:config-topic:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    SNS_SUBSCRIPTION_ARN="${SNS_SUBSCRIPTION_ARN}"

ETX

コマンド:

aws sns unsubscribe \
  --subscription-arn ${SNS_SUBSCRIPTION_ARN}

結果(例):

(戻り値なし)

3. 後処理

完了条件の確認

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

完了条件1: SNSトピック"config-topic"にLambda関数"config-monitor"がサブスクライブしていない。

「SNSトピック"config-topic"にLambda関数"config-monitor"がサブスクライブしていない。」ことを確認します。

コマンド:

aws sns list-subscriptions-by-topic \
  --topic-arn ${SNS_TOPIC_ARN} \
  --query "Subscriptions[?Endpoint == \`${SNS_NOTIFICATION_ENDPOINT}\`].SubscriptionArn" \
  --output text

結果(例):

(出力なし)

完了