AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::Backup::Model::BackupRule Class Reference

#include <BackupRule.h>

Public Member Functions

 BackupRule ()
 
 BackupRule (Aws::Utils::Json::JsonView jsonValue)
 
BackupRuleoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetRuleName () const
 
bool RuleNameHasBeenSet () const
 
void SetRuleName (const Aws::String &value)
 
void SetRuleName (Aws::String &&value)
 
void SetRuleName (const char *value)
 
BackupRuleWithRuleName (const Aws::String &value)
 
BackupRuleWithRuleName (Aws::String &&value)
 
BackupRuleWithRuleName (const char *value)
 
const Aws::StringGetTargetBackupVaultName () const
 
bool TargetBackupVaultNameHasBeenSet () const
 
void SetTargetBackupVaultName (const Aws::String &value)
 
void SetTargetBackupVaultName (Aws::String &&value)
 
void SetTargetBackupVaultName (const char *value)
 
BackupRuleWithTargetBackupVaultName (const Aws::String &value)
 
BackupRuleWithTargetBackupVaultName (Aws::String &&value)
 
BackupRuleWithTargetBackupVaultName (const char *value)
 
const Aws::StringGetScheduleExpression () const
 
bool ScheduleExpressionHasBeenSet () const
 
void SetScheduleExpression (const Aws::String &value)
 
void SetScheduleExpression (Aws::String &&value)
 
void SetScheduleExpression (const char *value)
 
BackupRuleWithScheduleExpression (const Aws::String &value)
 
BackupRuleWithScheduleExpression (Aws::String &&value)
 
BackupRuleWithScheduleExpression (const char *value)
 
long long GetStartWindowMinutes () const
 
bool StartWindowMinutesHasBeenSet () const
 
void SetStartWindowMinutes (long long value)
 
BackupRuleWithStartWindowMinutes (long long value)
 
long long GetCompletionWindowMinutes () const
 
bool CompletionWindowMinutesHasBeenSet () const
 
void SetCompletionWindowMinutes (long long value)
 
BackupRuleWithCompletionWindowMinutes (long long value)
 
const LifecycleGetLifecycle () const
 
bool LifecycleHasBeenSet () const
 
void SetLifecycle (const Lifecycle &value)
 
void SetLifecycle (Lifecycle &&value)
 
BackupRuleWithLifecycle (const Lifecycle &value)
 
BackupRuleWithLifecycle (Lifecycle &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetRecoveryPointTags () const
 
bool RecoveryPointTagsHasBeenSet () const
 
void SetRecoveryPointTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetRecoveryPointTags (Aws::Map< Aws::String, Aws::String > &&value)
 
BackupRuleWithRecoveryPointTags (const Aws::Map< Aws::String, Aws::String > &value)
 
BackupRuleWithRecoveryPointTags (Aws::Map< Aws::String, Aws::String > &&value)
 
BackupRuleAddRecoveryPointTags (const Aws::String &key, const Aws::String &value)
 
BackupRuleAddRecoveryPointTags (Aws::String &&key, const Aws::String &value)
 
BackupRuleAddRecoveryPointTags (const Aws::String &key, Aws::String &&value)
 
BackupRuleAddRecoveryPointTags (Aws::String &&key, Aws::String &&value)
 
BackupRuleAddRecoveryPointTags (const char *key, Aws::String &&value)
 
BackupRuleAddRecoveryPointTags (Aws::String &&key, const char *value)
 
BackupRuleAddRecoveryPointTags (const char *key, const char *value)
 
const Aws::StringGetRuleId () const
 
bool RuleIdHasBeenSet () const
 
void SetRuleId (const Aws::String &value)
 
void SetRuleId (Aws::String &&value)
 
void SetRuleId (const char *value)
 
BackupRuleWithRuleId (const Aws::String &value)
 
BackupRuleWithRuleId (Aws::String &&value)
 
BackupRuleWithRuleId (const char *value)
 
const Aws::Vector< CopyAction > & GetCopyActions () const
 
bool CopyActionsHasBeenSet () const
 
void SetCopyActions (const Aws::Vector< CopyAction > &value)
 
void SetCopyActions (Aws::Vector< CopyAction > &&value)
 
BackupRuleWithCopyActions (const Aws::Vector< CopyAction > &value)
 
BackupRuleWithCopyActions (Aws::Vector< CopyAction > &&value)
 
BackupRuleAddCopyActions (const CopyAction &value)
 
BackupRuleAddCopyActions (CopyAction &&value)
 
bool GetEnableContinuousBackup () const
 
bool EnableContinuousBackupHasBeenSet () const
 
void SetEnableContinuousBackup (bool value)
 
BackupRuleWithEnableContinuousBackup (bool value)
 

Detailed Description

Specifies a scheduled task used to back up a selection of resources.

See Also:

AWS API Reference

Definition at line 36 of file BackupRule.h.

Constructor & Destructor Documentation

◆ BackupRule() [1/2]

Aws::Backup::Model::BackupRule::BackupRule ( )

◆ BackupRule() [2/2]

Aws::Backup::Model::BackupRule::BackupRule ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddCopyActions() [1/2]

BackupRule& Aws::Backup::Model::BackupRule::AddCopyActions ( const CopyAction value)
inline

An array of CopyAction objects, which contains the details of the copy operation.

Definition at line 523 of file BackupRule.h.

◆ AddCopyActions() [2/2]

BackupRule& Aws::Backup::Model::BackupRule::AddCopyActions ( CopyAction &&  value)
inline

An array of CopyAction objects, which contains the details of the copy operation.

Definition at line 529 of file BackupRule.h.

◆ AddRecoveryPointTags() [1/7]

BackupRule& Aws::Backup::Model::BackupRule::AddRecoveryPointTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

Definition at line 413 of file BackupRule.h.

◆ AddRecoveryPointTags() [2/7]

BackupRule& Aws::Backup::Model::BackupRule::AddRecoveryPointTags ( Aws::String &&  key,
const Aws::String value 
)
inline

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

Definition at line 401 of file BackupRule.h.

◆ AddRecoveryPointTags() [3/7]

BackupRule& Aws::Backup::Model::BackupRule::AddRecoveryPointTags ( Aws::String &&  key,
const char *  value 
)
inline

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

Definition at line 425 of file BackupRule.h.

◆ AddRecoveryPointTags() [4/7]

BackupRule& Aws::Backup::Model::BackupRule::AddRecoveryPointTags ( const Aws::String key,
Aws::String &&  value 
)
inline

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

Definition at line 407 of file BackupRule.h.

◆ AddRecoveryPointTags() [5/7]

BackupRule& Aws::Backup::Model::BackupRule::AddRecoveryPointTags ( const Aws::String key,
const Aws::String value 
)
inline

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

Definition at line 395 of file BackupRule.h.

◆ AddRecoveryPointTags() [6/7]

BackupRule& Aws::Backup::Model::BackupRule::AddRecoveryPointTags ( const char *  key,
Aws::String &&  value 
)
inline

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

Definition at line 419 of file BackupRule.h.

◆ AddRecoveryPointTags() [7/7]

BackupRule& Aws::Backup::Model::BackupRule::AddRecoveryPointTags ( const char *  key,
const char *  value 
)
inline

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

Definition at line 431 of file BackupRule.h.

◆ CompletionWindowMinutesHasBeenSet()

bool Aws::Backup::Model::BackupRule::CompletionWindowMinutesHasBeenSet ( ) const
inline

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.

Definition at line 267 of file BackupRule.h.

◆ CopyActionsHasBeenSet()

bool Aws::Backup::Model::BackupRule::CopyActionsHasBeenSet ( ) const
inline

An array of CopyAction objects, which contains the details of the copy operation.

Definition at line 493 of file BackupRule.h.

◆ EnableContinuousBackupHasBeenSet()

bool Aws::Backup::Model::BackupRule::EnableContinuousBackupHasBeenSet ( ) const
inline

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.

Definition at line 544 of file BackupRule.h.

◆ GetCompletionWindowMinutes()

long long Aws::Backup::Model::BackupRule::GetCompletionWindowMinutes ( ) const
inline

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.

Definition at line 261 of file BackupRule.h.

◆ GetCopyActions()

const Aws::Vector<CopyAction>& Aws::Backup::Model::BackupRule::GetCopyActions ( ) const
inline

An array of CopyAction objects, which contains the details of the copy operation.

Definition at line 487 of file BackupRule.h.

◆ GetEnableContinuousBackup()

bool Aws::Backup::Model::BackupRule::GetEnableContinuousBackup ( ) const
inline

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.

Definition at line 537 of file BackupRule.h.

◆ GetLifecycle()

const Lifecycle& Aws::Backup::Model::BackupRule::GetLifecycle ( ) const
inline

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 “expire after days” 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

Definition at line 292 of file BackupRule.h.

◆ GetRecoveryPointTags()

const Aws::Map<Aws::String, Aws::String>& Aws::Backup::Model::BackupRule::GetRecoveryPointTags ( ) const
inline

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

Definition at line 359 of file BackupRule.h.

◆ GetRuleId()

const Aws::String& Aws::Backup::Model::BackupRule::GetRuleId ( ) const
inline

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

Definition at line 438 of file BackupRule.h.

◆ GetRuleName()

const Aws::String& Aws::Backup::Model::BackupRule::GetRuleName ( ) const
inline

An optional display name for a backup rule.

Definition at line 48 of file BackupRule.h.

◆ GetScheduleExpression()

const Aws::String& Aws::Backup::Model::BackupRule::GetScheduleExpression ( ) const
inline

A cron expression in UTC specifying when Backup initiates a backup job. For more information about cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Prior to specifying a value for this parameter, we recommend testing your cron expression using one of the many available cron generator and testing tools.

Definition at line 159 of file BackupRule.h.

◆ GetStartWindowMinutes()

long long Aws::Backup::Model::BackupRule::GetStartWindowMinutes ( ) const
inline

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.

Definition at line 236 of file BackupRule.h.

◆ GetTargetBackupVaultName()

const Aws::String& Aws::Backup::Model::BackupRule::GetTargetBackupVaultName ( ) const
inline

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.

Definition at line 92 of file BackupRule.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Backup::Model::BackupRule::Jsonize ( ) const

◆ LifecycleHasBeenSet()

bool Aws::Backup::Model::BackupRule::LifecycleHasBeenSet ( ) const
inline

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 “expire after days” 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

Definition at line 304 of file BackupRule.h.

◆ operator=()

BackupRule& Aws::Backup::Model::BackupRule::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RecoveryPointTagsHasBeenSet()

bool Aws::Backup::Model::BackupRule::RecoveryPointTagsHasBeenSet ( ) const
inline

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

Definition at line 365 of file BackupRule.h.

◆ RuleIdHasBeenSet()

bool Aws::Backup::Model::BackupRule::RuleIdHasBeenSet ( ) const
inline

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

Definition at line 444 of file BackupRule.h.

◆ RuleNameHasBeenSet()

bool Aws::Backup::Model::BackupRule::RuleNameHasBeenSet ( ) const
inline

An optional display name for a backup rule.

Definition at line 53 of file BackupRule.h.

◆ ScheduleExpressionHasBeenSet()

bool Aws::Backup::Model::BackupRule::ScheduleExpressionHasBeenSet ( ) const
inline

A cron expression in UTC specifying when Backup initiates a backup job. For more information about cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Prior to specifying a value for this parameter, we recommend testing your cron expression using one of the many available cron generator and testing tools.

Definition at line 169 of file BackupRule.h.

◆ SetCompletionWindowMinutes()

void Aws::Backup::Model::BackupRule::SetCompletionWindowMinutes ( long long  value)
inline

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.

Definition at line 273 of file BackupRule.h.

◆ SetCopyActions() [1/2]

void Aws::Backup::Model::BackupRule::SetCopyActions ( Aws::Vector< CopyAction > &&  value)
inline

An array of CopyAction objects, which contains the details of the copy operation.

Definition at line 505 of file BackupRule.h.

◆ SetCopyActions() [2/2]

void Aws::Backup::Model::BackupRule::SetCopyActions ( const Aws::Vector< CopyAction > &  value)
inline

An array of CopyAction objects, which contains the details of the copy operation.

Definition at line 499 of file BackupRule.h.

◆ SetEnableContinuousBackup()

void Aws::Backup::Model::BackupRule::SetEnableContinuousBackup ( bool  value)
inline

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.

Definition at line 551 of file BackupRule.h.

◆ SetLifecycle() [1/2]

void Aws::Backup::Model::BackupRule::SetLifecycle ( const Lifecycle value)
inline

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 “expire after days” 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

Definition at line 316 of file BackupRule.h.

◆ SetLifecycle() [2/2]

void Aws::Backup::Model::BackupRule::SetLifecycle ( Lifecycle &&  value)
inline

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 “expire after days” 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

Definition at line 328 of file BackupRule.h.

◆ SetRecoveryPointTags() [1/2]

void Aws::Backup::Model::BackupRule::SetRecoveryPointTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

Definition at line 377 of file BackupRule.h.

◆ SetRecoveryPointTags() [2/2]

void Aws::Backup::Model::BackupRule::SetRecoveryPointTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

Definition at line 371 of file BackupRule.h.

◆ SetRuleId() [1/3]

void Aws::Backup::Model::BackupRule::SetRuleId ( Aws::String &&  value)
inline

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

Definition at line 456 of file BackupRule.h.

◆ SetRuleId() [2/3]

void Aws::Backup::Model::BackupRule::SetRuleId ( const Aws::String value)
inline

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

Definition at line 450 of file BackupRule.h.

◆ SetRuleId() [3/3]

void Aws::Backup::Model::BackupRule::SetRuleId ( const char *  value)
inline

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

Definition at line 462 of file BackupRule.h.

◆ SetRuleName() [1/3]

void Aws::Backup::Model::BackupRule::SetRuleName ( Aws::String &&  value)
inline

An optional display name for a backup rule.

Definition at line 63 of file BackupRule.h.

◆ SetRuleName() [2/3]

void Aws::Backup::Model::BackupRule::SetRuleName ( const Aws::String value)
inline

An optional display name for a backup rule.

Definition at line 58 of file BackupRule.h.

◆ SetRuleName() [3/3]

void Aws::Backup::Model::BackupRule::SetRuleName ( const char *  value)
inline

An optional display name for a backup rule.

Definition at line 68 of file BackupRule.h.

◆ SetScheduleExpression() [1/3]

void Aws::Backup::Model::BackupRule::SetScheduleExpression ( Aws::String &&  value)
inline

A cron expression in UTC specifying when Backup initiates a backup job. For more information about cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Prior to specifying a value for this parameter, we recommend testing your cron expression using one of the many available cron generator and testing tools.

Definition at line 189 of file BackupRule.h.

◆ SetScheduleExpression() [2/3]

void Aws::Backup::Model::BackupRule::SetScheduleExpression ( const Aws::String value)
inline

A cron expression in UTC specifying when Backup initiates a backup job. For more information about cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Prior to specifying a value for this parameter, we recommend testing your cron expression using one of the many available cron generator and testing tools.

Definition at line 179 of file BackupRule.h.

◆ SetScheduleExpression() [3/3]

void Aws::Backup::Model::BackupRule::SetScheduleExpression ( const char *  value)
inline

A cron expression in UTC specifying when Backup initiates a backup job. For more information about cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Prior to specifying a value for this parameter, we recommend testing your cron expression using one of the many available cron generator and testing tools.

Definition at line 199 of file BackupRule.h.

◆ SetStartWindowMinutes()

void Aws::Backup::Model::BackupRule::SetStartWindowMinutes ( long long  value)
inline

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.

Definition at line 248 of file BackupRule.h.

◆ SetTargetBackupVaultName() [1/3]

void Aws::Backup::Model::BackupRule::SetTargetBackupVaultName ( Aws::String &&  value)
inline

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.

Definition at line 116 of file BackupRule.h.

◆ SetTargetBackupVaultName() [2/3]

void Aws::Backup::Model::BackupRule::SetTargetBackupVaultName ( const Aws::String value)
inline

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.

Definition at line 108 of file BackupRule.h.

◆ SetTargetBackupVaultName() [3/3]

void Aws::Backup::Model::BackupRule::SetTargetBackupVaultName ( const char *  value)
inline

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.

Definition at line 124 of file BackupRule.h.

◆ StartWindowMinutesHasBeenSet()

bool Aws::Backup::Model::BackupRule::StartWindowMinutesHasBeenSet ( ) const
inline

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.

Definition at line 242 of file BackupRule.h.

◆ TargetBackupVaultNameHasBeenSet()

bool Aws::Backup::Model::BackupRule::TargetBackupVaultNameHasBeenSet ( ) const
inline

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.

Definition at line 100 of file BackupRule.h.

◆ WithCompletionWindowMinutes()

BackupRule& Aws::Backup::Model::BackupRule::WithCompletionWindowMinutes ( long long  value)
inline

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.

Definition at line 279 of file BackupRule.h.

◆ WithCopyActions() [1/2]

BackupRule& Aws::Backup::Model::BackupRule::WithCopyActions ( Aws::Vector< CopyAction > &&  value)
inline

An array of CopyAction objects, which contains the details of the copy operation.

Definition at line 517 of file BackupRule.h.

◆ WithCopyActions() [2/2]

BackupRule& Aws::Backup::Model::BackupRule::WithCopyActions ( const Aws::Vector< CopyAction > &  value)
inline

An array of CopyAction objects, which contains the details of the copy operation.

Definition at line 511 of file BackupRule.h.

◆ WithEnableContinuousBackup()

BackupRule& Aws::Backup::Model::BackupRule::WithEnableContinuousBackup ( bool  value)
inline

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.

Definition at line 558 of file BackupRule.h.

◆ WithLifecycle() [1/2]

BackupRule& Aws::Backup::Model::BackupRule::WithLifecycle ( const Lifecycle value)
inline

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 “expire after days” 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

Definition at line 340 of file BackupRule.h.

◆ WithLifecycle() [2/2]

BackupRule& Aws::Backup::Model::BackupRule::WithLifecycle ( Lifecycle &&  value)
inline

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 “expire after days” 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

Definition at line 352 of file BackupRule.h.

◆ WithRecoveryPointTags() [1/2]

BackupRule& Aws::Backup::Model::BackupRule::WithRecoveryPointTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

Definition at line 389 of file BackupRule.h.

◆ WithRecoveryPointTags() [2/2]

BackupRule& Aws::Backup::Model::BackupRule::WithRecoveryPointTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

Definition at line 383 of file BackupRule.h.

◆ WithRuleId() [1/3]

BackupRule& Aws::Backup::Model::BackupRule::WithRuleId ( Aws::String &&  value)
inline

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

Definition at line 474 of file BackupRule.h.

◆ WithRuleId() [2/3]

BackupRule& Aws::Backup::Model::BackupRule::WithRuleId ( const Aws::String value)
inline

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

Definition at line 468 of file BackupRule.h.

◆ WithRuleId() [3/3]

BackupRule& Aws::Backup::Model::BackupRule::WithRuleId ( const char *  value)
inline

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

Definition at line 480 of file BackupRule.h.

◆ WithRuleName() [1/3]

BackupRule& Aws::Backup::Model::BackupRule::WithRuleName ( Aws::String &&  value)
inline

An optional display name for a backup rule.

Definition at line 78 of file BackupRule.h.

◆ WithRuleName() [2/3]

BackupRule& Aws::Backup::Model::BackupRule::WithRuleName ( const Aws::String value)
inline

An optional display name for a backup rule.

Definition at line 73 of file BackupRule.h.

◆ WithRuleName() [3/3]

BackupRule& Aws::Backup::Model::BackupRule::WithRuleName ( const char *  value)
inline

An optional display name for a backup rule.

Definition at line 83 of file BackupRule.h.

◆ WithScheduleExpression() [1/3]

BackupRule& Aws::Backup::Model::BackupRule::WithScheduleExpression ( Aws::String &&  value)
inline

A cron expression in UTC specifying when Backup initiates a backup job. For more information about cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Prior to specifying a value for this parameter, we recommend testing your cron expression using one of the many available cron generator and testing tools.

Definition at line 219 of file BackupRule.h.

◆ WithScheduleExpression() [2/3]

BackupRule& Aws::Backup::Model::BackupRule::WithScheduleExpression ( const Aws::String value)
inline

A cron expression in UTC specifying when Backup initiates a backup job. For more information about cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Prior to specifying a value for this parameter, we recommend testing your cron expression using one of the many available cron generator and testing tools.

Definition at line 209 of file BackupRule.h.

◆ WithScheduleExpression() [3/3]

BackupRule& Aws::Backup::Model::BackupRule::WithScheduleExpression ( const char *  value)
inline

A cron expression in UTC specifying when Backup initiates a backup job. For more information about cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Prior to specifying a value for this parameter, we recommend testing your cron expression using one of the many available cron generator and testing tools.

Definition at line 229 of file BackupRule.h.

◆ WithStartWindowMinutes()

BackupRule& Aws::Backup::Model::BackupRule::WithStartWindowMinutes ( long long  value)
inline

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.

Definition at line 254 of file BackupRule.h.

◆ WithTargetBackupVaultName() [1/3]

BackupRule& Aws::Backup::Model::BackupRule::WithTargetBackupVaultName ( Aws::String &&  value)
inline

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.

Definition at line 140 of file BackupRule.h.

◆ WithTargetBackupVaultName() [2/3]

BackupRule& Aws::Backup::Model::BackupRule::WithTargetBackupVaultName ( const Aws::String value)
inline

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.

Definition at line 132 of file BackupRule.h.

◆ WithTargetBackupVaultName() [3/3]

BackupRule& Aws::Backup::Model::BackupRule::WithTargetBackupVaultName ( const char *  value)
inline

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.

Definition at line 148 of file BackupRule.h.


The documentation for this class was generated from the following file: