AWS CLIの振り返り ~SNS入門編~

本記事の目的

JAWS-UG CLI オンラインハンズオンの復習として、ハンズオンで取り上げられたAWSサービスに関する用語と、使用したAWS CLI コマンドを箇条書きでまとめる。
今回はSNS入門編を取り上げる。

主なAWSサービス用語

トピック

通知チャネルとしての機能を持つ論理アクセスポイント。

パブリッシュ

メッセージを発行し、トピックに送信する事。メッセージを送信するアプリケーション及びシステムは、パブリッシャーと呼ばれる。

サブスクライブ

トピックからメッセージを受信する事。メッセージを受信するアプリケーション及びシステムは、サブスクライバーと呼ばれる。

通知プロトコル

メッセージのサブスクライブ手段。HTTP,SMS,Email,AWS Lambda等の種類がある。

通知先エンドポイント

サブスクライブする端末を識別するためのデータ。通知プロトコルによってデータ形式が異なる。

サブスクリプション

トピックと通知先エンドポイントを紐づけるデータ。

主なAWS CLI コマンド一覧

トピックの作成

aws sns create-topic \
  --name ${SNS_TOPIC_NAME}

オプション	引数	必須/任意	備考
--name	トピックの名前	必須

トピックの一覧表示

aws sns list-topics 

トピックの削除

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

オプション	引数	必須/任意	備考
--topic-arn	トピックのARN	必須

エンドポイントの登録

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

オプション	引数	必須/任意	備考
--topic-arn	トピックのARN	必須
--protocol	通知プロトコル	必須	通知プロトコルの例：email
--notification-endpoint	通知先エンドポイント	必須	通知先エンドポイントの例：メールアドレス([e-mail])

エンドポイントの表示

aws sns list-subscriptions-by-topic \
  --topic-arn ${SNS_TOPIC_ARN}

エンドポイントの解除

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

オプション	引数	必須/任意	備考
--subscription-arn	サブスクリプションのARN	必須

メッセージの送信

aws sns publish \
  --topic-arn ${SNS_TOPIC_ARN} \
  --message ${SNS_MESSAGE_BODY} \
  --subject ${SNS_MESSAGE_SUBJECT}

オプション	引数	必須/任意	備考
--topic-arn	トピックのARN	必須
--message	メッセージ内容	必須
--subject	題名	必須

参考文献

• AWSCLIコマンドリファレンス:sns
• JAWS-UG CLI専門支部：ハンズオン(簡易版): SNS入門