5.2. SNSトピックの購読 (email)¶
作業の目的 [why]¶
メールアドレス"<通知先として登録するメールアドレス>"でSNSトピック"sesincoming-2017-10-09"を購読します。
作業対象 [what]¶
- SNSトピック
標準時間¶
8分
前提条件¶
作業環境条件 [where]¶
本作業は、以下の作業環境で行います。
作業環境条件1: OSとバージョン
Amazon Linuxの以下のバージョンで動作確認済
コマンド:
cat /etc/issue | head -1
結果(例):
Amazon Linux AMI release 2016.09
作業環境条件2: シェルとバージョン
bashの以下のバージョンで動作確認済
コマンド:
bash --version -v | head -1
結果(例):
GNU bash, バージョン 4.2.46(1)-release (x86_64-redhat-linux-gnu)
作業環境条件3: AWS CLIのバージョン
以下のバージョンで動作確認済
- AWS CLI 1.11.117
コマンド:
aws --version
結果(例):
aws-cli/1.11.166 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.7.24
バージョンが古い場合は最新版に更新しましょう。
コマンド:
sudo -H pip install -U awscli
開始条件¶
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: SNSトピック名
- 購読するSNSトピックの名称です。
- 今回は"sesincoming-2017-10-09"とします。
リソース2: 通知先プロトコル
- SNSトピックを購読する通知先のプロトコルです。
- 今回は"email"とします。
リソース3: 通知先エンドポイント
- SNSトピックの通知先です。プロトコルemailの場合はメールアドレスとなります。
- 今回は"<通知先として登録するメールアドレス>"とします。
- 作業中に受信メールの文面をターミナルに貼り付けられる必要があります。
タスクの実施¶
0. パラメータの指定¶
まず変数の確認をします。
変数の確認:
cat << ETX 0.a. AWS_DEFAULT_PROFILE: actual: ${AWS_DEFAULT_PROFILE} expect: <SNSのフル権限が許可されているプロファイル> 0.b. AWS_DEFAULT_REGION: actual: ${AWS_DEFAULT_REGION} expect: ap-northeast-1 0.1. SNS_TOPIC_NAME: actual: ${SNS_TOPIC_NAME} expect: sesincoming-2017-10-09 0.2. SNS_NOTIF_PROTOCOL: actual: ${SNS_NOTIF_PROTOCOL} expect: email 0.3. SNS_NOTIF_ENDPOINT: actual: ${SNS_NOTIF_ENDPOINT} expect: <通知先として登録するメールアドレス> ETX
変数が入っていない、適切でない場合は、それぞれの手順番号について作業を行います。
0.a. プロファイルの指定¶
プロファイルの一覧を確認します。
コマンド:
cat ~/.aws/credentials \ | grep '\[' \ | sed 's/\[//g' | sed 's/\]//g'
結果(例):
iamFull-prjz-mbpr13 <SNSのフル権限が許可されているプロファイル>
変数の設定:
export AWS_DEFAULT_PROFILE='<SNSのフル権限が許可されているプロファイル>'
再確認¶
設定されている変数の内容を再確認します。
変数の確認:
cat << ETX 0.a. AWS_DEFAULT_PROFILE: actual: ${AWS_DEFAULT_PROFILE} expect: <SNSのフル権限が許可されているプロファイル> 0.b. AWS_DEFAULT_REGION: actual: ${AWS_DEFAULT_REGION} expect: ap-northeast-1 0.1. SNS_TOPIC_NAME: actual: ${SNS_TOPIC_NAME} expect: sesincoming-2017-10-09 0.2. SNS_NOTIF_PROTOCOL: actual: ${SNS_NOTIF_PROTOCOL} expect: email 0.3. SNS_NOTIF_ENDPOINT: actual: ${SNS_NOTIF_ENDPOINT} expect: <通知先として登録するメールアドレス> ETX
1. 前処理¶
1.1. 状態確認に必要な情報の取得¶
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:sesincoming-2017-10-09
1.2. 作業対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: SNSトピック"sesincoming-2017-10-09"が存在する。
コマンド:
aws sns list-topics \ --query "Topics[?contains(TopicArn, \`${SNS_TOPIC_NAME}\`)]"
結果(例):
[ "TopicArn": "arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:sesincoming-2017-10-09" ]
事前条件2: SNSトピック"sesincoming-2017-10-09"にエンドポイント"<通知先として登録するメールアドレス>"(email)が登録されていない。
「SNSトピック"sesincoming-2017-10-09"にエンドポイント"<通知先として登録するメールアドレス>"(email)が登録されていない。」ことを確認します。
コマンド:
aws sns list-subscriptions-by-topic \ --topic-arn ${SNS_TOPIC_ARN} \ --query "Subscriptions[?Endpoint == \`${SNS_NOTIF_ENDPOINT}\`].Endpoint"
結果(例):
[]
事前条件3: エンドポイント"<通知先として登録するメールアドレス>"(email)が存在する。
「エンドポイント"<通知先として登録するメールアドレス>"(email)が存在する。」ことを確認します。
2. 主処理¶
SNSトピックの購読¶
変数の確認:
cat << ETX SNS_TOPIC_ARN: ${SNS_TOPIC_ARN} arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:sesincoming-2017-10-09 SNS_NOTIF_PROTOCOL: ${SNS_NOTIF_PROTOCOL} email SNS_NOTIF_ENDPOINT: ${SNS_NOTIF_ENDPOINT} <通知先として登録するメールアドレス> ETX
コマンド:
aws sns subscribe \ --topic-arn ${SNS_TOPIC_ARN} \ --protocol ${SNS_NOTIF_PROTOCOL} \ --notification-endpoint ${SNS_NOTIF_ENDPOINT}
結果(例):
{ "SubscriptionArn": "pending confirmation" }
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: SNSトピック"sesincoming-2017-10-09"にエンドポイント"<通知先として登録するメールアドレス>"(email)が登録されている。
「SNSトピック"sesincoming-2017-10-09"にエンドポイント"<通知先として登録するメールアドレス>"(email)が登録されている。」ことを確認します。
コマンド:
aws sns list-subscriptions-by-topic \ --topic-arn ${SNS_TOPIC_ARN} \ --query "Subscriptions[?Endpoint == \`${SNS_NOTIF_ENDPOINT}\`].Endpoint"
結果(例):
{ "<通知先として登録するメールアドレス>" }