BackupRule
選択したリソースをバックアップするスケジュールタスクを指定します。
内容
- RuleName
-
バックアップルールの表示名。1~50 の英数字または 「-_」 を含める必要があります。。
タイプ: 文字列
Pattern:
^[a-zA-Z0-9\-\_\.]{1,50}$必須: はい
- TargetBackupVaultName
-
バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の AWS リージョンに一意の名前で識別されます。
タイプ: 文字列
Pattern:
^[a-zA-Z0-9\-\_]{2,50}$必須: はい
- CompletionWindowMinutes
-
バックアップジョブが正常に開始されてから完了するまで、またはAWS Backup によってキャンセルされるまでの分単位の値です。この値はオプションです。
型: Long
必須: いいえ
- CopyActions
-
CopyActionオブジェクトの配列で、コピーオペレーションの詳細を含みます。タイプ: CopyAction オブジェクトの配列
必須: いいえ
- EnableContinuousBackup
-
AWS Backup が連続したバックアップを作成するかどうかを指定します。Trueは、AWS Backupを使ってポイントインタイムリソース (PITR) が可能な連続バックアップを作成します。False (または指定なし)は、AWS Backup でスナップショットバックアップを作成します。
型: ブール値
必須: いいえ
- IndexActions
-
IndexActions は、バックアップデータのインデックス作成方法を指定するために使用する配列です。
各 BackupRule は 0 個または 1 個の IndexAction を持つことができます。各バックアップには最大 1 つのインデックスを関連付けることができるためです。
配列内には ResourceType があります。BackupRule ごとに受け入れられるのは 1 つだけです。
タイプ: IndexAction オブジェクトの配列
必須: いいえ
- Lifecycle
-
ライフサイクルにより、保護されたリソースがいつコールドストレージに移行するか、いつ期限切れになるかが定義されます。AWS Backup は、お客様が定義するライフサイクルに従って自動的にバックアップを移行し、期限切れにします。
コールドストレージに移行されたバックアップは、そこに最低 90 日保存される必要があります。したがって、「保持期間」の設定は、「コールドへの移行 (日数)」設定から 90 日以上あける必要があります。バックアップがコールドに移行された後で、「コールドへの移行 (日数)」設定を変更することはできません。
コールドストレージに移行できるリソースタイプは、「リソースごとの機能の可用性」表に記載されています。AWS Backup では、他のリソースタイプに対してこの式は無視されます。
型: Lifecycle オブジェクト
必須: いいえ
- RecoveryPointTags
-
バックアップから復元したときに、このルールに関連付けられているリソースに割り当てられるタグ。
型: 文字列間のマッピング
必須: いいえ
- RuleId
-
選択したリソースのバックアップをスケジュールに入れるために使用されるルールを一意に識別します。
タイプ: 文字列
必須: いいえ
- ScheduleExpression
-
AWS Backup がバックアップジョブを開始するタイミングを指定する UTCのCRON 式です。CRON 式が指定されていない場合、AWS Backup はデフォルトの式
cron(0 5 ? * * *)を使用します。AWS Cron 式の詳細については、「Amazon CloudWatch Events ユーザーガイド」の「Schedule Expressions for Rules」を参照してください。
AWS cron 式の 2 つの例は、
15 * ? * * *(毎時 15 分にバックアップを取る) と0 12 * * ? *(UTC 正午に毎日バックアップを取る) です。例のテーブルについては、前のリンクをクリックし、ページを下にスクロールします。
タイプ: 文字列
必須: いいえ
- ScheduleExpressionTimezone
-
スケジュール式が設定されるタイムゾーン。デフォルトでは、ScheduleExpressions は UTC です。これを、指定したタイムゾーンに変更できます。
タイプ: 文字列
必須: いいえ
- StartWindowMinutes
-
バックアップが予定されてから、ジョブが正常に開始されない場合にキャンセルされるまでの時間を分単位で指定する値です。この値はオプションです。この値を含める場合、エラーを避けるために少なくとも 60 分必要です。
開始ウィンドウ中、バックアップジョブのステータスは、正常に開始されるか、開始ウィンドウの時間がなくなるまで
CREATEDステータスのままになります。開始ウィンドウ内に AWS Backup が、ジョブを再試行できるエラーを受信した場合、AWS Backup は、バックアップが正常に開始されるまで (ジョブのステータスがRUNNINGに変わるまで)、またはジョブのステータスがEXPIRED(開始ウィンドウの時間が過ぎると予想されるスタータス) に変わるまで、少なくとも 10 分おきに自動的にジョブの開始を再試行します。型: Long
必須: いいえ
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。