Struct aws_sdk_dlm::types::Schedule
source · #[non_exhaustive]pub struct Schedule {
pub name: Option<String>,
pub copy_tags: Option<bool>,
pub tags_to_add: Option<Vec<Tag>>,
pub variable_tags: Option<Vec<Tag>>,
pub create_rule: Option<CreateRule>,
pub retain_rule: Option<RetainRule>,
pub fast_restore_rule: Option<FastRestoreRule>,
pub cross_region_copy_rules: Option<Vec<CrossRegionCopyRule>>,
pub share_rules: Option<Vec<ShareRule>>,
pub deprecate_rule: Option<DeprecateRule>,
pub archive_rule: Option<ArchiveRule>,
}
Expand description
[Custom snapshot and AMI policies only] Specifies a schedule for a snapshot or AMI lifecycle policy.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.name: Option<String>
The name of the schedule.
Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
[AMI policies and snapshot policies that target instances only] 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 $(timestamp)
. Variable tags are only valid for EBS Snapshot Management – Instance policies.
create_rule: Option<CreateRule>
The creation rule.
retain_rule: Option<RetainRule>
The retention rule for snapshots or AMIs created by the policy.
fast_restore_rule: Option<FastRestoreRule>
[Custom snapshot policies only] The rule for enabling fast snapshot restore.
cross_region_copy_rules: Option<Vec<CrossRegionCopyRule>>
Specifies a rule for copying snapshots or AMIs across regions.
You can't specify cross-Region copy rules for policies that create snapshots on an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
[Custom snapshot policies only] The rule for sharing snapshots with other Amazon Web Services accounts.
deprecate_rule: Option<DeprecateRule>
[Custom AMI policies only] The AMI deprecation rule for the schedule.
archive_rule: Option<ArchiveRule>
[Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.
For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies.
Implementations§
source§impl Schedule
impl Schedule
Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags_to_add.is_none()
.
[AMI policies and snapshot policies that target instances only] 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 $(timestamp)
. Variable tags are only valid for EBS Snapshot Management – Instance policies.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .variable_tags.is_none()
.
sourcepub fn create_rule(&self) -> Option<&CreateRule>
pub fn create_rule(&self) -> Option<&CreateRule>
The creation rule.
sourcepub fn retain_rule(&self) -> Option<&RetainRule>
pub fn retain_rule(&self) -> Option<&RetainRule>
The retention rule for snapshots or AMIs created by the policy.
sourcepub fn fast_restore_rule(&self) -> Option<&FastRestoreRule>
pub fn fast_restore_rule(&self) -> Option<&FastRestoreRule>
[Custom snapshot policies only] The rule for enabling fast snapshot restore.
sourcepub fn cross_region_copy_rules(&self) -> &[CrossRegionCopyRule]
pub fn cross_region_copy_rules(&self) -> &[CrossRegionCopyRule]
Specifies a rule for copying snapshots or AMIs across regions.
You can't specify cross-Region copy rules for policies that create snapshots on an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .cross_region_copy_rules.is_none()
.
[Custom snapshot policies only] The rule for sharing snapshots with other Amazon Web Services accounts.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .share_rules.is_none()
.
sourcepub fn deprecate_rule(&self) -> Option<&DeprecateRule>
pub fn deprecate_rule(&self) -> Option<&DeprecateRule>
[Custom AMI policies only] The AMI deprecation rule for the schedule.
sourcepub fn archive_rule(&self) -> Option<&ArchiveRule>
pub fn archive_rule(&self) -> Option<&ArchiveRule>
[Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.
For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies.
Trait Implementations§
source§impl PartialEq for Schedule
impl PartialEq for Schedule
impl StructuralPartialEq for Schedule
Auto Trait Implementations§
impl Freeze for Schedule
impl RefUnwindSafe for Schedule
impl Send for Schedule
impl Sync for Schedule
impl Unpin for Schedule
impl UnwindSafe for Schedule
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more