/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Specifies a scheduled task used to back up a selection of
* resources.See Also:
AWS
* API Reference
A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' * characters.
*/ inline const Aws::String& GetRuleName() const{ return m_ruleName; } /** *A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' * characters.
*/ inline bool RuleNameHasBeenSet() const { return m_ruleNameHasBeenSet; } /** *A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' * characters.
*/ inline void SetRuleName(const Aws::String& value) { m_ruleNameHasBeenSet = true; m_ruleName = value; } /** *A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' * characters.
*/ inline void SetRuleName(Aws::String&& value) { m_ruleNameHasBeenSet = true; m_ruleName = std::move(value); } /** *A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' * characters.
*/ inline void SetRuleName(const char* value) { m_ruleNameHasBeenSet = true; m_ruleName.assign(value); } /** *A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' * characters.
*/ inline BackupRule& WithRuleName(const Aws::String& value) { SetRuleName(value); return *this;} /** *A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' * characters.
*/ inline BackupRule& WithRuleName(Aws::String&& value) { SetRuleName(std::move(value)); return *this;} /** *A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' * characters.
*/ inline BackupRule& WithRuleName(const char* value) { SetRuleName(value); return *this;} /** *The name of a logical container where backups are stored. Backup vaults are * identified by names that are unique to the account used to create them and the * Amazon Web Services Region where they are created. They consist of lowercase * letters, numbers, and hyphens.
*/ inline const Aws::String& GetTargetBackupVaultName() const{ return m_targetBackupVaultName; } /** *The name of a logical container where backups are stored. Backup vaults are * identified by names that are unique to the account used to create them and the * Amazon Web Services Region where they are created. They consist of lowercase * letters, numbers, and hyphens.
*/ inline bool TargetBackupVaultNameHasBeenSet() const { return m_targetBackupVaultNameHasBeenSet; } /** *The name of a logical container where backups are stored. Backup vaults are * identified by names that are unique to the account used to create them and the * Amazon Web Services Region where they are created. They consist of lowercase * letters, numbers, and hyphens.
*/ inline void SetTargetBackupVaultName(const Aws::String& value) { m_targetBackupVaultNameHasBeenSet = true; m_targetBackupVaultName = value; } /** *The name of a logical container where backups are stored. Backup vaults are * identified by names that are unique to the account used to create them and the * Amazon Web Services Region where they are created. They consist of lowercase * letters, numbers, and hyphens.
*/ inline void SetTargetBackupVaultName(Aws::String&& value) { m_targetBackupVaultNameHasBeenSet = true; m_targetBackupVaultName = std::move(value); } /** *The name of a logical container where backups are stored. Backup vaults are * identified by names that are unique to the account used to create them and the * Amazon Web Services Region where they are created. They consist of lowercase * letters, numbers, and hyphens.
*/ inline void SetTargetBackupVaultName(const char* value) { m_targetBackupVaultNameHasBeenSet = true; m_targetBackupVaultName.assign(value); } /** *The name of a logical container where backups are stored. Backup vaults are * identified by names that are unique to the account used to create them and the * Amazon Web Services Region where they are created. They consist of lowercase * letters, numbers, and hyphens.
*/ inline BackupRule& WithTargetBackupVaultName(const Aws::String& value) { SetTargetBackupVaultName(value); return *this;} /** *The name of a logical container where backups are stored. Backup vaults are * identified by names that are unique to the account used to create them and the * Amazon Web Services Region where they are created. They consist of lowercase * letters, numbers, and hyphens.
*/ inline BackupRule& WithTargetBackupVaultName(Aws::String&& value) { SetTargetBackupVaultName(std::move(value)); return *this;} /** *The name of a logical container where backups are stored. Backup vaults are * identified by names that are unique to the account used to create them and the * Amazon Web Services Region where they are created. They consist of lowercase * letters, numbers, and hyphens.
*/ inline BackupRule& WithTargetBackupVaultName(const char* value) { SetTargetBackupVaultName(value); return *this;} /** *A cron expression in UTC specifying when Backup initiates a backup job. For
* more information about Amazon Web Services cron expressions, see Schedule
* Expressions for Rules in the Amazon CloudWatch Events User Guide..
* Two examples of Amazon Web Services cron expressions are 15 * ? * *
* *
(take a backup every hour at 15 minutes past the hour) and 0 12 *
* * ? *
(take a backup every day at 12 noon UTC). For a table of examples,
* click the preceding link and scroll down the page.
A cron expression in UTC specifying when Backup initiates a backup job. For
* more information about Amazon Web Services cron expressions, see Schedule
* Expressions for Rules in the Amazon CloudWatch Events User Guide..
* Two examples of Amazon Web Services cron expressions are 15 * ? * *
* *
(take a backup every hour at 15 minutes past the hour) and 0 12 *
* * ? *
(take a backup every day at 12 noon UTC). For a table of examples,
* click the preceding link and scroll down the page.
A cron expression in UTC specifying when Backup initiates a backup job. For
* more information about Amazon Web Services cron expressions, see Schedule
* Expressions for Rules in the Amazon CloudWatch Events User Guide..
* Two examples of Amazon Web Services cron expressions are 15 * ? * *
* *
(take a backup every hour at 15 minutes past the hour) and 0 12 *
* * ? *
(take a backup every day at 12 noon UTC). For a table of examples,
* click the preceding link and scroll down the page.
A cron expression in UTC specifying when Backup initiates a backup job. For
* more information about Amazon Web Services cron expressions, see Schedule
* Expressions for Rules in the Amazon CloudWatch Events User Guide..
* Two examples of Amazon Web Services cron expressions are 15 * ? * *
* *
(take a backup every hour at 15 minutes past the hour) and 0 12 *
* * ? *
(take a backup every day at 12 noon UTC). For a table of examples,
* click the preceding link and scroll down the page.
A cron expression in UTC specifying when Backup initiates a backup job. For
* more information about Amazon Web Services cron expressions, see Schedule
* Expressions for Rules in the Amazon CloudWatch Events User Guide..
* Two examples of Amazon Web Services cron expressions are 15 * ? * *
* *
(take a backup every hour at 15 minutes past the hour) and 0 12 *
* * ? *
(take a backup every day at 12 noon UTC). For a table of examples,
* click the preceding link and scroll down the page.
A cron expression in UTC specifying when Backup initiates a backup job. For
* more information about Amazon Web Services cron expressions, see Schedule
* Expressions for Rules in the Amazon CloudWatch Events User Guide..
* Two examples of Amazon Web Services cron expressions are 15 * ? * *
* *
(take a backup every hour at 15 minutes past the hour) and 0 12 *
* * ? *
(take a backup every day at 12 noon UTC). For a table of examples,
* click the preceding link and scroll down the page.
A cron expression in UTC specifying when Backup initiates a backup job. For
* more information about Amazon Web Services cron expressions, see Schedule
* Expressions for Rules in the Amazon CloudWatch Events User Guide..
* Two examples of Amazon Web Services cron expressions are 15 * ? * *
* *
(take a backup every hour at 15 minutes past the hour) and 0 12 *
* * ? *
(take a backup every day at 12 noon UTC). For a table of examples,
* click the preceding link and scroll down the page.
A cron expression in UTC specifying when Backup initiates a backup job. For
* more information about Amazon Web Services cron expressions, see Schedule
* Expressions for Rules in the Amazon CloudWatch Events User Guide..
* Two examples of Amazon Web Services cron expressions are 15 * ? * *
* *
(take a backup every hour at 15 minutes past the hour) and 0 12 *
* * ? *
(take a backup every day at 12 noon UTC). For a table of examples,
* click the preceding link and scroll down the page.
A value in minutes after a backup is scheduled before a job will be canceled * if it doesn't start successfully. This value is optional. If this value is * included, it must be at least 60 minutes to avoid errors.
During the
* start window, the backup job status remains in CREATED
status until
* it has successfully begun or until the start window time has run out. If within
* the start window time Backup receives an error that allows the job to be
* retried, Backup will automatically retry to begin the job at least every 10
* minutes until the backup successfully begins (the job status changes to
* RUNNING
) or until the job status changes to EXPIRED
* (which is expected to occur when the start window time is over).
A value in minutes after a backup is scheduled before a job will be canceled * if it doesn't start successfully. This value is optional. If this value is * included, it must be at least 60 minutes to avoid errors.
During the
* start window, the backup job status remains in CREATED
status until
* it has successfully begun or until the start window time has run out. If within
* the start window time Backup receives an error that allows the job to be
* retried, Backup will automatically retry to begin the job at least every 10
* minutes until the backup successfully begins (the job status changes to
* RUNNING
) or until the job status changes to EXPIRED
* (which is expected to occur when the start window time is over).
A value in minutes after a backup is scheduled before a job will be canceled * if it doesn't start successfully. This value is optional. If this value is * included, it must be at least 60 minutes to avoid errors.
During the
* start window, the backup job status remains in CREATED
status until
* it has successfully begun or until the start window time has run out. If within
* the start window time Backup receives an error that allows the job to be
* retried, Backup will automatically retry to begin the job at least every 10
* minutes until the backup successfully begins (the job status changes to
* RUNNING
) or until the job status changes to EXPIRED
* (which is expected to occur when the start window time is over).
A value in minutes after a backup is scheduled before a job will be canceled * if it doesn't start successfully. This value is optional. If this value is * included, it must be at least 60 minutes to avoid errors.
During the
* start window, the backup job status remains in CREATED
status until
* it has successfully begun or until the start window time has run out. If within
* the start window time Backup receives an error that allows the job to be
* retried, Backup will automatically retry to begin the job at least every 10
* minutes until the backup successfully begins (the job status changes to
* RUNNING
) or until the job status changes to EXPIRED
* (which is expected to occur when the start window time is over).
A value in minutes after a backup job is successfully started before it must * be completed or it will be canceled by Backup. This value is optional.
*/ inline long long GetCompletionWindowMinutes() const{ return m_completionWindowMinutes; } /** *A value in minutes after a backup job is successfully started before it must * be completed or it will be canceled by Backup. This value is optional.
*/ inline bool CompletionWindowMinutesHasBeenSet() const { return m_completionWindowMinutesHasBeenSet; } /** *A value in minutes after a backup job is successfully started before it must * be completed or it will be canceled by Backup. This value is optional.
*/ inline void SetCompletionWindowMinutes(long long value) { m_completionWindowMinutesHasBeenSet = true; m_completionWindowMinutes = value; } /** *A value in minutes after a backup job is successfully started before it must * be completed or it will be canceled by Backup. This value is optional.
*/ inline BackupRule& WithCompletionWindowMinutes(long long value) { SetCompletionWindowMinutes(value); return *this;} /** *The lifecycle defines when a protected resource is transitioned to cold * storage and when it expires. Backup transitions and expires backups * automatically according to the lifecycle that you define.
Backups * transitioned to cold storage must be stored in cold storage for a minimum of 90 * days. Therefore, the “retention” setting must be 90 days greater than the * “transition to cold after days” setting. The “transition to cold after days” * setting cannot be changed after a backup has been transitioned to cold.
*Resource types that are able to be transitioned to cold storage are listed in * the "Lifecycle to cold storage" section of the * Feature availability by resource table. Backup ignores this expression for * other resource types.
*/ inline const Lifecycle& GetLifecycle() const{ return m_lifecycle; } /** *The lifecycle defines when a protected resource is transitioned to cold * storage and when it expires. Backup transitions and expires backups * automatically according to the lifecycle that you define.
Backups * transitioned to cold storage must be stored in cold storage for a minimum of 90 * days. Therefore, the “retention” setting must be 90 days greater than the * “transition to cold after days” setting. The “transition to cold after days” * setting cannot be changed after a backup has been transitioned to cold.
*Resource types that are able to be transitioned to cold storage are listed in * the "Lifecycle to cold storage" section of the * Feature availability by resource table. Backup ignores this expression for * other resource types.
*/ inline bool LifecycleHasBeenSet() const { return m_lifecycleHasBeenSet; } /** *The lifecycle defines when a protected resource is transitioned to cold * storage and when it expires. Backup transitions and expires backups * automatically according to the lifecycle that you define.
Backups * transitioned to cold storage must be stored in cold storage for a minimum of 90 * days. Therefore, the “retention” setting must be 90 days greater than the * “transition to cold after days” setting. The “transition to cold after days” * setting cannot be changed after a backup has been transitioned to cold.
*Resource types that are able to be transitioned to cold storage are listed in * the "Lifecycle to cold storage" section of the * Feature availability by resource table. Backup ignores this expression for * other resource types.
*/ inline void SetLifecycle(const Lifecycle& value) { m_lifecycleHasBeenSet = true; m_lifecycle = value; } /** *The lifecycle defines when a protected resource is transitioned to cold * storage and when it expires. Backup transitions and expires backups * automatically according to the lifecycle that you define.
Backups * transitioned to cold storage must be stored in cold storage for a minimum of 90 * days. Therefore, the “retention” setting must be 90 days greater than the * “transition to cold after days” setting. The “transition to cold after days” * setting cannot be changed after a backup has been transitioned to cold.
*Resource types that are able to be transitioned to cold storage are listed in * the "Lifecycle to cold storage" section of the * Feature availability by resource table. Backup ignores this expression for * other resource types.
*/ inline void SetLifecycle(Lifecycle&& value) { m_lifecycleHasBeenSet = true; m_lifecycle = std::move(value); } /** *The lifecycle defines when a protected resource is transitioned to cold * storage and when it expires. Backup transitions and expires backups * automatically according to the lifecycle that you define.
Backups * transitioned to cold storage must be stored in cold storage for a minimum of 90 * days. Therefore, the “retention” setting must be 90 days greater than the * “transition to cold after days” setting. The “transition to cold after days” * setting cannot be changed after a backup has been transitioned to cold.
*Resource types that are able to be transitioned to cold storage are listed in * the "Lifecycle to cold storage" section of the * Feature availability by resource table. Backup ignores this expression for * other resource types.
*/ inline BackupRule& WithLifecycle(const Lifecycle& value) { SetLifecycle(value); return *this;} /** *The lifecycle defines when a protected resource is transitioned to cold * storage and when it expires. Backup transitions and expires backups * automatically according to the lifecycle that you define.
Backups * transitioned to cold storage must be stored in cold storage for a minimum of 90 * days. Therefore, the “retention” setting must be 90 days greater than the * “transition to cold after days” setting. The “transition to cold after days” * setting cannot be changed after a backup has been transitioned to cold.
*Resource types that are able to be transitioned to cold storage are listed in * the "Lifecycle to cold storage" section of the * Feature availability by resource table. Backup ignores this expression for * other resource types.
*/ inline BackupRule& WithLifecycle(Lifecycle&& value) { SetLifecycle(std::move(value)); return *this;} /** *An array of key-value pair strings that are assigned to resources that are * associated with this rule when restored from backup.
*/ inline const Aws::MapAn array of key-value pair strings that are assigned to resources that are * associated with this rule when restored from backup.
*/ inline bool RecoveryPointTagsHasBeenSet() const { return m_recoveryPointTagsHasBeenSet; } /** *An array of key-value pair strings that are assigned to resources that are * associated with this rule when restored from backup.
*/ inline void SetRecoveryPointTags(const Aws::MapAn array of key-value pair strings that are assigned to resources that are * associated with this rule when restored from backup.
*/ inline void SetRecoveryPointTags(Aws::MapAn array of key-value pair strings that are assigned to resources that are * associated with this rule when restored from backup.
*/ inline BackupRule& WithRecoveryPointTags(const Aws::MapAn array of key-value pair strings that are assigned to resources that are * associated with this rule when restored from backup.
*/ inline BackupRule& WithRecoveryPointTags(Aws::MapAn array of key-value pair strings that are assigned to resources that are * associated with this rule when restored from backup.
*/ inline BackupRule& AddRecoveryPointTags(const Aws::String& key, const Aws::String& value) { m_recoveryPointTagsHasBeenSet = true; m_recoveryPointTags.emplace(key, value); return *this; } /** *An array of key-value pair strings that are assigned to resources that are * associated with this rule when restored from backup.
*/ inline BackupRule& AddRecoveryPointTags(Aws::String&& key, const Aws::String& value) { m_recoveryPointTagsHasBeenSet = true; m_recoveryPointTags.emplace(std::move(key), value); return *this; } /** *An array of key-value pair strings that are assigned to resources that are * associated with this rule when restored from backup.
*/ inline BackupRule& AddRecoveryPointTags(const Aws::String& key, Aws::String&& value) { m_recoveryPointTagsHasBeenSet = true; m_recoveryPointTags.emplace(key, std::move(value)); return *this; } /** *An array of key-value pair strings that are assigned to resources that are * associated with this rule when restored from backup.
*/ inline BackupRule& AddRecoveryPointTags(Aws::String&& key, Aws::String&& value) { m_recoveryPointTagsHasBeenSet = true; m_recoveryPointTags.emplace(std::move(key), std::move(value)); return *this; } /** *An array of key-value pair strings that are assigned to resources that are * associated with this rule when restored from backup.
*/ inline BackupRule& AddRecoveryPointTags(const char* key, Aws::String&& value) { m_recoveryPointTagsHasBeenSet = true; m_recoveryPointTags.emplace(key, std::move(value)); return *this; } /** *An array of key-value pair strings that are assigned to resources that are * associated with this rule when restored from backup.
*/ inline BackupRule& AddRecoveryPointTags(Aws::String&& key, const char* value) { m_recoveryPointTagsHasBeenSet = true; m_recoveryPointTags.emplace(std::move(key), value); return *this; } /** *An array of key-value pair strings that are assigned to resources that are * associated with this rule when restored from backup.
*/ inline BackupRule& AddRecoveryPointTags(const char* key, const char* value) { m_recoveryPointTagsHasBeenSet = true; m_recoveryPointTags.emplace(key, value); return *this; } /** *Uniquely identifies a rule that is used to schedule the backup of a selection * of resources.
*/ inline const Aws::String& GetRuleId() const{ return m_ruleId; } /** *Uniquely identifies a rule that is used to schedule the backup of a selection * of resources.
*/ inline bool RuleIdHasBeenSet() const { return m_ruleIdHasBeenSet; } /** *Uniquely identifies a rule that is used to schedule the backup of a selection * of resources.
*/ inline void SetRuleId(const Aws::String& value) { m_ruleIdHasBeenSet = true; m_ruleId = value; } /** *Uniquely identifies a rule that is used to schedule the backup of a selection * of resources.
*/ inline void SetRuleId(Aws::String&& value) { m_ruleIdHasBeenSet = true; m_ruleId = std::move(value); } /** *Uniquely identifies a rule that is used to schedule the backup of a selection * of resources.
*/ inline void SetRuleId(const char* value) { m_ruleIdHasBeenSet = true; m_ruleId.assign(value); } /** *Uniquely identifies a rule that is used to schedule the backup of a selection * of resources.
*/ inline BackupRule& WithRuleId(const Aws::String& value) { SetRuleId(value); return *this;} /** *Uniquely identifies a rule that is used to schedule the backup of a selection * of resources.
*/ inline BackupRule& WithRuleId(Aws::String&& value) { SetRuleId(std::move(value)); return *this;} /** *Uniquely identifies a rule that is used to schedule the backup of a selection * of resources.
*/ inline BackupRule& WithRuleId(const char* value) { SetRuleId(value); return *this;} /** *An array of CopyAction
objects, which contains the details of
* the copy operation.
An array of CopyAction
objects, which contains the details of
* the copy operation.
An array of CopyAction
objects, which contains the details of
* the copy operation.
An array of CopyAction
objects, which contains the details of
* the copy operation.
An array of CopyAction
objects, which contains the details of
* the copy operation.
An array of CopyAction
objects, which contains the details of
* the copy operation.
An array of CopyAction
objects, which contains the details of
* the copy operation.
An array of CopyAction
objects, which contains the details of
* the copy operation.
Specifies whether Backup creates continuous backups. True causes Backup to * create continuous backups capable of point-in-time restore (PITR). False (or not * specified) causes Backup to create snapshot backups.
*/ inline bool GetEnableContinuousBackup() const{ return m_enableContinuousBackup; } /** *Specifies whether Backup creates continuous backups. True causes Backup to * create continuous backups capable of point-in-time restore (PITR). False (or not * specified) causes Backup to create snapshot backups.
*/ inline bool EnableContinuousBackupHasBeenSet() const { return m_enableContinuousBackupHasBeenSet; } /** *Specifies whether Backup creates continuous backups. True causes Backup to * create continuous backups capable of point-in-time restore (PITR). False (or not * specified) causes Backup to create snapshot backups.
*/ inline void SetEnableContinuousBackup(bool value) { m_enableContinuousBackupHasBeenSet = true; m_enableContinuousBackup = value; } /** *Specifies whether Backup creates continuous backups. True causes Backup to * create continuous backups capable of point-in-time restore (PITR). False (or not * specified) causes Backup to create snapshot backups.
*/ inline BackupRule& WithEnableContinuousBackup(bool value) { SetEnableContinuousBackup(value); return *this;} private: Aws::String m_ruleName; bool m_ruleNameHasBeenSet = false; Aws::String m_targetBackupVaultName; bool m_targetBackupVaultNameHasBeenSet = false; Aws::String m_scheduleExpression; bool m_scheduleExpressionHasBeenSet = false; long long m_startWindowMinutes; bool m_startWindowMinutesHasBeenSet = false; long long m_completionWindowMinutes; bool m_completionWindowMinutesHasBeenSet = false; Lifecycle m_lifecycle; bool m_lifecycleHasBeenSet = false; Aws::Map