3. S3オブジェクトのアップロード (handson-cli-source-XXXXXXXXXXXX)

作業の目的 [why]

S3バケット"handson-cli-source-XXXXXXXXXXXX"にファイルをアップロードします。

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

完了条件 [after]

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

完了条件1
S3バケット"handson-cli-source-XXXXXXXXXXXX"にオブジェクト"handson-cli.zip"が存在する。

事前条件 [before]

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

事前条件1
転送対象ファイル用ディレクトリ"${HOME}/tmp/conf-handson-cli"が存在する。
事前条件2
転送対象ファイル用ディレクトリ"${HOME}/tmp/conf-handson-cli"に転送対象ファイル"${HOME}/tmp/conf-handson-cli/handson-cli.zip"が存在する。
事前条件3
S3バケット"handson-cli-source-XXXXXXXXXXXX"が存在する。
事前条件4
S3バケット"handson-cli-source-XXXXXXXXXXXX"にオブジェクト"handson-cli.zip"が存在しない。

作業対象 [what]

  • S3サービス

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: 転送ファイル用ディレクトリ

転送対象ファイルが存在するディレクトリ"${HOME}/tmp/conf-handson-cli"です。

リソース2: 転送対象ファイル

  • 転送対象となるファイルです。
  • 今回は"${HOME}/tmp/conf-handson-cli/handson-cli.zip"とします。

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

  • ファイルの転送先となるS3バケットの名称です。
  • 今回は"handson-cli-source-XXXXXXXXXXXX"とします。

リソース4: S3オブジェクト名

  • ファイルの転送先でのオブジェクト名(パス + ファイル名)です。
  • 今回は"handson-cli.zip"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. 転送ファイル用ディレクトリの指定

変数の設定:

DIR_TARGET="${HOME}/tmp/conf-handson-cli"

0.2. 転送対象ファイルの指定

変数の設定:

FILE_TARGET="${DIR_TARGET}/handson-cli.zip" \
  && echo ${FILE_TARGET}

結果(例):

${HOME}/tmp/conf-handson-cli/handson-cli.zip

0.3. S3バケット名の指定

変数の設定:

S3_BUCKET_PREFIX='handson-cli-source'

コマンド:

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

結果(例):

XXXXXXXXXXXX

変数の設定:

S3_BUCKET_NAME="${S3_BUCKET_PREFIX}-${AWS_ID}" \
  && echo ${S3_BUCKET_NAME}

結果(例):

handson-cli-source-XXXXXXXXXXXX

0.4. S3オブジェクト名の指定

S3オブジェクト名を指定します。

変数の設定:

S3_OBJECT_NAME='handson-cli.zip'

パラメータの保存

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

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-s3-object-create-expand-bucket-prefix-awsid.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-s3-object-create-expand-bucket-prefix-awsid.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. DIR_TARGET:"${HOME}/tmp/conf-handson-cli"
         DIR_TARGET="${DIR_TARGET}"
  # 0.2. FILE_TARGET:"${HOME}/tmp/conf-handson-cli/handson-cli.zip"
         FILE_TARGET="${FILE_TARGET}"
  # 0.3. S3_BUCKET_NAME:"handson-cli-source-XXXXXXXXXXXX"
         S3_BUCKET_NAME="${S3_BUCKET_NAME}"
  # 0.4. S3_OBJECT_NAME:"handson-cli.zip"
         S3_OBJECT_NAME="${S3_OBJECT_NAME}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

処理対象の状態確認

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

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

事前条件1: 転送対象ファイル用ディレクトリ"${HOME}/tmp/conf-handson-cli"が存在する。

「転送対象ファイル用ディレクトリ"${HOME}/tmp/conf-handson-cli"が存在する。」ことを確認します。

コマンド:

ls -d ${DIR_TARGET}

結果(例):

${HOME}/tmp/conf-handson-cli

事前条件2: 転送対象ファイル用ディレクトリ"${HOME}/tmp/conf-handson-cli"に転送対象ファイル"${HOME}/tmp/conf-handson-cli/handson-cli.zip"が存在する。

「転送対象ファイル用ディレクトリ"${HOME}/tmp/conf-handson-cli"に転送対象ファイル"${HOME}/tmp/conf-handson-cli/handson-cli.zip"が存在する。」ことを確認します。

コマンド:

ls ${FILE_TARGET}

結果(例):

${HOME}/tmp/conf-handson-cli/handson-cli.zip

事前条件3: S3バケット"handson-cli-source-XXXXXXXXXXXX"が存在する。

「S3バケット"handson-cli-source-XXXXXXXXXXXX"が存在する。」ことを確認します。

コマンド:

aws s3api list-buckets \
  --query "Buckets[?Name == \`${S3_BUCKET_NAME}\`].Name" \
  --output text

結果(例):

handson-cli-source-XXXXXXXXXXXX

事前条件4: S3バケット"handson-cli-source-XXXXXXXXXXXX"にオブジェクト"handson-cli.zip"が存在しない。

「S3バケット"handson-cli-source-XXXXXXXXXXXX"にオブジェクト"handson-cli.zip"が存在しない。」ことを確認します。

コマンド:

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

結果(例):

(出力なし)

2. 主処理

S3バケットへのファイル転送

コマンド:

aws s3 cp ${FILE_TARGET} s3://${S3_BUCKET_NAME}/${S3_OBJECT_NAME}

結果(例):

upload: ${HOME}/tmp/conf-handson-cli/handson-cli.zip to s3://handson-cli-source-XXXXXXXXXXXX/handson-cli.zip

3. 後処理

完了条件の確認

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

完了条件1: S3バケット"handson-cli-source-XXXXXXXXXXXX"にオブジェクト"handson-cli.zip"が存在する。

「S3バケット"handson-cli-source-XXXXXXXXXXXX"にオブジェクト"handson-cli.zip"が存在する。」ことを確認します。

コマンド:

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

結果(例):

2019-04-30 01:23:45 xxxxxxxx handson-cli-source-XXXXXXXXXXXX/handson-cli.zip

完了