You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DLM::Types::Schedule

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Schedule as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "ScheduleName",
  copy_tags: false,
  tags_to_add: [
    {
      key: "String", # required
      value: "String", # required
    },
  ],
  variable_tags: [
    {
      key: "String", # required
      value: "String", # required
    },
  ],
  create_rule: {
    interval: 1,
    interval_unit: "HOURS", # accepts HOURS
    times: ["Time"],
    cron_expression: "CronExpression",
  },
  retain_rule: {
    count: 1,
    interval: 1,
    interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
  },
  fast_restore_rule: {
    count: 1,
    interval: 1,
    interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
    availability_zones: ["AvailabilityZone"], # required
  },
  cross_region_copy_rules: [
    {
      target_region: "TargetRegion", # required
      encrypted: false, # required
      cmk_arn: "CmkArn",
      copy_tags: false,
      retain_rule: {
        interval: 1,
        interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
      },
    },
  ],
}

Specifies a backup schedule.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#copy_tags ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#create_rule ⇒ Types::CreateRule

The creation rule.

Returns:

#cross_region_copy_rules ⇒ Array<Types::CrossRegionCopyRule>

The rule for cross-Region snapshot copies.

Returns:

#fast_restore_rule ⇒ Types::FastRestoreRule

The rule for enabling fast snapshot restore.

Returns:

#name ⇒ String

The name of the schedule.

Returns:

  • (String) —

    The name of the schedule.

#retain_rule ⇒ Types::RetainRule

The retention rule.

Returns:

#tags_to_add ⇒ Array<Types::Tag>

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

Returns:

  • (Array<Types::Tag>) —

    The tags to apply to policy-created resources.

#variable_tags ⇒ Array<Types::Tag>

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.

Returns:

  • (Array<Types::Tag>) —

    A collection of key/value pairs with values determined dynamically when the policy is executed.