Struct aws_sdk_dlm::types::CreateRule

#[non_exhaustive]
pub struct CreateRule {
    pub location: Option<LocationValues>,
    pub interval: Option<i32>,
    pub interval_unit: Option<IntervalUnitValues>,
    pub times: Option<Vec<String>>,
    pub cron_expression: Option<String>,
    pub scripts: Option<Vec<Script>>,
}

[Custom snapshot and AMI policies only] Specifies when the policy should create snapshots or AMIs.

• You must specify either CronExpression, or Interval, IntervalUnit, and Times.

• If you need to specify an ArchiveRule for the schedule, then you must specify a creation frequency of at least 28 days.

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.

location: Option<LocationValues>

[Custom snapshot policies only] Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD. To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. If you omit this parameter, CLOUD is used by default.

If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.

interval: Option<i32>

The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.

interval_unit: Option<IntervalUnitValues>

The interval unit.

times: Option<Vec<String>>

The time, in UTC, to start the operation. The supported format is hh:mm.

The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.

cron_expression: Option<String>

The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. For more information, see Cron expressions in the Amazon CloudWatch User Guide.

scripts: Option<Vec<Script>>

[Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.

For more information, see Automating application-consistent snapshots with pre and post scripts.

Implementations

impl CreateRule

pub fn location(&self) -> Option<&LocationValues>

[Custom snapshot policies only] Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD. To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. If you omit this parameter, CLOUD is used by default.

If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.

pub fn interval(&self) -> Option<i32>

The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.

pub fn interval_unit(&self) -> Option<&IntervalUnitValues>

The interval unit.

pub fn times(&self) -> &[String]

The time, in UTC, to start the operation. The supported format is hh:mm.

The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .times.is_none().

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

The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. For more information, see Cron expressions in the Amazon CloudWatch User Guide.

pub fn scripts(&self) -> &[Script]

[Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.

For more information, see Automating application-consistent snapshots with pre and post scripts.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .scripts.is_none().

impl CreateRule

pub fn builder() -> CreateRuleBuilder

Creates a new builder-style object to manufacture CreateRule.

Trait Implementations

impl Clone for CreateRule

fn clone(&self) -> CreateRule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateRule

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

Formats the value using the given formatter.

impl PartialEq for CreateRule

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CreateRule