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.
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 DLM 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 targetRegion
The target Region.
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 AWS KMS customer master key (CMK) to use for EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used.
Boolean copyTags
Copy all user-defined tags from the source snapshot to the copied snapshot.
CrossRegionCopyRetainRule retainRule
The retention rule.
String policyId
The identifier of the lifecycle policy.
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 AWS-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.
String resourceArn
The Amazon Resource Name (ARN) of the resource.
Boolean excludeBootVolume
[EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots. The default is false.
Boolean noReboot
Applies to AMI lifecycle 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 (instance are not rebooted).
String policyType
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. The
default is EBS_SNAPSHOT_MANAGEMENT.
List<E> resourceTypes
The resource type. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.
List<E> targetTags
The single tag that identifies targeted resources for this policy.
List<E> schedules
The schedules of policy-defined actions. A policy can have up to four schedules - one mandatory schedule and up to three optional schedules.
Parameters parameters
A set of optional parameters for the policy.
Integer count
The number of snapshots to retain for each volume, up to a maximum of 1000.
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.
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 AWS-added lifecycle tags.
List<E> variableTags
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.
FastRestoreRule fastRestoreRule
The rule for enabling fast snapshot restore.
List<E> crossRegionCopyRules
The rule for cross-Region snapshot copies.
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 © 2020. All rights reserved.