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

Inherits:

Struct

• Object
• Struct
• Aws::DLM::Types::Schedule

Includes:

Structure

Defined in:

lib/aws-sdk-dlm/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #archive_rule ⇒ Types::ArchiveRule

  **[Custom snapshot policies that target volumes only]** The snapshot archiving rule for the schedule.

• #copy_tags ⇒ 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.

• #cross_region_copy_rules ⇒ Array<Types::CrossRegionCopyRule>

  Specifies a rule for copying snapshots or AMIs across regions.

• #deprecate_rule ⇒ Types::DeprecateRule

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

• #fast_restore_rule ⇒ Types::FastRestoreRule

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

• #name ⇒ String

  The name of the schedule.

• #retain_rule ⇒ Types::RetainRule

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

• #share_rules ⇒ Array<Types::ShareRule>

  **[Custom snapshot policies only]** The rule for sharing snapshots with other Amazon Web Services accounts.

• #tags_to_add ⇒ Array<Types::Tag>

  The tags to apply to policy-created resources.

• #variable_tags ⇒ Array<Types::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.

Instance Attribute Details

#archive_rule ⇒ Types::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].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-ami-policy.html#dlm-archive

Returns:

• (Types::ArchiveRule)

# File 'lib/aws-sdk-dlm/types.rb', line 1447

class Schedule < Struct.new(
  :name,
  :copy_tags,
  :tags_to_add,
  :variable_tags,
  :create_rule,
  :retain_rule,
  :fast_restore_rule,
  :cross_region_copy_rules,
  :share_rules,
  :deprecate_rule,
  :archive_rule)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-dlm/types.rb', line 1447

class Schedule < Struct.new(
  :name,
  :copy_tags,
  :tags_to_add,
  :variable_tags,
  :create_rule,
  :retain_rule,
  :fast_restore_rule,
  :cross_region_copy_rules,
  :share_rules,
  :deprecate_rule,
  :archive_rule)
  SENSITIVE = []
  include Aws::Structure
end

#create_rule ⇒ Types::CreateRule

The creation rule.

Returns:

• (Types::CreateRule)

# File 'lib/aws-sdk-dlm/types.rb', line 1447

class Schedule < Struct.new(
  :name,
  :copy_tags,
  :tags_to_add,
  :variable_tags,
  :create_rule,
  :retain_rule,
  :fast_restore_rule,
  :cross_region_copy_rules,
  :share_rules,
  :deprecate_rule,
  :archive_rule)
  SENSITIVE = []
  include Aws::Structure
end

#cross_region_copy_rules ⇒ Array<Types::CrossRegionCopyRule>

Specifies a rule for copying snapshots or AMIs across regions.

<note markdown=“1”> 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.

</note>

Returns:

• (Array<Types::CrossRegionCopyRule>)

# File 'lib/aws-sdk-dlm/types.rb', line 1447

class Schedule < Struct.new(
  :name,
  :copy_tags,
  :tags_to_add,
  :variable_tags,
  :create_rule,
  :retain_rule,
  :fast_restore_rule,
  :cross_region_copy_rules,
  :share_rules,
  :deprecate_rule,
  :archive_rule)
  SENSITIVE = []
  include Aws::Structure
end

#deprecate_rule ⇒ Types::DeprecateRule

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

Returns:

• (Types::DeprecateRule)

# File 'lib/aws-sdk-dlm/types.rb', line 1447

class Schedule < Struct.new(
  :name,
  :copy_tags,
  :tags_to_add,
  :variable_tags,
  :create_rule,
  :retain_rule,
  :fast_restore_rule,
  :cross_region_copy_rules,
  :share_rules,
  :deprecate_rule,
  :archive_rule)
  SENSITIVE = []
  include Aws::Structure
end

#fast_restore_rule ⇒ Types::FastRestoreRule

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

Returns:

• (Types::FastRestoreRule)

# File 'lib/aws-sdk-dlm/types.rb', line 1447

class Schedule < Struct.new(
  :name,
  :copy_tags,
  :tags_to_add,
  :variable_tags,
  :create_rule,
  :retain_rule,
  :fast_restore_rule,
  :cross_region_copy_rules,
  :share_rules,
  :deprecate_rule,
  :archive_rule)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the schedule.

Returns:

• (String)

# File 'lib/aws-sdk-dlm/types.rb', line 1447

class Schedule < Struct.new(
  :name,
  :copy_tags,
  :tags_to_add,
  :variable_tags,
  :create_rule,
  :retain_rule,
  :fast_restore_rule,
  :cross_region_copy_rules,
  :share_rules,
  :deprecate_rule,
  :archive_rule)
  SENSITIVE = []
  include Aws::Structure
end

#retain_rule ⇒ Types::RetainRule

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

Returns:

• (Types::RetainRule)

# File 'lib/aws-sdk-dlm/types.rb', line 1447

class Schedule < Struct.new(
  :name,
  :copy_tags,
  :tags_to_add,
  :variable_tags,
  :create_rule,
  :retain_rule,
  :fast_restore_rule,
  :cross_region_copy_rules,
  :share_rules,
  :deprecate_rule,
  :archive_rule)
  SENSITIVE = []
  include Aws::Structure
end

#share_rules ⇒ Array<Types::ShareRule>

**[Custom snapshot policies only]** The rule for sharing snapshots with other Amazon Web Services accounts.

Returns:

• (Array<Types::ShareRule>)

# File 'lib/aws-sdk-dlm/types.rb', line 1447

class Schedule < Struct.new(
  :name,
  :copy_tags,
  :tags_to_add,
  :variable_tags,
  :create_rule,
  :retain_rule,
  :fast_restore_rule,
  :cross_region_copy_rules,
  :share_rules,
  :deprecate_rule,
  :archive_rule)
  SENSITIVE = []
  include Aws::Structure
end

#tags_to_add ⇒ Array<Types::Tag>

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

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-dlm/types.rb', line 1447

class Schedule < Struct.new(
  :name,
  :copy_tags,
  :tags_to_add,
  :variable_tags,
  :create_rule,
  :retain_rule,
  :fast_restore_rule,
  :cross_region_copy_rules,
  :share_rules,
  :deprecate_rule,
  :archive_rule)
  SENSITIVE = []
  include Aws::Structure
end

#variable_tags ⇒ Array<Types::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.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-dlm/types.rb', line 1447

class Schedule < Struct.new(
  :name,
  :copy_tags,
  :tags_to_add,
  :variable_tags,
  :create_rule,
  :retain_rule,
  :fast_restore_rule,
  :cross_region_copy_rules,
  :share_rules,
  :deprecate_rule,
  :archive_rule)
  SENSITIVE = []
  include Aws::Structure
end