2.4. SNSトピックポリシーの更新 (S3)¶
作業の目的 [why]¶
SNSトピック"handson20170904"にS3に対するアクセス許可のポリシーを設定します。
作業対象 [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.144 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.7.2
バージョンが古い場合は最新版に更新しましょう。
コマンド:
sudo -H pip install -U awscli
開始条件¶
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: 設定ファイル用ディレクトリ
今回は"${HOME}/tmp/conf-sns"を設定ファイル用ディレクトリとします。
ls ${HOME}/tmp/conf-sns存在しない場合は作成します。
mkdir -p ${HOME}/tmp/conf-sns
リソース2: SNSトピック名
- 作成するSNSトピックの名称です。
- 今回は"handson20170904"とします。
タスクの実施¶
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. DIR_CONF: actual: ${DIR_CONF} expect: ${HOME}/tmp/conf-sns 0.2. SNS_TOPIC_NAME: actual: ${SNS_TOPIC_NAME} expect: handson20170904 0.3. S3_BUCKET_NAME: actual: ${S3_BUCKET_NAME} expect: handson20170904data-XXXXXXXXXXXX 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. DIR_CONF: actual: ${DIR_CONF} expect: ${HOME}/tmp/conf-sns 0.2. SNS_TOPIC_NAME: actual: ${SNS_TOPIC_NAME} expect: handson20170904 0.3. S3_BUCKET_NAME: actual: ${S3_BUCKET_NAME} expect: handson20170904data-XXXXXXXXXXXX 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:handson20170904
1.2. 作業対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: 設定ファイル用ディレクトリが存在する。
コマンド:
ls -d ${DIR_CONF}
結果(例):
${HOME}/tmp/conf-sns
事前条件2: SNSトピック"handson20170904"が存在する。
「SNSトピック"handson20170904"が存在する。」ことを確認します。
コマンド:
aws sns list-topics \ --query "Topics[?contains(TopicArn, \`${SNS_TOPIC_NAME}\`)]"
結果(例):
[ "TopicArn": "arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson20170904" ]
事前条件3: SNSトピック"handson20170904"がS3に対してPublishの許可をしていないこと。
「SNSトピック"handson20170904"がS3に対してPublishの許可をしていないこと。」ことを確認します。
コマンド:
aws sns get-topic-attributes \ --topic-arn ${SNS_TOPIC_ARN} \ --query 'Attributes.Policy'
結果(例):
{ "{"Version":"2008-10-17","Id":"__default_policy_ID","Statement":[{"Sid":"__default_statement_ID","Effect":"Allow","Principal":{"AWS":"*"},"Action":["SNS:GetTopicAttributes","SNS:SetTopicAttributes","SNS:AddPermission","SNS:RemovePermission","SNS:DeleteTopic","SNS:Subscribe","SNS:ListSubscriptionsByTopic","SNS:Publish","SNS:Receive"],"Resource":"arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson20170904","Condition":{"StringEquals":{"AWS:SourceOwner":"XXXXXXXXXXXX"}}}]}" }
1.3. 主処理に必要な情報の取得¶
ポリシードキュメントの作成
変数の設定:
FILE_INPUT="${DIR_CONF}/${SNS_TOPIC_NAME}-policy.json" \ && echo ${FILE_INPUT}
変数の確認:
cat << ETX SNS_TOPIC_NAME: actual: ${SNS_TOPIC_NAME} expect: handson20170904 SNS_TOPIC_ARN: actual: ${SNS_TOPIC_ARN} expect: arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson20170904 S3_BUCKET_NAME: actual: ${S3_BUCKET_NAME} expect: handson20170904data-XXXXXXXXXXXX ETX
コマンド:
cat << EOF > ${FILE_INPUT} { "Version": "2008-10-17", "Id": "", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "AWS": "*" }, "Action": [ "SNS:Publish" ], "Resource": "${SNS_TOPIC_ARN}", "Condition": { "ArnLike": { "aws:SourceArn": "arn:aws:s3:*:*:${S3_BUCKET_NAME}" } } } ] } EOF cat ${FILE_INPUT}
結果(例):
{ "Version": "2008-10-17", "Id": "", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "AWS": "*" }, "Action": [ "SNS: Publish" ], "Resource": "arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson20170904", "Condition": { "ArnLike": { "aws:SourceArn": "arn:aws:s3:*:*:handson20170904data-XXXXXXXXXXXX" } } } ] }
JSONファイルを作成したら、フォーマットが壊れてないか必ず確認します。
コマンド:
jsonlint -q ${FILE_INPUT}
エラーが出力されなければOKです。
変更する属性名の指定
変数の設定:
SNS_TOPIC_ATTRIBUTE_NAME='Policy'
変更する属性の内容の指定
変数の設定:
SNS_TOPIC_ATTRIBUTE_VALUE="file://${FILE_INPUT}" \ && echo ${SNS_TOPIC_ATTRIBUTE_VALUE}
2. 主処理¶
SNSトピックポリシーの更新¶
変数の確認:
cat << ETX FILE_INPUT: actual: ${FILE_INPUT} expect: ${HOME}/tmp/conf-sns/handson20170904-policy.json SNS_TOPIC_ARN: actual: ${SNS_TOPIC_ARN} expect: arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson20170904 SNS_TOPIC_ATTRIBUTE_NAME: actual: ${SNS_TOPIC_ATTRIBUTE_NAME} expect: Policy SNS_TOPIC_ATTRIBUTE_VALUE: actual: ${SNS_TOPIC_ATTRIBUTE_VALUE} expect: file://${HOME}/tmp/conf-sns/handson20170904-policy.json ETX
コマンド:
aws sns set-topic-attributes \ --topic-arn ${SNS_TOPIC_ARN} \ --attribute-name ${SNS_TOPIC_ATTRIBUTE_NAME} \ --attribute-value ${SNS_TOPIC_ATTRIBUTE_VALUE}
結果(例):
(出力なし)
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: SNSトピック"handson20170904"がS3に対してPublishの許可をしていること。
「SNSトピック"handson20170904"がS3に対してPublishの許可をしていること。」ことを確認します。
コマンド:
aws sns get-topic-attributes \ --topic-arn ${SNS_TOPIC_ARN} \ --query 'Attributes.Policy'
結果(例):
"{"Version":"2008-10-17","Id":"","Statement":[{"Sid":"","Effect":"Allow","Principal":{"AWS":"*"},"Action":"SNS:Publish","Resource":"arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:handson20170904","Condition":{"ArnLike":{"aws:SourceArn":"arn:aws:s3:*:*:handson20170904data-XXXXXXXXXXXX"}}}]}"