7.2. SESルール(S3)の作成

作業の目的 [why]

SESルールセット"default-rule-set"に、以下のSESルール"incoming-admin"を追加します。

  • "admin@<ドメイン名>"宛のメールをS3バケット"sesincoming-<ドメイン名>"に保存します。

作業対象 [what]

  • SESサービス

標準時間

8分

前提条件

作業権限条件 [who]

本作業は、以下の作業権限を有する人が行います。

作業権限条件: SESへの権限

SESに対してフル権限があること。

作業環境条件 [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: 設定ファイル用ディレクトリ

  • 今回は"${HOME}/tmp/conf-ses"を設定ファイル用ディレクトリとします。

    ls ${HOME}/tmp/conf-ses
    
  • 存在しない場合は作成します。

    mkdir -p ${HOME}/tmp/conf-ses
    

リソース2: SESルールセット名

  • 作成するSESルールが属するSESルールセットの名称です。
  • 今回は"default-rule-set"とします。

リソース3: SESルール名

  • 作成するSESルールの名称です。
  • 今回は"incoming-admin"とします。

リソース4: SES受信名

  • 作成するSESルールで利用する受信メールアドレスです。
  • 今回は"admin@<ドメイン名>"とします。

リソース5: S3バケット名

  • 作成するSESルールで受信したメールを保存するS3バケットの名称です。
  • 今回は"sesincoming-<ドメイン名>"とします。

作業開始 [when]

以下を全て満たしているとき、作業を開始します。

  • 開始の指示があった場合。

タスクの実施

0. パラメータの指定

まず変数の確認をします。

変数の確認:

cat << ETX

  AWS_DEFAULT_PROFILE: (0.a) expect: ${AWS_DEFAULT_PROFILE}
                             actual: <SESのフル権限が許可されているプロファイル>
  AWS_DEFAULT_REGION:  (0.b) expect: ${AWS_DEFAULT_REGION}
                             actual: us-west-2

  DIR_CONF:            (0.1) expect: ${DIR_CONF}
                             actual: ${HOME}/tmp/conf-ses
  SES_RULE_SET_NAME:   (0.2) expect: ${SES_RULE_SET_NAME}
                             actual: default-rule-set
  SES_RULE_NAME:       (0.3) expect: ${SES_RULE_NAME}
                             actual: incoming-admin
  SES_RECIPIENT:       (0.4) actual: ${SES_RECIPIENT}
                             expect: admin@<ドメイン名>
  S3_BUCKET_NAME:      (0.5) actual: ${S3_BUCKET_NAME}
                             expect: sesincoming-<ドメイン名>

ETX

変数が入っていない、適切でない場合は、それぞれの手順番号について作業を行います。

0.a. プロファイルの指定

プロファイルの一覧を確認します。

コマンド:

cat ~/.aws/credentials \
 | grep '\[' \
 | sed 's/\[//g' | sed 's/\]//g'

結果(例):

iamFull-prjz-mbpr13
<SESのフル権限が許可されているプロファイル>

変数の設定:

export AWS_DEFAULT_PROFILE='<SESのフル権限が許可されているプロファイル>'

0.b. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='us-west-2'

0.1. 設定ファイルディレクトリの指定

変数の設定:

DIR_CONF="${HOME}/tmp/conf-ses"

0.2. SESルールセット名の指定

SESルールセット名を指定します。

変数の設定:

SES_RULE_SET_NAME='default-rule-set'

0.3. SESルール名の指定

SESルール名を指定します。

変数の設定:

SES_RULE_NAME='incoming-admin'

0.4. SES受信名の指定

SES受信名を指定します。

変数の設定:

DOMAIN_NAME='<ドメイン名>'

変数の設定:

SES_RECIPIENT="admin@${DOMAIN_NAME}" \
  && echo ${SES_RECIPIENT}

結果(例):

admin@<ドメイン名>

0.5. S3バケット名の指定

S3バケット名を指定します。

変数の設定:

S3_BUCKET_NAME="sesincoming-${DOMAIN_NAME}" \
  && echo ${S3_BUCKET_NAME}

結果(例):

sesincoming-<ドメイン名>

再確認

設定されている変数の内容を再確認します。

変数の確認:

cat << ETX

  AWS_DEFAULT_PROFILE: (0.a) expect: ${AWS_DEFAULT_PROFILE}
                             actual: <SESのフル権限が許可されているプロファイル>
  AWS_DEFAULT_REGION:  (0.b) expect: ${AWS_DEFAULT_REGION}
                             actual: us-west-2

  DIR_CONF:            (0.1) expect: ${DIR_CONF}
                             actual: ${HOME}/tmp/conf-ses
  SES_RULE_SET_NAME:   (0.2) expect: ${SES_RULE_SET_NAME}
                             actual: default-rule-set
  SES_RULE_NAME:       (0.3) expect: ${SES_RULE_NAME}
                             actual: incoming-admin
  SES_RECIPIENT:       (0.4) actual: ${SES_RECIPIENT}
                             expect: admin@<ドメイン名>
  S3_BUCKET_NAME:      (0.5) actual: ${S3_BUCKET_NAME}
                             expect: sesincoming-<ドメイン名>

ETX

1. 前処理

1.1. 処理対象の状態確認

主処理の実施は、以下の状態であることを前提とします。

前提と異なることが判明した場合、直ちに処理を中止します。

事前条件1: 設定ファイル用ディレクトリが存在する。

「設定ファイル用ディレクトリが存在する。」ことを確認します。

コマンド:

ls -d ${DIR_CONF}

結果(例):

${HOME}/tmp/conf-ses

事前条件2: SESルールセット"default-rule-set"が存在する。

「SESルールセット"default-rule-set"が存在する。」ことを確認します。

コマンド:

aws ses list-receipt-rule-sets 

結果(例):

{
  "RuleSets": [
    {
        "CreatedTimestamp": "2017-10-09 T01:23:45.678Z",
        "Name": "default-rule-set"
    }
  ]
}

事前条件3: SESルール"incoming-admin"が存在しない。

「SESルール"incoming-admin"が存在しない。」ことを確認します。

コマンド:

aws ses describe-receipt-rule \
  --rule-set-name ${SES_RULE_SET_NAME} \
  --rule-name ${SES_RULE_NAME} \
  --query 'Rule.Name'

結果(例):

An error occurred (RuleDoesNotExist) when calling the DescribeReceiptRule operation: Rule does not exist: incoming-admin

1.2. ルールドキュメントの作成

変数の設定:

FILE_INPUT="${DIR_CONF}/${SES_RULE_NAME}-$(date +%Y-%m-%d).json" \
  && echo ${FILE_INPUT}

変数の確認:

cat << ETX

  FILE_INPUT:     actual: ${FILE_INPUT}
                  expect: ${HOME}/tmp/conf-ses/incoming-admin-YYYY-MM-DD.json
  SES_RULE_NAME:  actual: ${SES_RULE_NAME}
                  expect: incoming-admin
  SES_RECIPIENT:  actual: ${SES_RECIPIENT}
                  expect: admin@<ドメイン名>
  S3_BUCKET_NAME: actual: ${S3_BUCKET_NAME}
                  expect: sesincoming-<ドメイン名>

ETX

コマンド:

cat << EOF > ${FILE_INPUT}
{
  "Name": "${SES_RULE_NAME}",
  "Enabled": true,
  "TlsPolicy": "Optional",
  "Recipients": [
    "${SES_RECIPIENT}"
  ],
  "Actions": [
    {
      "S3Action": {
        "BucketName": "${S3_BUCKET_NAME}"
      }
    }
  ],
  "ScanEnabled": true
}
EOF

cat ${FILE_INPUT}

結果(例):

{
  "Name": "incoming-admin",
  "Enabled": true,
  "TlsPolicy": "Optional",
  "Recipients": [
    "admin@<ドメイン名> "
  ],
  "Actions": [
    {
      "S3Action": {
        "BucketName": "sesincoming-<ドメイン名>"
      }
    }
  ],
  "ScanEnabled": true
}

JSONファイルを作成したら、フォーマットが壊れてないか必ず確認します。

コマンド:

jsonlint -q ${FILE_INPUT}

エラーが出力されなければOKです。

2. 主処理

SESルールの作成

変数の確認:

cat << ETX

  SES_RULE_SET_NAME: actual: ${SES_RULE_SET_NAME}
                     expect: default-rule-set
  SES_RULE_NAME:     actual: ${SES_RULE_NAME}
                     expect: incoming-admin
  FILE_INPUT:        actual: ${FILE_INPUT}
                     expect: ${HOME}/tmp/conf-ses/incoming-admin-YYYY-MM-DD.json

ETX

コマンド:

aws ses create-receipt-rule \
  --rule-set-name ${SES_RULE_SET_NAME} \
  --rule ${SES_RULE_NAME} \
  --rule file://${FILE_INPUT}

結果(例):

(出力なし)

3. 後処理

完了条件の確認

主処理は、以下を満たしたときに成功したものとします。

完了条件1: SESルール"incoming-admin"が存在する。

「SESルール"incoming-admin"が存在する。」ことを確認します。

コマンド:

aws ses describe-receipt-rule \
  --rule-set-name ${SES_RULE_SET_NAME} \
  --rule-name ${SES_RULE_NAME} \
  --query 'Rule.Name'

結果(例):

"incoming-admin"

参考: S3バケットの確認

SESルールの作成通知メールがS3バケットに届いています。

コマンド:

aws s3 ls s3://${S3_BUCKET_NAME}/AMAZON_SES_SETUP_NOTIFICATION

結果:

2017-10-09 01:23:45        645 AMAZON_SES_SETUP_NOTIFICATION

完了