7.2. Lightsailドメインエントリの追加 (MXレコード: handson-cli-lightsail.example.jp)

作業の目的 [why]

Lightsailドメイン"handson-cli-lightsail.example.jp"に、リソースタイプ"MX"、リソース値"40 mx01.handson-cli-lightsail.example.jp"のリソースレコード"handson-cli-lightsail.example.jp"を作成します。

完了条件/事前条件 [設計者用情報]

完了条件 [after]

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

完了条件1

Lightsailドメイン"handson-cli-lightsail.example.jp"にリソースタイプ"MX"、リソース値が"40 mx01.handson-cli-lightsail.example.jp"のリソースレコード"handson-cli-lightsail.example.jp"が存在する。

事前条件 [before]

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

事前条件1

Lightsailドメイン"handson-cli-lightsail.example.jp"が存在する。

事前条件2

Lightsailドメイン"handson-cli-lightsail.example.jp"にリソースタイプ"MX"、リソース値が"40 mx01.handson-cli-lightsail.example.jp"のリソースレコード"handson-cli-lightsail.example.jp"が存在しない。

作業対象 [what]

  • Lightsailサービス

標準時間(合計)

8分

パラメータ設定

パラメータ設定の標準時間

2分

作業に必要なモノ・情報 [resource]

作業開始には、以下が全て揃っていることが必要です。

リソース1: Lightsailドメイン名

  • ドメインエントリを作成するLightsailドメインの名称です。

  • 今回は、事前に用意した独自ドメインを利用します。

リソース2: Lightsailドメインエントリ名の指定

  • 作成するドメインエントリの名称です。

  • 今回は"handson-cli-lightsail.example.jp"とします。

リソース3: Lightsailドメインエントリタイプの指定

  • 作成するドメインエントリのタイプです。

  • 今回は"MX"とします。

リソース4: MX優先度

  • 作成するドメインエントリのMX優先度です。

  • 今回は"40"とします。

リソース5: MXホスト名

  • 作成するドメインエントリのMXホスト名です。

  • 今回は"mx01.handson-cli-lightsail.example.jp"とします。

パラメータの指定

作業に必要なパラメータを変数に格納をします。

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. Lightsailドメイン名の指定

Lightsailドメイン名を指定します。

変数の設定:

DIR_TMP="${HOME}/environment/tmp-handson-cli-lightsail"

変数の設定:

FILE_TMP="${DIR_TMP}/sub_domain.tmp" \
  && echo ${FILE_TMP}

結果(例):

${HOME}/environment/tmp-handson-cli-lightsail/sub_domain.tmp

コマンド:

source ${FILE_TMP}

変数の設定:

LIGHTSAIL_DOMAIN_NAME="${DOMAIN_SUB_FULLNAME}" \
  && echo ${LIGHTSAIL_DOMAIN_NAME}

結果(例):

handson-cli-lightsail.example.jp

0.2. Lightsailドメインエントリ名の指定

Lightsailドメインエントリ名を指定します。

変数の設定:

LIGHTSAIL_DOMAIN_ENTRY_NAME="${LIGHTSAIL_DOMAIN_NAME}" \
  && echo ${LIGHTSAIL_DOMAIN_ENTRY_NAME}

結果(例):

handson-cli-lightsail.example.jp

0.3. Lightsailドメインエントリタイプの指定

Lightsailドメインエントリタイプを指定します。

変数の設定:

LIGHTSAIL_DOMAIN_ENTRY_TYPE="MX"

0.4. MX優先度の指定

MXホストの優先度を指定します。

変数の設定:

MX_PREFERENCE="40"

0.5. MXホストの指定

変数の設定:

HOST_NAME='mx01'

変数の設定:

MX_HOST_NAME="${HOST_NAME}.${LIGHTSAIL_DOMAIN_NAME}" \
  && echo ${MX_HOST_NAME}

結果(例):

mx01.handson-cli-lightsail.example.jp

パラメータの保存

設定されている変数の保存先となるファイル名を指定します。

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-lightsail"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-lightsail-domain_entry-create-expand-mx.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli-lightsail/2020-02-10-lightsail-domain_entry-create-expand-mx.env

各変数に正しいパラメータ値が格納されていることを確認しながら保存します。

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1. LIGHTSAIL_DOMAIN_NAME:"handson-cli-lightsail.example.jp"
         LIGHTSAIL_DOMAIN_NAME="${LIGHTSAIL_DOMAIN_NAME}"
  # 0.2. LIGHTSAIL_DOMAIN_ENTRY_NAME:"handson-cli-lightsail.example.jp"
         LIGHTSAIL_DOMAIN_ENTRY_NAME="${LIGHTSAIL_DOMAIN_ENTRY_NAME}"
  # 0.3. LIGHTSAIL_DOMAIN_ENTRY_TYPE:"MX"
         LIGHTSAIL_DOMAIN_ENTRY_TYPE="${LIGHTSAIL_DOMAIN_ENTRY_TYPE}"
  # 0.4. MX_PREFERENCE:"40"
         MX_PREFERENCE="${MX_PREFERENCE}"
  # 0.5. MX_HOST_NAME:"mx01.handson-cli-lightsail.example.jp"
         MX_HOST_NAME="${MX_HOST_NAME}"

EOF

cat ${FILE_PARAMETER}

下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。

タスクの実施

タスク標準時間

6分

1. 前処理

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

MXレコード値の生成

変数の設定:

LIGHTSAIL_DOMAIN_ENTRY_TARGET="${MX_PREFERENCE} ${MX_HOST_NAME}" \
  && echo ${LIGHTSAIL_DOMAIN_ENTRY_TARGET}

結果(例):

40 mx01.handson-cli-lightsail.example.jp

1.2. 処理対象の状態確認

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

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

事前条件1: Lightsailドメイン"handson-cli-lightsail.example.jp"が存在する。

「Lightsailドメイン"handson-cli-lightsail.example.jp"が存在する。」ことを確認します。

コマンド:

aws lightsail get-domains \
  --region us-east-1 \
  --query "domains[?name == \`${LIGHTSAIL_DOMAIN_NAME}\`].name" \
  --output text

結果(例):

handson-cli-lightsail.example.jp

事前条件2: Lightsailドメイン"handson-cli-lightsail.example.jp"にリソースタイプ"MX"、リソース値が"40 mx01.handson-cli-lightsail.example.jp"のリソースレコード"handson-cli-lightsail.example.jp"が存在しない。

「Lightsailドメイン"handson-cli-lightsail.example.jp"にリソースタイプ"MX"、リソース値が"40 mx01.handson-cli-lightsail.example.jp"のリソースレコード"handson-cli-lightsail.example.jp"が存在しない。」ことを確認します。

コマンド:

aws lightsail get-domains \
  --region us-east-1 \
  --query "domains[?name == \`${LIGHTSAIL_DOMAIN_NAME}\` ].domainEntries[] \
    | [? \
      name == \`${LIGHTSAIL_DOMAIN_ENTRY_NAME}\` \
        && type == \`${LIGHTSAIL_DOMAIN_ENTRY_TYPE}\` \
        && target == \`${LIGHTSAIL_DOMAIN_ENTRY_TARGET}\` \
    ].name" \
  --output text

結果(例):

(出力なし)

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

ドメインエントリ文字列の生成

変数の設定:

STRING_LIGHTSAIL_DOMAIN_ENTRY="name=${LIGHTSAIL_DOMAIN_ENTRY_NAME},type=${LIGHTSAIL_DOMAIN_ENTRY_TYPE},target=${LIGHTSAIL_DOMAIN_ENTRY_TARGET}" \
  && echo ${STRING_LIGHTSAIL_DOMAIN_ENTRY}

結果(例):

name=handson-cli-lightsail.example.jp,type=MX,target=40 mx01.handson-cli-lightsail.example.jp

2. 主処理

LightsailドメインにMXレコードを作成

変数の確認:

cat << ETX

  # LIGHTSAIL_DOMAIN_NAME:"handson-cli-lightsail.example.jp"
    LIGHTSAIL_DOMAIN_NAME="${LIGHTSAIL_DOMAIN_NAME}"
  # STRING_LIGHTSAIL_DOMAIN_ENTRY:"name=handson-cli-lightsail.example.jp,type=MX,target=40 mx01.handson-cli-lightsail.example.jp"
    STRING_LIGHTSAIL_DOMAIN_ENTRY="${STRING_LIGHTSAIL_DOMAIN_ENTRY}"

ETX

コマンド:

aws lightsail create-domain-entry \
  --region us-east-1 \
  --domain-name ${LIGHTSAIL_DOMAIN_NAME} \
  --domain-entry "${STRING_LIGHTSAIL_DOMAIN_ENTRY}"

結果(例):

{
  "operation": {
    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "resourceName": "handson-cli-lightsail.example.jp",
    "resourceType": "Domain",
    "createdAt": 1234567890.123,
    "location": {
      "availabilityZone": "all",
      "regionName": "global"
    },
    "isTerminal": true,
    "operationType": "CreateDomainEntry",
    "status": "Succeeded",
    "statusChangedAt": 1234567890.123
  }
}

3. 後処理

完了条件の確認

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

完了条件1: Lightsailドメイン"handson-cli-lightsail.example.jp"にリソースタイプ"MX"、リソース値が"40 mx01.handson-cli-lightsail.example.jp"のリソースレコード"handson-cli-lightsail.example.jp"が存在する。

「Lightsailドメイン"handson-cli-lightsail.example.jp"にリソースタイプ"MX"、リソース値が"40 mx01.handson-cli-lightsail.example.jp"のリソースレコード"handson-cli-lightsail.example.jp"が存在する。」ことを確認します。

コマンド:

aws lightsail get-domains \
  --region us-east-1 \
  --query "domains[?name == \`${LIGHTSAIL_DOMAIN_NAME}\` ].domainEntries[] \
    | [? \
      name == \`${LIGHTSAIL_DOMAIN_ENTRY_NAME}\` \
        && type == \`${LIGHTSAIL_DOMAIN_ENTRY_TYPE}\` \
        && target == \`${LIGHTSAIL_DOMAIN_ENTRY_TARGET}\` \
    ].name" \
  --output text

結果(例):

handson-cli-lightsail.example.jp

完了