The Amazon Data Lifecycle Manager API contains several data types that various actions use. This section describes each data type in detail.
Note
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• Action (p. 28)
• CreateRule (p. 29)
• CrossRegionCopyAction (p. 31)
• CrossRegionCopyDeprecateRule (p. 32)
• CrossRegionCopyRetainRule (p. 33)
• CrossRegionCopyRule (p. 34)
• DeprecateRule (p. 36)
• EncryptionConfiguration (p. 37)
• EventParameters (p. 38)
• EventSource (p. 40)
• FastRestoreRule (p. 41)
• LifecyclePolicy (p. 43)
• LifecyclePolicySummary (p. 46)
• Parameters (p. 48)
• PolicyDetails (p. 49)
• RetainRule (p. 52)
• Schedule (p. 53)
• ShareRule (p. 55)
• Tag (p. 56)
Action
Action
Specifies an action for an event-based policy.
Contents
CrossRegionCopy
The rule for copying shared snapshots across Regions.
Type: Array of CrossRegionCopyAction (p. 31) objects
Array Members: Minimum number of 0 items. Maximum number of 3 items.
Required: Yes Name
A descriptive name for the action.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 120.
Pattern: [0-9A-Za-z _-]+
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CreateRule
CreateRule
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.
Contents
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.
Type: String
Length Constraints: Minimum length of 17. Maximum length of 106.
Pattern: cron\([^\n]{11,100}\) Required: No
Interval
The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
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 AWS 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.
Type: String
Valid Values: CLOUD | OUTPOST_LOCAL Required: No
Times
The time, in UTC, to start the operation. The supported format is hh:mm.
See Also
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.
Type: Array of strings
Array Members: Maximum number of 1 item.
Length Constraints: Fixed length of 5.
Pattern: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CrossRegionCopyAction
CrossRegionCopyAction
Specifies a rule for copying shared snapshots across Regions.
Contents
EncryptionConfiguration
The encryption settings for the copied snapshot.
Type: EncryptionConfiguration (p. 37) object Required: Yes
RetainRule
Specifies the retention rule for cross-Region snapshot copies.
Type: CrossRegionCopyRetainRule (p. 33) object Required: No
Target
The target Region.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: ^[\w:\-\/\*]+$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CrossRegionCopyDeprecateRule
CrossRegionCopyDeprecateRule
Specifies an AMI deprecation rule for cross-Region AMI copies created by a cross-Region copy rule.
Contents
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.
Type: Integer
Valid Range: Minimum value of 1.
Required: No IntervalUnit
The unit of time in which to measure the Interval.
Type: String
Valid Values: DAYS | WEEKS | MONTHS | YEARS Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CrossRegionCopyRetainRule
CrossRegionCopyRetainRule
Specifies the retention rule for cross-Region snapshot copies.
Contents
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.
Type: Integer
Valid Range: Minimum value of 1.
Required: No IntervalUnit
The unit of time for time-based retention.
Type: String
Valid Values: DAYS | WEEKS | MONTHS | YEARS Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CrossRegionCopyRule
CrossRegionCopyRule
Specifies a rule for cross-Region snapshot copies.
Contents
CmkArn
The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: arn:aws(-[a-z]{1,3}){0,2}:kms:([a-z]+-){2,3}\d:\d+:key/.*
Required: No CopyTags
Indicates whether to copy all user-defined tags from the source snapshot to the cross-Region snapshot copy.
Type: Boolean Required: No DeprecateRule
The AMI deprecation rule for cross-Region AMI copies created by the rule.
Type: CrossRegionCopyDeprecateRule (p. 32) object Required: No
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.
Type: Boolean Required: Yes RetainRule
The retention rule that indicates how long snapshot copies are to be retained in the destination Region.
Type: CrossRegionCopyRetainRule (p. 33) object Required: No
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.
Type: String
See Also
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: ^[\w:\-\/\*]+$
Required: No 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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 16.
Pattern: ([a-z]+-){2,3}\d Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DeprecateRule
DeprecateRule
Specifies an AMI deprecation rule for a schedule.
Contents
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No 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.
Type: Integer
Valid Range: Minimum value of 1.
Required: No IntervalUnit
The unit of time in which to measure the Interval.
Type: String
Valid Values: DAYS | WEEKS | MONTHS | YEARS Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3