put-object-lock-configuration

Prev Next

Classic/VPC環境で利用できます。

Ncloud Storageバケットに Object Lock設定を適用します。Object Lockを使用すると、指定した期間中、オブジェクトが削除されたり変更されたりするのを防ぐことができます。

参考

Sub Accountユーザーがこのコマンドを実行するには、Change/PutBucketObjectLockConfigurationアクションの権限が必要です。

構文

put-object-lock-configuration構文は次の通りです。

aws s3api put-object-lock-configuration \
    --bucket <bucket> \
    --object-lock-configuration <object-lock-configuration> \
    [--content-md5 <content-md5>] \
    [--checksum-algorithm <checksum-algorithm>] \
    --endpoint-url <endpoint-url>

オプション

put-object-lock-configurationの実行時に指定できるオプションについて説明します。

必須オプション

put-object-lock-configurationの必須オプションです。

オプション タイプ 必須の有無 説明
--bucket String Required バケット名
--object-lock-configuration String Required Object Lock設定
  • JSON形式で入力
    • ObjectLockEnabled (必須): Object Lockを有効化するか。Enabled
    • Rule.DefaultRetention.Mode (必須): オブジェクトリテンションモード。GOVERNANCE (特別な権限でバイパス可能) | COMPLIANCE (いかなるユーザーもバイパス不可)
    • Rule.DefaultRetention.Days (条件付き): リテンション期間 (日)。1~36500. Rule.DefaultRetention.DaysまたはRule.DefaultRetention.Yearsは必ず入力
    • Rule.DefaultRetention.Years (条件付き): リテンション期間 (年) 1~100。Rule.DefaultRetention.YearsまたはRule.DefaultRetention.Daysは必ず入力

任意オプション

put-object-lock-configurationの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション タイプ 必須の有無 説明
--content-md5 String Optional リクエストデータの Base64エンコードされた128ビット MD5ハッシュ値
  • リクエストデータの整合性検証に使用
  • 未入力の場合、自動計算
--checksum-algorithm String Optional リクエストデータ検証に使用するチェックサムアルゴリズム
  • CRC32 | CRC32C | SHA1 | SHA256 | CRC64NVME

共通オプション

awsコマンドで共通して使用するオプションについては、Ncloud Storageのオプションをご参照ください。

例

Object Lockの設定リクエストが成功すると、設定が適用され、結果は出力されません。

コマンド

コマンドの例は次の通りです。

aws s3api put-object-lock-configuration --bucket my-locked-bucket \
    --object-lock-configuration '{"ObjectLockEnabled":"Enabled","Rule":{"DefaultRetention":{"Mode":"GOVERNANCE","Days":1}}}' \
    --endpoint-url=https://kr.ncloudstorage.com

関連コマンド

関連コマンドは次の通りです。