1.2. SNSトピックへのメールアドレス登録 (handson-cli-topic)¶
作業の目的 [why]¶
SNSトピック"handson-cli-topic"にメールアドレス"<通知先メールアドレス>"を登録します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- SNSトピック"handson-cli-topic"にプロトコル"email"のエントポイント(メールアドレス)"<通知先メールアドレス>"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- SNSトピック"handson-cli-topic"が存在する。
- 事前条件2
- SNSトピック"handson-cli-topic"にプロトコル"email"のエントポイント(メールアドレス)"<通知先メールアドレス>"が存在しない。
作業対象 [what]¶
- SNSサービス
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: SNSトピック名
- 購読するSNSトピックの名称です。
- 今回は"handson-cli-topic"とします。
リソース2: 通知先プロトコル
- SNSトピックを購読する通知先のプロトコルです。
- 今回は"email"とします。
リソース3: 通知先エンドポイント
- SNSトピックの通知先です。プロトコルemailの場合はメールアドレスとなります。
- 今回は"<通知先メールアドレス>"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-sns-subscribe-create-expand-email.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli/2019-04-30-sns-subscribe-create-expand-email.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-topic" SNS_TOPIC_NAME="${SNS_TOPIC_NAME}" # 0.2. SNS_NOTIFICATION_PROTOCOL:"email" SNS_NOTIFICATION_PROTOCOL="${SNS_NOTIFICATION_PROTOCOL}" # 0.3. SNS_NOTIFICATION_ENDPOINT:"<通知先メールアドレス>" SNS_NOTIFICATION_ENDPOINT="${SNS_NOTIFICATION_ENDPOINT}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
| タスク標準時間: | 6分 |
|---|
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: SNSトピック"handson-cli-topic"が存在する。
「SNSトピック"handson-cli-topic"が存在する。」ことを確認します。
コマンド:
aws sns list-topics \ --query "Topics[?contains(TopicArn, \`${SNS_TOPIC_NAME}\`)].TopicArn" \ --output text
結果(例):
arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson-cli-topic
事前条件2: SNSトピック"handson-cli-topic"にプロトコル"email"のエントポイント(メールアドレス)"<通知先メールアドレス>"が存在しない。
「SNSトピック"handson-cli-topic"にプロトコル"email"のエントポイント(メールアドレス)"<通知先メールアドレス>"が存在しない。」ことを確認します。
コマンド:
aws sns list-subscriptions-by-topic \ --topic-arn ${SNS_TOPIC_ARN} \ --query "Subscriptions[?Endpoint == \`${SNS_NOTIFICATION_ENDPOINT}\`].SubscriptionArn" \ --output text
結果(例):
(出力なし)
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-topic
2. 主処理¶
SNSトピックへのメールアドレス登録¶
変数の確認:
cat << ETX # SNS_TOPIC_ARN:"arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson-cli-topic" SNS_TOPIC_ARN="${SNS_TOPIC_ARN}" # SNS_NOTIFICATION_PROTOCOL:"email" SNS_NOTIFICATION_PROTOCOL="${SNS_NOTIFICATION_PROTOCOL}" # SNS_NOTIFICATION_ENDPOINT:"<通知先メールアドレス>" SNS_NOTIFICATION_ENDPOINT="${SNS_NOTIFICATION_ENDPOINT}" ETX
コマンド:
aws sns subscribe \ --topic-arn ${SNS_TOPIC_ARN} \ --protocol ${SNS_NOTIFICATION_PROTOCOL} \ --notification-endpoint ${SNS_NOTIFICATION_ENDPOINT}
結果(例):
{ "SubscriptionArn": "pending confirmation" }
3. 後処理¶
3.1. 状態確認に必要な処理¶
確認メールの承認
登録したメールアドレスに"AWS Notification - Subscription Confirmation"という標題のメールが届くので、"Confirm subscription"リンクをクリックして承認します。
1.2. 完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: SNSトピック"handson-cli-topic"にプロトコル"email"のエントポイント(メールアドレス)"<通知先メールアドレス>"が存在する。
「SNSトピック"handson-cli-topic"にプロトコル"email"のエントポイント(メールアドレス)"<通知先メールアドレス>"が存在する。」ことを確認します。
コマンド:
aws sns list-subscriptions-by-topic \ --topic-arn ${SNS_TOPIC_ARN} \ --query "Subscriptions[?Endpoint == \`${SNS_NOTIFICATION_ENDPOINT}\`].Endpoint" \ --output text
結果(例):
<通知先メールアドレス>