Schedule ¶

class Schedule(TypedDict, closed=True):
    name: NotRequired["capo_dlm.types.schedule_name.ScheduleName"]
    """<p>The name of the schedule.</p>"""
    copy_tags: NotRequired["capo_dlm.types.copy_tags.CopyTags"]
    """<p>Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.</p>"""
    tags_to_add: NotRequired["capo_dlm.types.tags_to_add_list.TagsToAddList"]
    """<p>The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.</p>"""
    variable_tags: NotRequired["capo_dlm.types.variable_tags_list.VariableTagsList"]
    """<p> <b>[AMI policies and snapshot policies that target instances only]</b> 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: <code>$(instance-id)</code> or <code>$(timestamp)</code>. Variable tags are only valid for EBS Snapshot Management – Instance policies.</p>"""
    create_rule: NotRequired["capo_dlm.types.create_rule.CreateRule"]
    """<p>The creation rule.</p>"""
    retain_rule: NotRequired["capo_dlm.types.retain_rule.RetainRule"]
    """<p>The retention rule for snapshots or AMIs created by the policy.</p>"""
    fast_restore_rule: NotRequired["capo_dlm.types.fast_restore_rule.FastRestoreRule"]
    """<p> <b>[Custom snapshot policies only]</b> The rule for enabling fast snapshot restore.</p>"""
    cross_region_copy_rules: NotRequired[
        "capo_dlm.types.cross_region_copy_rules.CrossRegionCopyRules"
    ]
    """<p>Specifies a rule for copying snapshots or AMIs across Regions.</p> <note> <p>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.</p> </note>"""
    share_rules: NotRequired["capo_dlm.types.share_rules.ShareRules"]
    """<p> <b>[Custom snapshot policies only]</b> The rule for sharing snapshots with other Amazon Web Services accounts.</p>"""
    deprecate_rule: NotRequired["capo_dlm.types.deprecate_rule.DeprecateRule"]
    """<p> <b>[Custom AMI policies only]</b> The AMI deprecation rule for the schedule.</p>"""
    archive_rule: NotRequired["capo_dlm.types.archive_rule.ArchiveRule"]
    """<p> <b>[Custom snapshot policies that target volumes only]</b> 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. </p> <p>For more information about using snapshot archiving, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-ami-policy.html#dlm-archive">Considerations for snapshot lifecycle policies</a>.</p>"""