Module types

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that Amazon Data Lifecycle Manager can respond with.

Structs

Action

\[Event-based policies only\] Specifies an action for an event-based policy.

ArchiveRetainRule

\[Custom snapshot policies only\] Specifies information about the archive storage tier retention period.

ArchiveRule

\[Custom snapshot policies only\] Specifies a snapshot archiving rule for a schedule.

CreateRule

\[Custom snapshot and AMI policies only\] Specifies when the policy should create snapshots or AMIs.

• You must specify either CronExpression, or Interval, IntervalUnit, and Times.

• If you need to specify an ArchiveRule for the schedule, then you must specify a creation frequency of at least 28 days.

CrossRegionCopyAction

\[Event-based policies only\] Specifies a cross-Region copy action for event-based policies.

To specify a cross-Region copy rule for snapshot and AMI policies, use CrossRegionCopyRule.

CrossRegionCopyDeprecateRule

\[Custom AMI policies only\] Specifies an AMI deprecation rule for cross-Region AMI copies created by an AMI policy.

CrossRegionCopyRetainRule

Specifies a retention rule for cross-Region snapshot copies created by snapshot or event-based policies, or cross-Region AMI copies created by AMI policies. After the retention period expires, the cross-Region copy is deleted.

CrossRegionCopyRule

\[Custom snapshot and AMI policies only\] Specifies a cross-Region copy rule for a snapshot and AMI policies.

To specify a cross-Region copy action for event-based polices, use CrossRegionCopyAction.

CrossRegionCopyTarget

\[Default policies only\] Specifies a destination Region for cross-Region copy actions.

DeprecateRule

\[Custom AMI policies only\] Specifies an AMI deprecation rule for AMIs created by an AMI lifecycle policy.

For age-based schedules, you must specify Interval and IntervalUnit. For count-based schedules, you must specify Count.

EncryptionConfiguration

\[Event-based policies only\] Specifies the encryption settings for cross-Region snapshot copies created by event-based policies.

EventParameters

\[Event-based policies only\] Specifies an event that activates an event-based policy.

EventSource

\[Event-based policies only\] Specifies an event that activates an event-based policy.

Exclusions

\[Default policies only\] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.

FastRestoreRule

\[Custom snapshot policies only\] Specifies a rule for enabling fast snapshot restore for snapshots created by snapshot policies. You can enable fast snapshot restore based on either a count or a time interval.

LifecyclePolicy

Information about a lifecycle policy.

LifecyclePolicySummary

Summary information about a lifecycle policy.

Parameters

\[Custom snapshot and AMI policies only\] Specifies optional parameters for snapshot and AMI policies. The set of valid parameters depends on the combination of policy type and target resource type.

If you choose to exclude boot volumes and you specify tags that consequently exclude all of the additional data volumes attached to an instance, then Amazon Data Lifecycle Manager will not create any snapshots for the affected instance, and it will emit a SnapshotsCreateFailed Amazon CloudWatch metric. For more information, see Monitor your policies using Amazon CloudWatch.

PolicyDetails

Specifies the configuration of a lifecycle policy.

RetainRule

\[Custom snapshot and AMI policies only\] Specifies a retention rule for snapshots created by snapshot policies, or for AMIs created by AMI policies.

For snapshot policies that have an ArchiveRule, this retention rule applies to standard tier retention. When the retention threshold is met, snapshots are moved from the standard to the archive tier.

For snapshot policies that do not have an ArchiveRule, snapshots are permanently deleted when this retention threshold is met.

You can retain snapshots based on either a count or a time interval.

• Count-based retention

  You must specify Count. If you specify an ArchiveRule for the schedule, then you can specify a retention count of 0 to archive snapshots immediately after creation. If you specify a FastRestoreRule, ShareRule, or a CrossRegionCopyRule, then you must specify a retention count of 1 or more.

• Age-based retention

  You must specify Interval and IntervalUnit. If you specify an ArchiveRule for the schedule, then you can specify a retention interval of 0 days to archive snapshots immediately after creation. If you specify a FastRestoreRule, ShareRule, or a CrossRegionCopyRule, then you must specify a retention interval of 1 day or more.

RetentionArchiveTier

\[Custom snapshot policies only\] Describes the retention rule for archived snapshots. Once the archive retention threshold is met, the snapshots are permanently deleted from the archive tier.

The archive retention rule must retain snapshots in the archive tier for a minimum of 90 days.

For count-based schedules, you must specify Count. For age-based schedules, you must specify Interval and IntervalUnit.

For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies.

Schedule

\[Custom snapshot and AMI policies only\] Specifies a schedule for a snapshot or AMI lifecycle policy.

Script

\[Custom snapshot policies that target instances only\] Information about pre and/or post scripts for a snapshot lifecycle policy that targets instances. For more information, see Automating application-consistent snapshots with pre and post scripts.

ShareRule

\[Custom snapshot policies only\] Specifies a rule for sharing snapshots across Amazon Web Services accounts.

Tag

Specifies a tag for a resource.

Enums

DefaultPoliciesTypeValues

When writing a match expression against DefaultPoliciesTypeValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DefaultPolicyTypeValues

When writing a match expression against DefaultPolicyTypeValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EventSourceValues

When writing a match expression against EventSourceValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EventTypeValues

When writing a match expression against EventTypeValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ExecutionHandlerServiceValues

When writing a match expression against ExecutionHandlerServiceValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GettablePolicyStateValues

When writing a match expression against GettablePolicyStateValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IntervalUnitValues

When writing a match expression against IntervalUnitValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

LocationValues

When writing a match expression against LocationValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PolicyLanguageValues

When writing a match expression against PolicyLanguageValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PolicyTypeValues

When writing a match expression against PolicyTypeValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ResourceLocationValues

When writing a match expression against ResourceLocationValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ResourceTypeValues

When writing a match expression against ResourceTypeValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RetentionIntervalUnitValues

When writing a match expression against RetentionIntervalUnitValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SettablePolicyStateValues

When writing a match expression against SettablePolicyStateValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

StageValues

When writing a match expression against StageValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.