Struct Schedule

#[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>,
}

\[Custom snapshot and AMI policies only\] Specifies a schedule for a snapshot or AMI lifecycle policy.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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_tags: Option<bool>

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

tags_to_add: Option<Vec<Tag>>

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

variable_tags: Option<Vec<Tag>>

\[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 or in a Local Zone. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.

share_rules: Option<Vec<ShareRule>>

\[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

impl Schedule

pub fn name(&self) -> Option<&str>

The name of the schedule.

pub fn copy_tags(&self) -> Option<bool>

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

pub fn tags_to_add(&self) -> &[Tag]

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().

pub fn variable_tags(&self) -> &[Tag]

\[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().

pub fn create_rule(&self) -> Option<&CreateRule>

The creation rule.

pub fn retain_rule(&self) -> Option<&RetainRule>

The retention rule for snapshots or AMIs created by the policy.

pub fn fast_restore_rule(&self) -> Option<&FastRestoreRule>

\[Custom snapshot policies only\] The rule for enabling fast snapshot restore.

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 or in a Local Zone. 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().

pub fn share_rules(&self) -> &[ShareRule]

\[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().

pub fn deprecate_rule(&self) -> Option<&DeprecateRule>

\[Custom AMI policies only\] The AMI deprecation rule for the schedule.

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.

impl Schedule

pub fn builder() -> ScheduleBuilder

Creates a new builder-style object to manufacture Schedule.

Trait Implementations

impl Clone for Schedule

fn clone(&self) -> Schedule

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Schedule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Schedule

fn eq(&self, other: &Schedule) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Schedule