AWS SDK for C++  1.9.16
AWS SDK for C++
Public Member Functions | List of all members
Aws::DLM::Model::Schedule Class Reference

#include <Schedule.h>

Public Member Functions

 Schedule ()
 
 Schedule (Aws::Utils::Json::JsonView jsonValue)
 
Scheduleoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
ScheduleWithName (const Aws::String &value)
 
ScheduleWithName (Aws::String &&value)
 
ScheduleWithName (const char *value)
 
bool GetCopyTags () const
 
bool CopyTagsHasBeenSet () const
 
void SetCopyTags (bool value)
 
ScheduleWithCopyTags (bool value)
 
const Aws::Vector< Tag > & GetTagsToAdd () const
 
bool TagsToAddHasBeenSet () const
 
void SetTagsToAdd (const Aws::Vector< Tag > &value)
 
void SetTagsToAdd (Aws::Vector< Tag > &&value)
 
ScheduleWithTagsToAdd (const Aws::Vector< Tag > &value)
 
ScheduleWithTagsToAdd (Aws::Vector< Tag > &&value)
 
ScheduleAddTagsToAdd (const Tag &value)
 
ScheduleAddTagsToAdd (Tag &&value)
 
const Aws::Vector< Tag > & GetVariableTags () const
 
bool VariableTagsHasBeenSet () const
 
void SetVariableTags (const Aws::Vector< Tag > &value)
 
void SetVariableTags (Aws::Vector< Tag > &&value)
 
ScheduleWithVariableTags (const Aws::Vector< Tag > &value)
 
ScheduleWithVariableTags (Aws::Vector< Tag > &&value)
 
ScheduleAddVariableTags (const Tag &value)
 
ScheduleAddVariableTags (Tag &&value)
 
const CreateRuleGetCreateRule () const
 
bool CreateRuleHasBeenSet () const
 
void SetCreateRule (const CreateRule &value)
 
void SetCreateRule (CreateRule &&value)
 
ScheduleWithCreateRule (const CreateRule &value)
 
ScheduleWithCreateRule (CreateRule &&value)
 
const RetainRuleGetRetainRule () const
 
bool RetainRuleHasBeenSet () const
 
void SetRetainRule (const RetainRule &value)
 
void SetRetainRule (RetainRule &&value)
 
ScheduleWithRetainRule (const RetainRule &value)
 
ScheduleWithRetainRule (RetainRule &&value)
 
const FastRestoreRuleGetFastRestoreRule () const
 
bool FastRestoreRuleHasBeenSet () const
 
void SetFastRestoreRule (const FastRestoreRule &value)
 
void SetFastRestoreRule (FastRestoreRule &&value)
 
ScheduleWithFastRestoreRule (const FastRestoreRule &value)
 
ScheduleWithFastRestoreRule (FastRestoreRule &&value)
 
const Aws::Vector< CrossRegionCopyRule > & GetCrossRegionCopyRules () const
 
bool CrossRegionCopyRulesHasBeenSet () const
 
void SetCrossRegionCopyRules (const Aws::Vector< CrossRegionCopyRule > &value)
 
void SetCrossRegionCopyRules (Aws::Vector< CrossRegionCopyRule > &&value)
 
ScheduleWithCrossRegionCopyRules (const Aws::Vector< CrossRegionCopyRule > &value)
 
ScheduleWithCrossRegionCopyRules (Aws::Vector< CrossRegionCopyRule > &&value)
 
ScheduleAddCrossRegionCopyRules (const CrossRegionCopyRule &value)
 
ScheduleAddCrossRegionCopyRules (CrossRegionCopyRule &&value)
 
const Aws::Vector< ShareRule > & GetShareRules () const
 
bool ShareRulesHasBeenSet () const
 
void SetShareRules (const Aws::Vector< ShareRule > &value)
 
void SetShareRules (Aws::Vector< ShareRule > &&value)
 
ScheduleWithShareRules (const Aws::Vector< ShareRule > &value)
 
ScheduleWithShareRules (Aws::Vector< ShareRule > &&value)
 
ScheduleAddShareRules (const ShareRule &value)
 
ScheduleAddShareRules (ShareRule &&value)
 

Detailed Description

Specifies a backup schedule for a snapshot or AMI lifecycle policy.

See Also:

AWS API Reference

Definition at line 39 of file Schedule.h.

Constructor & Destructor Documentation

◆ Schedule() [1/2]

Aws::DLM::Model::Schedule::Schedule ( )

◆ Schedule() [2/2]

Aws::DLM::Model::Schedule::Schedule ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddCrossRegionCopyRules() [1/2]

Schedule& Aws::DLM::Model::Schedule::AddCrossRegionCopyRules ( const CrossRegionCopyRule value)
inline

The rule for cross-Region snapshot copies.

You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.

Definition at line 390 of file Schedule.h.

◆ AddCrossRegionCopyRules() [2/2]

Schedule& Aws::DLM::Model::Schedule::AddCrossRegionCopyRules ( CrossRegionCopyRule &&  value)
inline

The rule for cross-Region snapshot copies.

You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.

Definition at line 399 of file Schedule.h.

◆ AddShareRules() [1/2]

Schedule& Aws::DLM::Model::Schedule::AddShareRules ( const ShareRule value)
inline

The rule for sharing snapshots with other AWS accounts.

Definition at line 435 of file Schedule.h.

◆ AddShareRules() [2/2]

Schedule& Aws::DLM::Model::Schedule::AddShareRules ( ShareRule &&  value)
inline

The rule for sharing snapshots with other AWS accounts.

Definition at line 440 of file Schedule.h.

◆ AddTagsToAdd() [1/2]

Schedule& Aws::DLM::Model::Schedule::AddTagsToAdd ( const Tag value)
inline

The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.

Definition at line 154 of file Schedule.h.

◆ AddTagsToAdd() [2/2]

Schedule& Aws::DLM::Model::Schedule::AddTagsToAdd ( Tag &&  value)
inline

The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.

Definition at line 160 of file Schedule.h.

◆ AddVariableTags() [1/2]

Schedule& Aws::DLM::Model::Schedule::AddVariableTags ( const Tag value)
inline

A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or . Variable tags are only valid for EBS Snapshot Management – Instance policies.

Definition at line 224 of file Schedule.h.

◆ AddVariableTags() [2/2]

Schedule& Aws::DLM::Model::Schedule::AddVariableTags ( Tag &&  value)
inline

A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or . Variable tags are only valid for EBS Snapshot Management – Instance policies.

Definition at line 233 of file Schedule.h.

◆ CopyTagsHasBeenSet()

bool Aws::DLM::Model::Schedule::CopyTagsHasBeenSet ( ) const
inline

Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.

Definition at line 99 of file Schedule.h.

◆ CreateRuleHasBeenSet()

bool Aws::DLM::Model::Schedule::CreateRuleHasBeenSet ( ) const
inline

The creation rule.

Definition at line 244 of file Schedule.h.

◆ CrossRegionCopyRulesHasBeenSet()

bool Aws::DLM::Model::Schedule::CrossRegionCopyRulesHasBeenSet ( ) const
inline

The rule for cross-Region snapshot copies.

You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.

Definition at line 345 of file Schedule.h.

◆ FastRestoreRuleHasBeenSet()

bool Aws::DLM::Model::Schedule::FastRestoreRuleHasBeenSet ( ) const
inline

The rule for enabling fast snapshot restore.

Definition at line 306 of file Schedule.h.

◆ GetCopyTags()

bool Aws::DLM::Model::Schedule::GetCopyTags ( ) const
inline

Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.

Definition at line 93 of file Schedule.h.

◆ GetCreateRule()

const CreateRule& Aws::DLM::Model::Schedule::GetCreateRule ( ) const
inline

The creation rule.

Definition at line 239 of file Schedule.h.

◆ GetCrossRegionCopyRules()

const Aws::Vector<CrossRegionCopyRule>& Aws::DLM::Model::Schedule::GetCrossRegionCopyRules ( ) const
inline

The rule for cross-Region snapshot copies.

You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.

Definition at line 336 of file Schedule.h.

◆ GetFastRestoreRule()

const FastRestoreRule& Aws::DLM::Model::Schedule::GetFastRestoreRule ( ) const
inline

The rule for enabling fast snapshot restore.

Definition at line 301 of file Schedule.h.

◆ GetName()

const Aws::String& Aws::DLM::Model::Schedule::GetName ( ) const
inline

The name of the schedule.

Definition at line 51 of file Schedule.h.

◆ GetRetainRule()

const RetainRule& Aws::DLM::Model::Schedule::GetRetainRule ( ) const
inline

The retention rule.

Definition at line 270 of file Schedule.h.

◆ GetShareRules()

const Aws::Vector<ShareRule>& Aws::DLM::Model::Schedule::GetShareRules ( ) const
inline

The rule for sharing snapshots with other AWS accounts.

Definition at line 405 of file Schedule.h.

◆ GetTagsToAdd()

const Aws::Vector<Tag>& Aws::DLM::Model::Schedule::GetTagsToAdd ( ) const
inline

The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.

Definition at line 118 of file Schedule.h.

◆ GetVariableTags()

const Aws::Vector<Tag>& Aws::DLM::Model::Schedule::GetVariableTags ( ) const
inline

A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or . Variable tags are only valid for EBS Snapshot Management – Instance policies.

Definition at line 170 of file Schedule.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::DLM::Model::Schedule::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::DLM::Model::Schedule::NameHasBeenSet ( ) const
inline

The name of the schedule.

Definition at line 56 of file Schedule.h.

◆ operator=()

Schedule& Aws::DLM::Model::Schedule::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RetainRuleHasBeenSet()

bool Aws::DLM::Model::Schedule::RetainRuleHasBeenSet ( ) const
inline

The retention rule.

Definition at line 275 of file Schedule.h.

◆ SetCopyTags()

void Aws::DLM::Model::Schedule::SetCopyTags ( bool  value)
inline

Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.

Definition at line 105 of file Schedule.h.

◆ SetCreateRule() [1/2]

void Aws::DLM::Model::Schedule::SetCreateRule ( const CreateRule value)
inline

The creation rule.

Definition at line 249 of file Schedule.h.

◆ SetCreateRule() [2/2]

void Aws::DLM::Model::Schedule::SetCreateRule ( CreateRule &&  value)
inline

The creation rule.

Definition at line 254 of file Schedule.h.

◆ SetCrossRegionCopyRules() [1/2]

void Aws::DLM::Model::Schedule::SetCrossRegionCopyRules ( Aws::Vector< CrossRegionCopyRule > &&  value)
inline

The rule for cross-Region snapshot copies.

You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.

Definition at line 363 of file Schedule.h.

◆ SetCrossRegionCopyRules() [2/2]

void Aws::DLM::Model::Schedule::SetCrossRegionCopyRules ( const Aws::Vector< CrossRegionCopyRule > &  value)
inline

The rule for cross-Region snapshot copies.

You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.

Definition at line 354 of file Schedule.h.

◆ SetFastRestoreRule() [1/2]

void Aws::DLM::Model::Schedule::SetFastRestoreRule ( const FastRestoreRule value)
inline

The rule for enabling fast snapshot restore.

Definition at line 311 of file Schedule.h.

◆ SetFastRestoreRule() [2/2]

void Aws::DLM::Model::Schedule::SetFastRestoreRule ( FastRestoreRule &&  value)
inline

The rule for enabling fast snapshot restore.

Definition at line 316 of file Schedule.h.

◆ SetName() [1/3]

void Aws::DLM::Model::Schedule::SetName ( Aws::String &&  value)
inline

The name of the schedule.

Definition at line 66 of file Schedule.h.

◆ SetName() [2/3]

void Aws::DLM::Model::Schedule::SetName ( const Aws::String value)
inline

The name of the schedule.

Definition at line 61 of file Schedule.h.

◆ SetName() [3/3]

void Aws::DLM::Model::Schedule::SetName ( const char *  value)
inline

The name of the schedule.

Definition at line 71 of file Schedule.h.

◆ SetRetainRule() [1/2]

void Aws::DLM::Model::Schedule::SetRetainRule ( const RetainRule value)
inline

The retention rule.

Definition at line 280 of file Schedule.h.

◆ SetRetainRule() [2/2]

void Aws::DLM::Model::Schedule::SetRetainRule ( RetainRule &&  value)
inline

The retention rule.

Definition at line 285 of file Schedule.h.

◆ SetShareRules() [1/2]

void Aws::DLM::Model::Schedule::SetShareRules ( Aws::Vector< ShareRule > &&  value)
inline

The rule for sharing snapshots with other AWS accounts.

Definition at line 420 of file Schedule.h.

◆ SetShareRules() [2/2]

void Aws::DLM::Model::Schedule::SetShareRules ( const Aws::Vector< ShareRule > &  value)
inline

The rule for sharing snapshots with other AWS accounts.

Definition at line 415 of file Schedule.h.

◆ SetTagsToAdd() [1/2]

void Aws::DLM::Model::Schedule::SetTagsToAdd ( Aws::Vector< Tag > &&  value)
inline

The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.

Definition at line 136 of file Schedule.h.

◆ SetTagsToAdd() [2/2]

void Aws::DLM::Model::Schedule::SetTagsToAdd ( const Aws::Vector< Tag > &  value)
inline

The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.

Definition at line 130 of file Schedule.h.

◆ SetVariableTags() [1/2]

void Aws::DLM::Model::Schedule::SetVariableTags ( Aws::Vector< Tag > &&  value)
inline

A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or . Variable tags are only valid for EBS Snapshot Management – Instance policies.

Definition at line 197 of file Schedule.h.

◆ SetVariableTags() [2/2]

void Aws::DLM::Model::Schedule::SetVariableTags ( const Aws::Vector< Tag > &  value)
inline

A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or . Variable tags are only valid for EBS Snapshot Management – Instance policies.

Definition at line 188 of file Schedule.h.

◆ ShareRulesHasBeenSet()

bool Aws::DLM::Model::Schedule::ShareRulesHasBeenSet ( ) const
inline

The rule for sharing snapshots with other AWS accounts.

Definition at line 410 of file Schedule.h.

◆ TagsToAddHasBeenSet()

bool Aws::DLM::Model::Schedule::TagsToAddHasBeenSet ( ) const
inline

The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.

Definition at line 124 of file Schedule.h.

◆ VariableTagsHasBeenSet()

bool Aws::DLM::Model::Schedule::VariableTagsHasBeenSet ( ) const
inline

A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or . Variable tags are only valid for EBS Snapshot Management – Instance policies.

Definition at line 179 of file Schedule.h.

◆ WithCopyTags()

Schedule& Aws::DLM::Model::Schedule::WithCopyTags ( bool  value)
inline

Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.

Definition at line 111 of file Schedule.h.

◆ WithCreateRule() [1/2]

Schedule& Aws::DLM::Model::Schedule::WithCreateRule ( const CreateRule value)
inline

The creation rule.

Definition at line 259 of file Schedule.h.

◆ WithCreateRule() [2/2]

Schedule& Aws::DLM::Model::Schedule::WithCreateRule ( CreateRule &&  value)
inline

The creation rule.

Definition at line 264 of file Schedule.h.

◆ WithCrossRegionCopyRules() [1/2]

Schedule& Aws::DLM::Model::Schedule::WithCrossRegionCopyRules ( Aws::Vector< CrossRegionCopyRule > &&  value)
inline

The rule for cross-Region snapshot copies.

You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.

Definition at line 381 of file Schedule.h.

◆ WithCrossRegionCopyRules() [2/2]

Schedule& Aws::DLM::Model::Schedule::WithCrossRegionCopyRules ( const Aws::Vector< CrossRegionCopyRule > &  value)
inline

The rule for cross-Region snapshot copies.

You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.

Definition at line 372 of file Schedule.h.

◆ WithFastRestoreRule() [1/2]

Schedule& Aws::DLM::Model::Schedule::WithFastRestoreRule ( const FastRestoreRule value)
inline

The rule for enabling fast snapshot restore.

Definition at line 321 of file Schedule.h.

◆ WithFastRestoreRule() [2/2]

Schedule& Aws::DLM::Model::Schedule::WithFastRestoreRule ( FastRestoreRule &&  value)
inline

The rule for enabling fast snapshot restore.

Definition at line 326 of file Schedule.h.

◆ WithName() [1/3]

Schedule& Aws::DLM::Model::Schedule::WithName ( Aws::String &&  value)
inline

The name of the schedule.

Definition at line 81 of file Schedule.h.

◆ WithName() [2/3]

Schedule& Aws::DLM::Model::Schedule::WithName ( const Aws::String value)
inline

The name of the schedule.

Definition at line 76 of file Schedule.h.

◆ WithName() [3/3]

Schedule& Aws::DLM::Model::Schedule::WithName ( const char *  value)
inline

The name of the schedule.

Definition at line 86 of file Schedule.h.

◆ WithRetainRule() [1/2]

Schedule& Aws::DLM::Model::Schedule::WithRetainRule ( const RetainRule value)
inline

The retention rule.

Definition at line 290 of file Schedule.h.

◆ WithRetainRule() [2/2]

Schedule& Aws::DLM::Model::Schedule::WithRetainRule ( RetainRule &&  value)
inline

The retention rule.

Definition at line 295 of file Schedule.h.

◆ WithShareRules() [1/2]

Schedule& Aws::DLM::Model::Schedule::WithShareRules ( Aws::Vector< ShareRule > &&  value)
inline

The rule for sharing snapshots with other AWS accounts.

Definition at line 430 of file Schedule.h.

◆ WithShareRules() [2/2]

Schedule& Aws::DLM::Model::Schedule::WithShareRules ( const Aws::Vector< ShareRule > &  value)
inline

The rule for sharing snapshots with other AWS accounts.

Definition at line 425 of file Schedule.h.

◆ WithTagsToAdd() [1/2]

Schedule& Aws::DLM::Model::Schedule::WithTagsToAdd ( Aws::Vector< Tag > &&  value)
inline

The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.

Definition at line 148 of file Schedule.h.

◆ WithTagsToAdd() [2/2]

Schedule& Aws::DLM::Model::Schedule::WithTagsToAdd ( const Aws::Vector< Tag > &  value)
inline

The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.

Definition at line 142 of file Schedule.h.

◆ WithVariableTags() [1/2]

Schedule& Aws::DLM::Model::Schedule::WithVariableTags ( Aws::Vector< Tag > &&  value)
inline

A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or . Variable tags are only valid for EBS Snapshot Management – Instance policies.

Definition at line 215 of file Schedule.h.

◆ WithVariableTags() [2/2]

Schedule& Aws::DLM::Model::Schedule::WithVariableTags ( const Aws::Vector< Tag > &  value)
inline

A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or . Variable tags are only valid for EBS Snapshot Management – Instance policies.

Definition at line 206 of file Schedule.h.


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