2.1. オブジェクトのS3バケットへの転送 (handson-cli)¶
作業の目的 [why]¶
オブジェクト(ディレクトリ/ファイル)をS3バケット"handson-cli"に転送します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- S3バケット"handson-cli"に同期対象オブジェクト(ディレクトリ/ファイル)が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- 転送ファイル用ディレクトリ"<S3転送ファイル用ディレクトリ>"が存在する。
- 事前条件2
- S3バケット"handson-cli"が存在する。
作業対象 [what]¶
- S3サービス
標準時間(合計)¶
8分
パラメータ設定¶
パラメータ設定の標準時間: | 2分 |
---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: 転送ファイル用ディレクトリ
転送ファイルを配置したディレクトリ"<S3転送ファイル用ディレクトリ>"です。
リソース2: 転送対象外のファイル/ディレクトリ
- 転送の対象外となるディレクトリやファイルです。
- 今回は"<除外するファイル>"とします。
リソース3: S3バケット名
- ファイルの転送先となるS3バケットの名称です。
- 今回は"handson-cli"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-s3-object_sync-update.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli/2019-04-30-s3-object_sync-update.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.a. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. DIR_S3_TRANSFER:"<S3転送ファイル用ディレクトリ>" DIR_S3_TRANSFER="${DIR_S3_TRANSFER}" # 0.2. S3_SYNC_EXCLUDE:"<除外するファイル>" S3_SYNC_EXCLUDE="${S3_SYNC_EXCLUDE}" # 0.3. S3_BUCKET_NAME:"handson-cli" S3_BUCKET_NAME="${S3_BUCKET_NAME}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
課題
(未検証)
タスク標準時間: | 6分 |
---|
1. 前処理¶
処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: 転送ファイル用ディレクトリ"<S3転送ファイル用ディレクトリ>"が存在する。
「転送ファイル用ディレクトリ"<S3転送ファイル用ディレクトリ>"が存在する。」ことを確認します。
コマンド:
ls -d ${DIR_S3_TRANSFER}
結果(例):
<S3転送ファイル用ディレクトリ>
事前条件2: S3バケット"handson-cli"が存在する。
「S3バケット"handson-cli"が存在する。」ことを確認します。
コマンド:
aws s3api list-buckets \ --query "Buckets[?Name == \`${S3_BUCKET_NAME}\`].Name" \ --output text
結果(例):
handson-cli
2. 主処理¶
コンテンツの同期¶
パラメータの確認:
cat << ETX # DIR_S3_TRANSFER:"<S3転送ファイル用ディレクトリ>" DIR_S3_TRANSFER="${DIR_S3_TRANSFER}" # S3_BUCKET_NAME:"handson-cli" S3_BUCKET_NAME="${S3_BUCKET_NAME}" # S3_SYNC_EXCLUDE:"<除外するファイル>" S3_SYNC_EXCLUDE="${S3_SYNC_EXCLUDE}" ETX
コマンド:
aws s3 sync ${DIR_S3_TRANSFER}/* "s3://${S3_BUCKET_NAME}/" \ --exclude "${S3_SYNC_EXCLUDE}"
結果(例):
upload: index.html to s3://${S3_BUCKET_NAME}/<対象ファイル> (snip)