2. SNSトピック購読者の追加 (メールアドレス: handson-cli-sns-1st-topic)¶

手順の目的¶

SNSトピック"handson-cli-sns-1st-topic"の購読者にメールアドレス"<送信先のメールアドレス>"を登録します。

設定値の指定¶

手順に必要な設定値を変数に格納をします。

0. リージョンの指定¶

リージョンを指定します。

環境変数の設定:
export AWS_DEFAULT_REGION='ap-northeast-1'

1. SNSトピック名¶

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

変数の設定:

SNS_TOPIC_NAME='handson-cli-sns-1st-topic'

2. SNS通知プロトコル名¶

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

変数の設定:
SNS_SUBSCRIPTION_PROTOCOL='email'

3. 通知先エンドポイント¶

一時ファイルを指定します。

変数の設定:

DIR_TMP="${HOME}/environment/tmp-handson-cli-sns-1st"

変数の設定:

FILE_TMP="${DIR_TMP}/mail_address.tmp" \
  && echo ${FILE_TMP}

結果(例):

${HOME}/environment/tmp-handson-cli-sns-1st/mail_address.tmp

一時ファイルをsourceコマンドで読み込みます。

コマンド:
source ${FILE_TMP}

通知先エンドポイントを指定します。

変数の設定:

SNS_SUBSCRIPTION_ENDPOINT="${MAIL_ADDRESS}" \
  && echo ${SNS_SUBSCRIPTION_ENDPOINT}

結果(例):

<送信先のメールアドレス>

設定値の確認¶

各変数に正しい設定値が格納されていることを確認します。

変数の確認:

cat << END

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

  # 1. SNS_TOPIC_NAME:"handson-cli-sns-1st-topic"
       SNS_TOPIC_NAME="${SNS_TOPIC_NAME}"
  # 2. SNS_SUBSCRIPTION_PROTOCOL:"email"
       SNS_SUBSCRIPTION_PROTOCOL="${SNS_SUBSCRIPTION_PROTOCOL}"
  # 3. SNS_SUBSCRIPTION_ENDPOINT:"<送信先のメールアドレス>"
       SNS_SUBSCRIPTION_ENDPOINT="${SNS_SUBSCRIPTION_ENDPOINT}"

END

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

処理の実行¶

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-sns-1st-topic

SNSトピックの購読者にメールアドレスを登録します。

変数の確認:

cat << END

  # SNS_TOPIC_ARN:"arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson-cli-sns-1st-topic"
    SNS_TOPIC_ARN="${SNS_TOPIC_ARN}"
  # SNS_SUBSCRIPTION_PROTOCOL:"email"
    SNS_SUBSCRIPTION_PROTOCOL="${SNS_SUBSCRIPTION_PROTOCOL}"
  # SNS_SUBSCRIPTION_ENDPOINT:"<送信先のメールアドレス>"
    SNS_SUBSCRIPTION_ENDPOINT="${SNS_SUBSCRIPTION_ENDPOINT}"

END

コマンド:

aws sns subscribe \
  --topic-arn ${SNS_TOPIC_ARN} \
  --protocol ${SNS_SUBSCRIPTION_PROTOCOL} \
  --notification-endpoint ${SNS_SUBSCRIPTION_ENDPOINT}

結果(例):

{
  "SubscriptionArn": "pending confirmation"
}

登録したメールアドレスに"AWS Notification - Subscription Confirmation"という標題のメールが届きます。

メール(例):

確認メールの"Confirm subscription"リンクをクリックすると、"Subscription Confirmed!"という画面が表示され、承認プロセスが完了します。

Webブラウザ画面(例):

注釈

承認プロセスが完了することで、SNSサブスクリプションARNが"PendingConfirmation"からARN形式のARNに変わります。

"click here to unsubscribe"(リンク)をクリックすると購読中止となり、通知を受けることができなくなります。

完了確認¶

「SNSトピック"handson-cli-sns-1st-topic"にプロトコル"email"のエントポイント(メールアドレス)"<送信先のメールアドレス>"が存在する。」ことを確認します。

コマンド:

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

結果(例):

<送信先のメールアドレス>

「SNSトピック"handson-cli-sns-1st-topic"に登録されているエントポイント"<送信先のメールアドレス>"のサブスクリプションARNが存在する。("PendingConfirmation"ではない。)」ことを確認します。

コマンド:

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

結果(例):

arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson-cli-sns-1st-topic:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

手順の完了¶

(参考) マネジメントコンソールの確認¶

SNSダッシュボード( https://console.aws.amazon.com/sns/home )にアクセスします。
右上のリージョンメニューから"東京 "を選択します。
左ペインの"サブスクリプション"をクリックします。

サブスクリプション一覧(画面)

検索欄にトピック名"handson-cli-sns-1st-topic"を入力します。
エンドポイント名"<送信先のメールアドレス>"が存在することを確認します。