With Amazon Data Lifecycle Manager, you can manage the lifecycle of your AWS resources. You create lifecycle policies, which are used to automate operations on the specified resources.
Amazon DLM supports Amazon EBS volumes and snapshots. For information about using Amazon DLM with Amazon EBS, see Automating the Amazon EBS Snapshot Lifecycle in the Amazon EC2 User Guide.
", "operations": { "CreateLifecyclePolicy": "Creates a policy to manage the lifecycle of the specified AWS resources. You can create up to 100 lifecycle policies.
", "DeleteLifecyclePolicy": "Deletes the specified lifecycle policy and halts the automated operations that the policy specified.
", "GetLifecyclePolicies": "Gets summary information about all or the specified data lifecycle policies.
To get complete information about a policy, use GetLifecyclePolicy.
", "GetLifecyclePolicy": "Gets detailed information about the specified lifecycle policy.
", "ListTagsForResource": "Lists the tags for the specified resource.
", "TagResource": "Adds the specified tags to the specified resource.
", "UntagResource": "Removes the specified tags from the specified resource.
", "UpdateLifecyclePolicy": "Updates the specified lifecycle policy.
" }, "shapes": { "AvailabilityZone": { "base": null, "refs": { "AvailabilityZoneList$member": null } }, "AvailabilityZoneList": { "base": null, "refs": { "FastRestoreRule$AvailabilityZones": "The Availability Zones in which to enable fast snapshot restore.
" } }, "CmkArn": { "base": null, "refs": { "CrossRegionCopyRule$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.
" } }, "CopyTags": { "base": null, "refs": { "Schedule$CopyTags": "Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
" } }, "CopyTagsNullable": { "base": null, "refs": { "CrossRegionCopyRule$CopyTags": "Copy all user-defined tags from the source snapshot to the copied snapshot.
" } }, "Count": { "base": null, "refs": { "FastRestoreRule$Count": "The number of snapshots to be enabled with fast snapshot restore.
", "RetainRule$Count": "The number of snapshots to retain for each volume, up to a maximum of 1000.
" } }, "CreateLifecyclePolicyRequest": { "base": null, "refs": { } }, "CreateLifecyclePolicyResponse": { "base": null, "refs": { } }, "CreateRule": { "base": "Specifies when to create snapshots of EBS volumes.
You must specify either a Cron expression or an interval, interval unit, and start time. You cannot specify both.
", "refs": { "Schedule$CreateRule": "The creation rule.
" } }, "CronExpression": { "base": null, "refs": { "CreateRule$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.
" } }, "CrossRegionCopyRetainRule": { "base": "Specifies the retention rule for cross-Region snapshot copies.
", "refs": { "CrossRegionCopyRule$RetainRule": "The retention rule.
" } }, "CrossRegionCopyRule": { "base": "Specifies a rule for cross-Region snapshot copies.
", "refs": { "CrossRegionCopyRules$member": null } }, "CrossRegionCopyRules": { "base": null, "refs": { "Schedule$CrossRegionCopyRules": "The rule for cross-Region snapshot copies.
" } }, "DeleteLifecyclePolicyRequest": { "base": null, "refs": { } }, "DeleteLifecyclePolicyResponse": { "base": null, "refs": { } }, "Encrypted": { "base": null, "refs": { "CrossRegionCopyRule$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.
" } }, "ErrorCode": { "base": null, "refs": { "InternalServerException$Code": null, "InvalidRequestException$Code": null, "LimitExceededException$Code": null, "ResourceNotFoundException$Code": null } }, "ErrorMessage": { "base": null, "refs": { "InternalServerException$Message": null, "InvalidRequestException$Message": null, "LimitExceededException$Message": null, "ResourceNotFoundException$Message": null } }, "ExcludeBootVolume": { "base": null, "refs": { "Parameters$ExcludeBootVolume": "[EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots. The default is false.
" } }, "ExecutionRoleArn": { "base": null, "refs": { "CreateLifecyclePolicyRequest$ExecutionRoleArn": "The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
", "LifecyclePolicy$ExecutionRoleArn": "The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
", "UpdateLifecyclePolicyRequest$ExecutionRoleArn": "The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
" } }, "FastRestoreRule": { "base": "Specifies a rule for enabling fast snapshot restore. You can enable fast snapshot restore based on either a count or a time interval.
", "refs": { "Schedule$FastRestoreRule": "The rule for enabling fast snapshot restore.
" } }, "GetLifecyclePoliciesRequest": { "base": null, "refs": { } }, "GetLifecyclePoliciesResponse": { "base": null, "refs": { } }, "GetLifecyclePolicyRequest": { "base": null, "refs": { } }, "GetLifecyclePolicyResponse": { "base": null, "refs": { } }, "GettablePolicyStateValues": { "base": null, "refs": { "GetLifecyclePoliciesRequest$State": "The activation state.
", "LifecyclePolicy$State": "The activation state of the lifecycle policy.
", "LifecyclePolicySummary$State": "The activation state of the lifecycle policy.
" } }, "InternalServerException": { "base": "The service failed in an unexpected way.
", "refs": { } }, "Interval": { "base": null, "refs": { "CreateRule$Interval": "The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
", "CrossRegionCopyRetainRule$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.
", "FastRestoreRule$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.
", "RetainRule$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.
" } }, "IntervalUnitValues": { "base": null, "refs": { "CreateRule$IntervalUnit": "The interval unit.
" } }, "InvalidRequestException": { "base": "Bad request. The request is missing required parameters or has invalid parameters.
", "refs": { } }, "LifecyclePolicy": { "base": "Detailed information about a lifecycle policy.
", "refs": { "GetLifecyclePolicyResponse$Policy": "Detailed information about the lifecycle policy.
" } }, "LifecyclePolicySummary": { "base": "Summary information about a lifecycle policy.
", "refs": { "LifecyclePolicySummaryList$member": null } }, "LifecyclePolicySummaryList": { "base": null, "refs": { "GetLifecyclePoliciesResponse$Policies": "Summary information about the lifecycle policies.
" } }, "LimitExceededException": { "base": "The request failed because a limit was exceeded.
", "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "Parameter": { "base": null, "refs": { "ParameterList$member": null } }, "ParameterList": { "base": null, "refs": { "InvalidRequestException$RequiredParameters": "The request omitted one or more required parameters.
", "InvalidRequestException$MutuallyExclusiveParameters": "The request included parameters that cannot be provided together.
" } }, "Parameters": { "base": "Specifies optional parameters to add to a policy. The set of valid parameters depends on the combination of policy type and resource type.
", "refs": { "PolicyDetails$Parameters": "A set of optional parameters for the policy.
" } }, "PolicyArn": { "base": null, "refs": { "LifecyclePolicy$PolicyArn": "The Amazon Resource Name (ARN) of the policy.
", "ListTagsForResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource.
", "TagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource.
", "UntagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource.
" } }, "PolicyDescription": { "base": null, "refs": { "CreateLifecyclePolicyRequest$Description": "A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
", "LifecyclePolicy$Description": "The description of the lifecycle policy.
", "LifecyclePolicySummary$Description": "The description of the lifecycle policy.
", "UpdateLifecyclePolicyRequest$Description": "A description of the lifecycle policy.
" } }, "PolicyDetails": { "base": "Specifies the configuration of a lifecycle policy.
", "refs": { "CreateLifecyclePolicyRequest$PolicyDetails": "The configuration details of the lifecycle policy.
", "LifecyclePolicy$PolicyDetails": "The configuration of the lifecycle policy
", "UpdateLifecyclePolicyRequest$PolicyDetails": "The configuration of the lifecycle policy. You cannot update the policy type or the resource type.
" } }, "PolicyId": { "base": null, "refs": { "CreateLifecyclePolicyResponse$PolicyId": "The identifier of the lifecycle policy.
", "DeleteLifecyclePolicyRequest$PolicyId": "The identifier of the lifecycle policy.
", "GetLifecyclePolicyRequest$PolicyId": "The identifier of the lifecycle policy.
", "LifecyclePolicy$PolicyId": "The identifier of the lifecycle policy.
", "LifecyclePolicySummary$PolicyId": "The identifier of the lifecycle policy.
", "PolicyIdList$member": null, "UpdateLifecyclePolicyRequest$PolicyId": "The identifier of the lifecycle policy.
" } }, "PolicyIdList": { "base": null, "refs": { "GetLifecyclePoliciesRequest$PolicyIds": "The identifiers of the data lifecycle policies.
", "ResourceNotFoundException$ResourceIds": "Value is a list of resource IDs that were not found.
" } }, "PolicyTypeValues": { "base": null, "refs": { "PolicyDetails$PolicyType": "The valid target resource types and actions a policy can manage. The default is EBS_SNAPSHOT_MANAGEMENT.
" } }, "ResourceNotFoundException": { "base": "A requested resource was not found.
", "refs": { } }, "ResourceTypeValues": { "base": null, "refs": { "ResourceTypeValuesList$member": null } }, "ResourceTypeValuesList": { "base": null, "refs": { "GetLifecyclePoliciesRequest$ResourceTypes": "The resource type.
", "PolicyDetails$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.
" } }, "RetainRule": { "base": "Specifies the retention rule for a lifecycle policy. You can retain snapshots based on either a count or a time interval.
", "refs": { "Schedule$RetainRule": "The retention rule.
" } }, "RetentionIntervalUnitValues": { "base": null, "refs": { "CrossRegionCopyRetainRule$IntervalUnit": "The unit of time for time-based retention.
", "FastRestoreRule$IntervalUnit": "The unit of time for enabling fast snapshot restore.
", "RetainRule$IntervalUnit": "The unit of time for time-based retention.
" } }, "Schedule": { "base": "Specifies a backup schedule.
", "refs": { "ScheduleList$member": null } }, "ScheduleList": { "base": null, "refs": { "PolicyDetails$Schedules": "The schedule of policy-defined actions.
" } }, "ScheduleName": { "base": null, "refs": { "Schedule$Name": "The name of the schedule.
" } }, "SettablePolicyStateValues": { "base": null, "refs": { "CreateLifecyclePolicyRequest$State": "The desired activation state of the lifecycle policy after creation.
", "UpdateLifecyclePolicyRequest$State": "The desired activation state of the lifecycle policy after creation.
" } }, "StatusMessage": { "base": null, "refs": { "LifecyclePolicy$StatusMessage": "The description of the status.
" } }, "String": { "base": null, "refs": { "LimitExceededException$ResourceType": "Value is the type of resource for which a limit was exceeded.
", "ResourceNotFoundException$ResourceType": "Value is the type of resource that was not found.
", "Tag$Key": "The tag key.
", "Tag$Value": "The tag value.
" } }, "Tag": { "base": "Specifies a tag for a resource.
", "refs": { "TagsToAddList$member": null, "TargetTagList$member": null, "VariableTagsList$member": null } }, "TagFilter": { "base": null, "refs": { "TagsToAddFilterList$member": null, "TargetTagsFilterList$member": null } }, "TagKey": { "base": null, "refs": { "TagKeyList$member": null, "TagMap$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$TagKeys": "The tag keys.
" } }, "TagMap": { "base": null, "refs": { "CreateLifecyclePolicyRequest$Tags": "The tags to apply to the lifecycle policy during creation.
", "LifecyclePolicy$Tags": "The tags.
", "LifecyclePolicySummary$Tags": "The tags.
", "ListTagsForResourceResponse$Tags": "Information about the tags.
", "TagResourceRequest$Tags": "One or more tags.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "TagMap$value": null } }, "TagsToAddFilterList": { "base": null, "refs": { "GetLifecyclePoliciesRequest$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.
" } }, "TagsToAddList": { "base": null, "refs": { "Schedule$TagsToAdd": "The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.
" } }, "TargetRegion": { "base": null, "refs": { "CrossRegionCopyRule$TargetRegion": "The target Region.
" } }, "TargetTagList": { "base": null, "refs": { "PolicyDetails$TargetTags": "The single tag that identifies targeted resources for this policy.
" } }, "TargetTagsFilterList": { "base": null, "refs": { "GetLifecyclePoliciesRequest$TargetTags": "The target tag for a policy.
Tags are strings in the format key=value.
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.
" } }, "Timestamp": { "base": null, "refs": { "LifecyclePolicy$DateCreated": "The local date and time when the lifecycle policy was created.
", "LifecyclePolicy$DateModified": "The local date and time when the lifecycle policy was last modified.
" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateLifecyclePolicyRequest": { "base": null, "refs": { } }, "UpdateLifecyclePolicyResponse": { "base": null, "refs": { } }, "VariableTagsList": { "base": null, "refs": { "Schedule$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.