RetentionArchiveTier retentionArchiveTier
Information about retention period in the Amazon EBS Snapshots Archive. For more information, see Archive Amazon EBS snapshots.
ArchiveRetainRule retainRule
Information about the retention period for the snapshot archiving rule.
String executionRoleArn
The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
String description
A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
String state
The desired activation state of the lifecycle policy after creation.
PolicyDetails policyDetails
The configuration details of the lifecycle policy.
Map<K,V> tags
The tags to apply to the lifecycle policy during creation.
String policyId
The identifier of the lifecycle policy.
String location
[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.
Integer interval
The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
String intervalUnit
The interval unit.
List<E> times
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.
String cronExpression
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.
String target
The target Region.
EncryptionConfiguration encryptionConfiguration
The encryption settings for the copied snapshot.
CrossRegionCopyRetainRule retainRule
Integer interval
The period after which to deprecate the cross-Region AMI copies. The period must be less than or equal to the cross-Region AMI copy retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
String intervalUnit
The unit of time in which to measure the Interval. For example, to deprecate a cross-Region AMI copy after
3 months, specify Interval=3 and IntervalUnit=MONTHS.
Integer interval
The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
String intervalUnit
The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify
Interval=3 and IntervalUnit=MONTHS.
String targetRegion
Avoid using this parameter when creating new policies. Instead, use Target to specify a target Region or a target Outpost for snapshot copies.
For policies created before the Target parameter was introduced, this parameter indicates the target Region for snapshot copies.
String target
The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
Use this parameter instead of TargetRegion. Do not specify both.
Boolean encrypted
To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled.
String cmkArn
The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
Boolean copyTags
Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.
CrossRegionCopyRetainRule retainRule
The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.
CrossRegionCopyDeprecateRule deprecateRule
[AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
String policyId
The identifier of the lifecycle policy.
Integer count
If the schedule has a count-based retention rule, this parameter specifies the number of oldest AMIs to deprecate. The count must be less than or equal to the schedule's retention count, and it can't be greater than 1000.
Integer interval
If the schedule has an age-based retention rule, this parameter specifies the period after which to deprecate AMIs created by the schedule. The period must be less than or equal to the schedule's retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
String intervalUnit
The unit of time in which to measure the Interval.
Boolean encrypted
To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when encryption by default is not enabled.
String cmkArn
The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
String eventType
The type of event. Currently, only snapshot sharing events are supported.
List<E> snapshotOwner
The IDs of the Amazon Web Services accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified Amazon Web Services accounts shares a snapshot with your account.
String descriptionRegex
The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.
For example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$ configures the policy to
run only if snapshots created by policy policy-1234567890abcdef0 are shared with your account.
String type
The source of the event. Currently only managed CloudWatch Events rules are supported.
EventParameters parameters
Information about the event.
Integer count
The number of snapshots to be enabled with fast snapshot restore.
Integer interval
The amount of time to enable fast snapshot restore. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
String intervalUnit
The unit of time for enabling fast snapshot restore.
List<E> availabilityZones
The Availability Zones in which to enable fast snapshot restore.
List<E> policyIds
The identifiers of the data lifecycle policies.
String state
The activation state.
List<E> resourceTypes
The resource type.
List<E> targetTags
The target tag for a policy.
Tags are strings in the format key=value.
List<E> tagsToAdd
The tags to add to objects created by the policy.
Tags are strings in the format key=value.
These user-defined tags are added in addition to the Amazon Web Services-added lifecycle tags.
String policyId
The identifier of the lifecycle policy.
LifecyclePolicy policy
Detailed information about the lifecycle policy.
String code
String policyId
The identifier of the lifecycle policy.
String description
The description of the lifecycle policy.
String state
The activation state of the lifecycle policy.
String statusMessage
The description of the status.
String executionRoleArn
The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
Date dateCreated
The local date and time when the lifecycle policy was created.
Date dateModified
The local date and time when the lifecycle policy was last modified.
PolicyDetails policyDetails
The configuration of the lifecycle policy
Map<K,V> tags
The tags.
String policyArn
The Amazon Resource Name (ARN) of the policy.
String policyId
The identifier of the lifecycle policy.
String description
The description of the lifecycle policy.
String state
The activation state of the lifecycle policy.
Map<K,V> tags
The tags.
String policyType
The type of policy. EBS_SNAPSHOT_MANAGEMENT indicates that the policy manages the lifecycle of
Amazon EBS snapshots. IMAGE_MANAGEMENT indicates that the policy manages the lifecycle of EBS-backed
AMIs. EVENT_BASED_POLICY indicates that the policy automates cross-account snapshot copies for
snapshots that are shared with your account.
String resourceArn
The Amazon Resource Name (ARN) of the resource.
Boolean excludeBootVolume
[Snapshot policies that target instances only] Indicates whether to exclude the root volume from
multi-volume snapshot sets. The default is false. If you specify true, then the root
volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the
policy.
Boolean noReboot
[AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs.
true indicates that targeted instances are not rebooted when the policy runs. false
indicates that target instances are rebooted when the policy runs. The default is true (instances
are not rebooted).
List<E> excludeDataVolumeTags
[Snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.
If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.
String policyType
[All policy types] The valid target resource types and actions a policy can manage. Specify
EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS
snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of
EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific
actions when a defined event occurs in your Amazon Web Services account.
The default is EBS_SNAPSHOT_MANAGEMENT.
List<E> resourceTypes
[Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use
VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume
snapshots from the volumes for an instance.
List<E> resourceLocations
[Snapshot and AMI policies only] The location of the resources to backup. If the source resources are
located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an
Outpost in your account, specify OUTPOST.
If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type
with matching target tags across all of the Outposts in your account.
List<E> targetTags
[Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
List<E> schedules
[Snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.
Parameters parameters
[Snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.
If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.
EventSource eventSource
[Event-based policies only] The event that activates the event-based policy.
List<E> actions
[Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.
Integer count
The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to retain a
maximum of three snapshots, specify 3. When the fourth snapshot is created, the oldest retained
snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
Integer interval
The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
String intervalUnit
The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify
Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3 months,
it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
Integer count
The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days.
Integer interval
Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
String intervalUnit
The unit of time in which to measure the Interval. For example, to retain a snapshots in the archive tier
for 6 months, specify Interval=6 and IntervalUnit=MONTHS.
String name
The name of the schedule.
Boolean copyTags
Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
List<E> tagsToAdd
The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
List<E> 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.
CreateRule createRule
The creation rule.
RetainRule retainRule
The retention rule for snapshots or AMIs created by the policy.
FastRestoreRule fastRestoreRule
[Snapshot policies only] The rule for enabling fast snapshot restore.
List<E> crossRegionCopyRules
Specifies a rule for copying snapshots or AMIs across regions.
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.
List<E> shareRules
[Snapshot policies only] The rule for sharing snapshots with other Amazon Web Services accounts.
DeprecateRule deprecateRule
[AMI policies only] The AMI deprecation rule for the schedule.
ArchiveRule archiveRule
[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.
List<E> targetAccounts
The IDs of the Amazon Web Services accounts with which to share the snapshots.
Integer unshareInterval
The period after which snapshots that are shared with other Amazon Web Services accounts are automatically unshared.
String unshareIntervalUnit
The unit of time for the automatic unsharing interval.
String policyId
The identifier of the lifecycle policy.
String executionRoleArn
The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
String state
The desired activation state of the lifecycle policy after creation.
String description
A description of the lifecycle policy.
PolicyDetails policyDetails
The configuration of the lifecycle policy. You cannot update the policy type or the resource type.
Copyright © 2022. All rights reserved.