4.2. EIPのアタッチ (handson-cli-ec2-instance)

作業の目的 [why]

EC2インスタンス名"handson-cli-ec2-instance"にEIPタグ名"handson-cli-ec2-address"wをアタッチする。

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

完了条件 [after]

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

完了条件1
EC2インスタンス名"handson-cli-ec2-instance"にEIPタグ名"handson-cli-ec2-address"がアタッチされている。

事前条件 [before]

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

事前条件1
EC2インスタンス名"handson-cli-ec2-instance"が存在する。
事前条件2
EIPタグ名"handson-cli-ec2-address"が存在する。
事前条件3
EIPタグ名"handson-cli-ec2-address"がEC2インスタンスにアタッチされていない。

作業対象 [what]

  • EC2サービス

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: EC2インスタンスのタグ名

  • 作成するEC2インスタンスのタグ名称です。
  • 今回は"handson-cli-ec2-instance"とします。

リソース2: EIPタグ名

  • 取得するEIPのタグ名です。
  • 今回は"handson-cli-ec2-address"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. EC2インスタンス名の指定

EC2インスタンス名を指定します。

変数の設定:

EC2_INSTANCE_TAG_NAME='handson-cli-ec2-instance'

0.2. EIPタグ名の指定

EIPタグ名を指定します。

変数の設定:

EC2_EIP_TAG_NAME='handson-cli-ec2-address'

パラメータの保存

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

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-ec2"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ec2-eip-update-expand-attach.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli-ec2/2019-08-05-ec2-eip-update-expand-attach.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. EC2_INSTANCE_TAG_NAME:"handson-cli-ec2-instance"
         EC2_INSTANCE_TAG_NAME="${EC2_INSTANCE_TAG_NAME}"
  # 0.2. EC2_EIP_TAG_NAME:"handson-cli-ec2-address"
         EC2_EIP_TAG_NAME="${EC2_EIP_TAG_NAME}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

1.1. 処理対象の状態確認

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

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

事前条件1: EC2インスタンス名"handson-cli-ec2-instance"が存在する。

「EC2インスタンス名"handson-cli-ec2-instance"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-instances \
  --filters Name=tag-key,Values=Name \
            Name=tag-value,Values=${EC2_INSTANCE_TAG_NAME} \
            Name=instance-state-name,Values=running \
  --query Reservations[].Instances[].Tags[].Value \
  --output text

結果(例):

handson-cli-ec2-instance

事前条件2: EIPタグ名"handson-cli-ec2-address"が存在する。

「EIPタグ名"handson-cli-ec2-address"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-addresses \
  --filters Name=tag:Name,Values=${EC2_EIP_TAG_NAME} \
  --query "Addresses[].Tags[].Value" \
  --output text

結果(例):

handson-cli-ec2-address

事前条件3: EIPタグ名"handson-cli-ec2-address"がEC2インスタンスにアタッチされていない。

「EIPタグ名"handson-cli-ec2-address"がEC2インスタンスにアタッチされていない。」ことを確認します。

コマンド:

aws ec2 describe-addresses \
  --filters Name=tag:Name,Values=${EC2_EIP_TAG_NAME} \
  --query "Addresses[].InstanceId" \
  --output text

結果(例):

(出力なし)

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

インスタンスIDの取得

コマンド:

EC2_INSTANCE_ID=$( \
  aws ec2 describe-instances \
    --filters Name=tag-key,Values=Name \
              Name=tag-value,Values=${EC2_INSTANCE_TAG_NAME} \
              Name=instance-state-name,Values=running \
    --query Reservations[].Instances[].InstanceId \
    --output text \
) \
  && echo ${EC2_INSTANCE_ID}

結果(例):

i-xxxxxxxxxxxxxxxxx

EIPアロケーションIDの取得

コマンド:

EC2_EIP_ALLOCATION_ID=$( \
  aws ec2 describe-addresses \
    --filters Name=tag:Name,Values=${EC2_EIP_TAG_NAME} \
    --query "Addresses[].AllocationId" \
    --output text \
) \
  && echo ${EC2_EIP_ALLOCATION_ID}

結果(例):

eipalloc-xxxxxxxx

2. 主処理

EC2インスタンスへのEIPのアタッチ

変数の確認:

cat << ETX

  EC2_EIP_ALLOCATION_ID: ${EC2_EIP_ALLOCATION_ID}
  EC2_INSTANCE_ID:  ${EC2_INSTANCE_ID}

ETX

コマンド:

aws ec2 associate-address \
  --allocation-id ${EC2_EIP_ALLOCATION_ID} \
  --instance-id ${EC2_INSTANCE_ID}

結果(例):

{
  "AssociationId": "eipassoc-xxxxxxxx"
}

3. 後処理

完了条件の確認

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

完了条件1: EC2インスタンス名"handson-cli-ec2-instance"にEIPタグ名"handson-cli-ec2-address"がアタッチされている。

「EC2インスタンス名"handson-cli-ec2-instance"にEIPタグ名"handson-cli-ec2-address"がアタッチされている。」ことを確認します。

コマンド:

aws ec2 describe-addresses \
  --filters Name=tag:Name,Values=${EC2_EIP_TAG_NAME} \
  --query "Addresses[].InstanceId" \
  --output text

結果(例):

i-xxxxxxxxxxxxxxxxx

完了