PutBackupVaultLockConfiguration - AWS Backup
リクエストの構文URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラーその他の参照資料

PutBackupVaultLockConfiguration

AWS Backup Vault Lock をバックアップボールトに適用し、バックアップボールトに保存されている、またはそれに作成されたリカバリポイントを削除できないようにします。また、Vault Lock では、バックアップボールトに現在保存されているリカバリポイントの保持期間を制御するライフサイクルポリシーの更新も防止されます。指定した場合、Vault Lock は、バックアップボールトを対象とする将来のバックアップジョブおよびコピージョブに対して、最小および最大保持期間を適用します。

注記

AWS Backup ボールトロックは、SEC 17a-4、CFTC、および FINRA の各規制に従った環境での使用について、Cohasset Associates によって評価済みです。AWS Backup ボールトロックがこれらの規制にどのように関係しているかの詳細については、「Cohasset Associates コンプライアンス評価」を参照してください。

詳細については、「AWS Backup ボールトロック」を参照してください。

リクエストの構文

PUT /backup-vaults/backupVaultName/vault-lock HTTP/1.1
Content-type: application/json

{
   "ChangeableForDays": number,
   "MaxRetentionDays": number,
   "MinRetentionDays": number
}

URI リクエストパラメータ

リクエストでは、次の URI パラメータを使用します。

backupVaultName

保護されるバックアップボールトの名前を指定する AWS Backup Vault Lock。

Pattern: ^[a-zA-Z0-9\-\_]{2,50}$

必須: はい

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

ChangeableForDays

AWS Backup ロック日の前の日数を指定する Vault Lock 設定。たとえば、ChangeableForDays 2022年1月1日午後8時30分にUTCへの設定は、2022年1月31日午後8時 UTC にロック日を設定します。

AWS Backup Vault Lock が有効になり、不変になる前に 72 時間のクーリングオフ期間を適用します。したがって、ChangeableForDays を 3 以上に設定する必要があります。

ロック日より前には、DeleteBackupVaultLockConfiguration を使用して ボールトロックをボールトから削除でき、また、PutBackupVaultLockConfiguration を使用してボールトロックの構成を変更します。ロック日以降では、ボールトロックは不変になり、変更や削除はできません。

このパラメータを指定しない場合は、DeleteBackupVaultLockConfiguration を使用してボールトからボールトロックを削除でき、または、PutBackupVaultLockConfiguration を使用して、いつでもボールトロックの設定を変更できます。

型: Long

必須：いいえ

MaxRetentionDays

AWS Backupボールトがリカバリポイントを保持する最大保持期間を指定するボールトロック構成。この設定は、たとえば、組織のポリシーで 4 年間（1460 日）保持した後に特定のデータを破棄する必要がある場合などに便利です。

このパラメータを指定しない場合、ボールトロックはボールト内のリカバリポイントに最大保持期間を強制しません。このパラメータが値なしで含まれている場合、ボールトロックは最大保持期間を適用しません。

このパラメータを指定した場合、ボールトへのバックアップジョブまたはコピージョブには、保存期間が最大保存期間以下のライフサイクル・ポリシーを持つ必要があります。ジョブの保持期間がその最大保存期間よりも長い場合、ボールトはバックアップジョブまたはコピージョブに失敗するため、ライフサイクル設定を変更するか、別のボールトを使用する必要があります。指定できる最長の最大保持期間は 36500 日 (約 100 年) です。ボールトロックの前にボールトにすでに保存されている復旧ポイントは影響を受けません。

型: Long

必須：いいえ

MinRetentionDays

AWS Backup ボールトがリカバリポイントを保持する最小保存期間を指定するボールトロック構成。この設定は、たとえば、組織のポリシーで特定のデータを少なくとも 7 年間（2555 日）保持する必要がある場合に便利です。

このパラメータは、AWS CloudFormation を通じてボールトロックを作成するときに必須です。それ以外の場合は、このパラメータはオプションです。このパラメータを指定しない場合、ボールトロックは最小保持期間を強制しません。

このパラメータを指定した場合、ボールトへのバックアップジョブまたはコピージョブには、最小保存期間以上の保存期間を持つライフサイクルポリシーが必要です。ジョブの保持期間がその最小保存期間よりも短い場合、ボールトはそのバックアップジョブまたはコピージョブに失敗するため、ライフサイクル設定を変更するか、別のボールトを使用する必要があります。指定できる最小保持期間は 1 日です。ボールトロックの前にボールトにすでに保存されている復旧ポイントは影響を受けません。

型: Long

必須：いいえ

レスポンスの構文

HTTP/1.1 200

レスポンス要素

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

InvalidParameterValueException

パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。

HTTP ステータスコード：400

InvalidRequestException

リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。

HTTP ステータスコード：400

MissingParameterValueException

必須パラメータがないことを示します。

HTTP ステータスコード：400

ResourceNotFoundException

アクションに必要なリソースは存在しません。

HTTP ステータスコード：400

ServiceUnavailableException

サーバーの一時的障害のため、リクエストは失敗しました。

HTTP ステータスコード：500

その他の参照資料

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。