2.1. Route53 リソースレコードセットの作成 (TXTレコード: SESトークン)

作業の目的 [why]

Route53ゾーン"<ドメイン名>"に、SESへのドメイン登録に必要なトークンをリソースタイプ"TXT"のリソースレコード"_amazonses.<ドメイン名>."に登録する。

作業対象 [what]

  • Route53ゾーン

標準時間

8分

前提条件

作業権限条件 [who]

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

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

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

作業環境条件 [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-route53"を設定ファイル用ディレクトリとします。

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

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

リソース2: Route53ゾーン名

  • レコードを登録するRoute53ゾーンの名称です。
  • 今回は"<ドメイン名>"とします。

リソース3: Route53アクション名

  • レコードを登録するRoute53アクションの名称です。
  • 今回は"CREATE"とします。

リソース4: Route53リソースレコード名

  • レコードを登録するRoute53リソースレコードの名称です。
  • 今回は"_amazonses.<ドメイン名>."とします。

リソース5: Route53リソースレコードタイプ

  • レコードを登録するRoute53リソースレコードタイプです。
  • 今回は"TXT"とします。

リソース6: リソースレコードの値

  • 登録するリソースレコードの値です。
  • 今回は"'"'<SESのトークン文字列>'"'"とします。

リソース7: リソースレコードのTTL

  • 登録するリソースレコードのTTLです。
  • 今回は"300"とします。

作業開始 [when]

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

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

タスクの実施

0. パラメータの指定

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

変数の確認:

cat << ETX

  AWS_DEFAULT_PROFILE: (0.a) actual: ${AWS_DEFAULT_PROFILE}
                             expect: <Route53のフル権限が許可されているプロファイル>

  DIR_CONF:            (0.1) actual: ${DIR_CONF}
                             expect: ${HOME}/tmp/conf-route53
  R53_ZONE_NAME:       (0.2) actual: ${R53_ZONE_NAME}
                             expect: <ドメイン名>
  R53_RRSET_ACTION:    (0.3) actual: ${R53_RRSET_ACTION}
                             expect: CREATE
  R53_RRSET_TYPE:      (0.4) actual: ${R53_RRSET_TYPE}
                             expect: TXT
  R53_RRSET_TTL:       (0.5) actual: ${R53_RRSET_TTL}
                             expect: 300
  R53_RRSET_NAME:      (0.6) actual: ${R53_RRSET_NAME}
                             expect: _amazonses.<ドメイン名>.
  R53_RRSET_VALUE:     (0.7) actual: ${R53_RRSET_VALUE}
                             expect: \"'"'<SESのトークン文字列>'"'\"

ETX

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

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

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

コマンド:

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

結果(例):

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

変数の設定:

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

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

変数の設定:

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

0.2. Route53ゾーン名の指定

Route53ゾーン名を指定します。

変数の設定:

R53_ZONE_NAME='<ドメイン名>'

0.3. アクションの指定

変数の設定:

R53_RRSET_ACTION='CREATE'

0.4. レコードタイプの指定

変数の設定:

R53_RRSET_TYPE='TXT'

0.5. TTLの指定

TTLは必須項目になっている。

変数の設定:

R53_RRSET_TTL='300'

0.6. レコード名の指定

変数の設定:

R53_RRSET_NAME="_amazonses.${R53_ZONE_NAME}." \
  && echo ${R53_RRSET_NAME}

結果(例):

_amazonses.<ドメイン名>.

0.7. レコードの値の指定

TXTレコードの値はエスケープする必要があります。

変数の設定:

R53_RRSET_VALUE='\"'"<SESのトークン文字列>"'\"'

再確認

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

変数の確認:

cat << ETX

  AWS_DEFAULT_PROFILE: (0.a) actual: ${AWS_DEFAULT_PROFILE}
                             expect: <Route53のフル権限が許可されているプロファイル>

  DIR_CONF:            (0.1) actual: ${DIR_CONF}
                             expect: ${HOME}/tmp/conf-route53
  R53_ZONE_NAME:       (0.2) actual: ${R53_ZONE_NAME}
                             expect: <ドメイン名>
  R53_RRSET_ACTION:    (0.3) actual: ${R53_RRSET_ACTION}
                             expect: CREATE
  R53_RRSET_TYPE:      (0.4) actual: ${R53_RRSET_TYPE}
                             expect: TXT
  R53_RRSET_TTL:       (0.5) actual: ${R53_RRSET_TTL}
                             expect: 300
  R53_RRSET_NAME:      (0.6) actual: ${R53_RRSET_NAME}
                             expect: _amazonses.<ドメイン名>.
  R53_RRSET_VALUE:     (0.7) actual: ${R53_RRSET_VALUE}
                             expect: \"'"'<SESのトークン文字列>'"'\"

ETX

1. 前処理

1.1. 状態確認に必要な情報の取得

Route53ゾーンIDの取得

コマンド:

R53_ZONE_ID=$( \
  aws route53 list-hosted-zones \
    --query "HostedZones[?Name == \`${R53_ZONE_NAME}.\`].Id" \
    --output text \
  | sed 's/\/hostedzone\///' \
) && echo ${R53_ZONE_ID}

結果(例):

Zxxxxxxxxxxxx

1.2. 処理対象の状態確認

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

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

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

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

コマンド:

ls -d ${DIR_CONF}

結果(例):

${HOME}/tmp/conf-route53

事前条件2: Route53ゾーン"<ドメイン名>"が存在している。

「Route53ゾーン"<ドメイン名>"が存在している。」ことを確認します。

コマンド:

aws route53 list-hosted-zones \
  --query "HostedZones[?Name == \`${R53_ZONE_NAME}.\`].Name"

結果(例):

{
  "<ドメイン名>."
}

事前条件3: Route53ゾーン"<ドメイン名>"に、リソースタイプ"TXT"のリソースレコード"_amazonses.<ドメイン名>."が登録されていない。

「Route53ゾーン"<ドメイン名>"に、リソースタイプ"TXT"のリソースレコード"_amazonses.<ドメイン名>."が登録されていない。」ことを確認します。

コマンド:

aws route53 list-resource-record-sets \
  --hosted-zone-id /hostedzone/${R53_ZONE_ID} \
  --query "ResourceRecordSets[?Type == \`${R53_RRSET_TYPE}\` && Name == \`${R53_RRSET_NAME}\`].Name"

結果(例):

[]

事前条件4: リソースタイプ"TXT"のリソースレコード"_amazonses.<ドメイン名>."が名前解決できない。

「リソースタイプ"TXT"のリソースレコード"_amazonses.<ドメイン名>."が名前解決できない。」ことを確認します。

コマンド:

dig ${R53_RRSET_TYPE} ${R53_RRSET_NAME} \
  | grep ${R53_RRSET_TYPE} \
  | grep ${R53_RRSET_NAME} \
  | grep -v '^;'

結果(例):

(出力なし)

1.3. リソースレコードセット設定ファイルの作成

変数の設定:

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

変数の確認:

cat << EOF

  FILE_INPUT:       actual: ${FILE_INPUT}
                    expect: ${HOME}/tmp/conf-route53/2017-10-09-_amazonses.<ドメイン名>.-TXT-CREATE-2017-10-09.json
  R53_RRSET_ACTION: actual: ${R53_RRSET_ACTION}
                    expect: CREATE
  R53_RRSET_TYPE:   actual: ${R53_RRSET_TYPE}
                    expect: TXT
  R53_RRSET_TTL:    actual: ${R53_RRSET_TTL}
                    expect: 300
  R53_RRSET_NAME:   actual: ${R53_RRSET_NAME}
                    expect: _amazonses.<ドメイン名>.
  R53_RRSET_VALUE:  actual: ${R53_RRSET_VALUE}
                    expect: \"'"'<SESのトークン文字列>'"'\"

EOF

コマンド:

cat << EOF > ${FILE_INPUT}
{
  "Changes": [
    {
      "Action": "${R53_RRSET_ACTION}",
      "ResourceRecordSet": {
        "Name": "${R53_RRSET_NAME}",
        "Type": "${R53_RRSET_TYPE}",
        "TTL":  ${R53_RRSET_TTL},
        "ResourceRecords": [
          {
            "Value": "${R53_RRSET_VALUE}"
          }
        ]
      }
    }
  ]
}
EOF

cat ${FILE_INPUT}

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

コマンド:

jsonlint -q ${FILE_INPUT}

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

1.4. 主処理に必要な情報の取得

ファイル名の指定

変数の設定:

FILE_OUTPUT="${DIR_CONF}/$(date +%Y-%m-%d)-${R53_RRSET_NAME}-${R53_RRSET_TYPE}-${R53_RRSET_ACTION}-output.json" \
  && echo ${FILE_OUTPUT}

2. 主処理

リソースレコードセットの変更

変数の設定:

FILE_OUTPUT="${DIR_CONF}/$(date +%Y-%m-%d)-${R53_RRSET_NAME}-${R53_RRSET_TYPE}-${R53_RRSET_ACTION}-output.json" \
  && echo ${FILE_OUTPUT}

変数の確認:

cat << ETX

  R53_ZONE_ID: actual: ${R53_ZONE_ID}
               expect: Zxxxxxxxxxxxx

  FILE_INPUT:  actual: ${FILE_INPUT}
               expect: ${HOME}/tmp/conf-route53/2017-10-09-_amazonses.<ドメイン名>.-TXT-CREATE.json

  FILE_OUTPUT: actual: ${FILE_OUTPUT}
               expect: ${HOME}/tmp/conf-route53/2017-10-09-_amazonses.<ドメイン名>.-TXT-CREATE-output.json

ETX

コマンド:

aws route53 change-resource-record-sets \
  --hosted-zone-id ${R53_ZONE_ID} \
  --change-batch file://${FILE_INPUT} \
  > ${FILE_OUTPUT} \
    && cat ${FILE_OUTPUT}

結果(例):

{
  "ChangeInfo": {
    "Status": "PENDING",
    "SubmittedAt": "2017-10-09T01:23:45.678Z",
    "Id": "/change/C1LBXXXXXXXXXX"
  }
}

3. 後処理

3.1. 主処理の状態確認

Change IDの取得

Change IDを取得します。

コマンド:

R53_CHANGE_ID=$( \
  cat ${FILE_OUTPUT} \
    | jp.py 'ChangeInfo.Id' \
    | sed 's/\"//g' \
) \
  && echo ${R53_CHANGE_ID}

結果(例):

/change/C1LBXXXXXXXXXX

ステータスの確認

ステータスを確認します。

コマンド:

R53_CHANGE_STATUS=$( \
  aws route53 get-change \
    --id ${R53_CHANGE_ID} \
    --query 'ChangeInfo.Status' \
    --output text \
) \
  && echo ${R53_CHANGE_STATUS}

結果(例):

INSYNC

ステータスがINSYNCになれば設定変更が完了しています。

3.2. 完了条件の確認

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

完了条件1: Route53ゾーン"<ドメイン名>"に、リソースタイプ"TXT"のリソースレコード"_amazonses.<ドメイン名>."が登録されている。

「Route53ゾーン"<ドメイン名>"に、リソースタイプ"TXT"のリソースレコード"_amazonses.<ドメイン名>."が登録されている。」ことを確認します。

コマンド:

aws route53 list-resource-record-sets \
  --hosted-zone-id /hostedzone/${R53_ZONE_ID} \
  --query "ResourceRecordSets[?Type == \`${R53_RRSET_TYPE}\` && Name == \`${R53_RRSET_NAME}\`].Name"

結果(例):

{
    "_amazonses.<ドメイン名>."
}

完了条件2: リソースタイプ"TXT"のリソースレコード"_amazonses.<ドメイン名>."が名前解決できる。

「リソースタイプ"TXT"のリソースレコード"_amazonses.<ドメイン名>."が名前解決できる。」ことを確認します。

コマンド:

dig ${R53_RRSET_TYPE} ${R53_RRSET_NAME} \
  | grep ${R53_RRSET_TYPE} \
  | grep ${R53_RRSET_NAME} \
  | grep -v '^;'

結果(例):

_amazonses.<ドメイン名>. 300 IN TXT "<SESのトークン文字列>"

完了