5.1. EBSスナップショットの作成 (handson-cli-ec2-ebs-snapshot)

手順の目的 [why]

EBSボリュームタグ名"handson-cli-ec2-ebs-volume"のスナップショット(タグ名: handson-cli-ec2-ebs-snapshot)を作成します。

設定値の指定

設定値の指定

手順に必要な設定値を変数に格納をします。

0. リージョンの指定

リージョンを指定します。

環境変数の設定:

export AWS_DEFAULT_REGION='ap-northeast-1'

1. EBSボリュームタグ名

EBSボリュームのタグ名を指定します。

変数の設定:

EC2_VOLUME_TAG_NAME='handson-cli-ec2-ebs-volume'

2: EBSスナップショットタグ名

EBSスナップショットのタグ名を指定します。

変数の設定:

EC2_SNAPSHOT_TAG_NAME='handson-cli-ec2-ebs-snapshot'

3: EBSスナップショットの説明文

EBSスナップショットの説明文を指定します。

変数の設定:

EC2_SNAPSHOT_DESCRIPTION='1st snapshot of handson-cli-ec2-ebs-volume.'

設定値の確認

各変数に正しい設定値が格納されていることを確認しながら保存します。

変数の確認:

cat << END

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

  # 1. EC2_VOLUME_TAG_NAME:"handson-cli-ec2-ebs-volume"
       EC2_VOLUME_TAG_NAME="${EC2_VOLUME_TAG_NAME}"
  # 2. EC2_SNAPSHOT_TAG_NAME:"handson-cli-ec2-ebs-snapshot"
       EC2_SNAPSHOT_TAG_NAME="${EC2_SNAPSHOT_TAG_NAME}"
  # 3. EC2_SNAPSHOT_DESCRIPTION:"1st snapshot of handson-cli-ec2-ebs-volume."
       EC2_SNAPSHOT_DESCRIPTION="${EC2_SNAPSHOT_DESCRIPTION}"

END

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

処理の実行

ボリュームIDを取得します。

コマンド:

EC2_VOLUME_ID=$( \
  aws ec2 describe-volumes \
    --filters Name=tag-key,Values=Name \
              Name=tag-value,Values=${EC2_VOLUME_TAG_NAME} \
    --query 'Volumes[?Tags.Key == Name].VolumeId' \
    --output text
) \
  && echo ${EC2_VOLUME_ID}

結果(例):

vol-xxxxxxxxxxxxxxxxx

タグ設定文字列を生成して変数に格納します。

変数の設定:

EC2_TAG_KEY='Name'

変数の設定:

STRING_TAG_CONF_SNAPSHOT="ResourceType=snapshot,Tags=[{Key=${EC2_TAG_KEY},Value=${EC2_SNAPSHOT_TAG_NAME}}]" \
  && echo ${STRING_TAG_CONF_SNAPSHOT}

結果(例):

ResourceType=snapshot,Tags=[{Key=Name,Value=handson-cli-ec2-ebs-snapshot}]

EBSスナップショットを作成します。

変数の確認:

cat << END

  # EC2_VOLUME_ID:"vol-xxxxxxxxxxxxxxxxx"
    EC2_VOLUME_ID="${EC2_VOLUME_ID}"
  # EC2_SNAPSHOT_DESCRIPTION:"1st snapshot of handson-cli-ec2-ebs-volume."
    EC2_SNAPSHOT_DESCRIPTION="${EC2_SNAPSHOT_DESCRIPTION}"
  # STRING_TAG_CONF_SNAPSHOT:"ResourceType=snapshot,Tags=[{Key=Name,Value=handson-cli-ec2-ebs-snapshot}]"
    STRING_TAG_CONF_SNAPSHOT="${STRING_TAG_CONF_SNAPSHOT}"

END

コマンド:

aws ec2 create-snapshot \
  --description "${EC2_SNAPSHOT_DESCRIPTION}" \
  --volume-id ${EC2_VOLUME_ID} \
  --tag-specifications ${STRING_TAG_CONF_SNAPSHOT}

結果(例):

{
  "Description": "1st snapshot of handson-cli-ec2-ebs-volume.",
  "Encrypted": false,
  "OwnerId": "358597497495",
  "Progress": "",
  "SnapshotId": "snap-xxxxxxxxxxxxxxxxx",
  "StartTime": "2021-09-03T01:23:45.000Z",
  "State": "pending",
  "VolumeId": "vol-xxxxxxxxxxxxxxxxx",
  "VolumeSize": 1,
  "Tags": [
    {
        "Key": "Name",
        "Value": "handson-cli-ec2-ebs-snapshot"
    }
  ]
}

AWS IDを取得します。

コマンド:

AWS_ID=$( \
  aws sts get-caller-identity \
    --query 'Account' \
    --output text \
) \
  && echo ${AWS_ID}

結果(例):

XXXXXXXXXXXX

完了確認

「EBSスナップショットタグ名"handson-cli-ec2-ebs-snapshot"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-snapshots \
  --owner-ids ${AWS_ID} \
  --filters Name=tag-key,Values=Name \
            Name=tag-value,Values=${EC2_SNAPSHOT_TAG_NAME} \
  --query "Snapshots[].Tags[].Value" \
  --output text

結果(例):

handson-cli-ec2-ebs-snapshot

手順の完了