Schedule
[Custom snapshot and AMI policies only] Specifies a schedule for a snapshot or AMI lifecycle policy.
Contents
- 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.
Type: ArchiveRule object
Required: No
- CopyTags
-
Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
Type: Boolean
Required: No
- CreateRule
-
The creation rule.
Type: CreateRule object
Required: No
- CrossRegionCopyRules
-
Specifies a rule for copying snapshots or AMIs across regions.
Note
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.
Type: Array of CrossRegionCopyRule objects
Array Members: Minimum number of 0 items. Maximum number of 3 items.
Required: No
- DeprecateRule
-
[Custom AMI policies only] The AMI deprecation rule for the schedule.
Type: DeprecateRule object
Required: No
- FastRestoreRule
-
[Custom snapshot policies only] The rule for enabling fast snapshot restore.
Type: FastRestoreRule object
Required: No
- Name
-
The name of the schedule.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 120.
Pattern:
[0-9A-Za-z _-]+Required: No
- RetainRule
-
The retention rule for snapshots or AMIs created by the policy.
Type: RetainRule object
Required: No
-
[Custom snapshot policies only] The rule for sharing snapshots with other AWS accounts.
Type: Array of ShareRule objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Required: No
- TagsToAdd
-
The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 45 items.
Required: No
- VariableTags
-
[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.Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 45 items.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
