Serialized Form (AWS Java SDK for Amazon Data Lifecycle Manager 1.12.630 API)

Package com.amazonaws.services.dlm.model
- Class com.amazonaws.services.dlm.model.Action extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      A descriptive name for the action.
    - crossRegionCopy
```
List<E> crossRegionCopy
```
      The rule for copying shared snapshots across Regions.
- Class com.amazonaws.services.dlm.model.AmazonDLMException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.dlm.model.ArchiveRetainRule extends Object implements Serializable
  - Serialized Fields
    - retentionArchiveTier
```
RetentionArchiveTier retentionArchiveTier
```
      Information about retention period in the Amazon EBS Snapshots Archive. For more information, see Archive Amazon EBS snapshots.
- Class com.amazonaws.services.dlm.model.ArchiveRule extends Object implements Serializable
  - Serialized Fields
    - retainRule
```
ArchiveRetainRule retainRule
```
      Information about the retention period for the snapshot archiving rule.
- Class com.amazonaws.services.dlm.model.CreateLifecyclePolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - executionRoleArn
```
String executionRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
    - description
```
String description
```
      A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
    - state
```
String state
```
      The activation state of the lifecycle policy after creation.
    - policyDetails
```
PolicyDetails policyDetails
```
      The configuration details of the lifecycle policy.
      
      If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.
    - tags
```
Map<K,V> tags
```
      The tags to apply to the lifecycle policy during creation.
    - defaultPolicy
```
String defaultPolicy
```
      [Default policies only] Specify the type of default policy to create.
      
      To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.
      
      To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.
    - createInterval
```
Integer createInterval
```
      [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.
      
      Default: 1
    - retainInterval
```
Integer retainInterval
```
      [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.
      
      Default: 7
    - copyTags
```
Boolean copyTags
```
      [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.
      
      Default: false
    - extendDeletion
```
Boolean extendDeletion
```
      [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.
      
      By default (ExtendDeletion=false):
      
      If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true.
      
      If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true.
      
      If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.
      
      If you do not specify a value, the default is false.
      
      Default: false
    - crossRegionCopyTargets
```
List<E> crossRegionCopyTargets
```
      [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
    - exclusions
```
Exclusions 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.
- Class com.amazonaws.services.dlm.model.CreateLifecyclePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - policyId
```
String policyId
```
      The identifier of the lifecycle policy.
- Class com.amazonaws.services.dlm.model.CreateRule extends Object implements Serializable
  - Serialized Fields
    - location
```
String location
```
      [Custom 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.
    - interval
```
Integer interval
```
      The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
    - intervalUnit
```
String intervalUnit
```
      The interval unit.
    - times
```
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.
    - cronExpression
```
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.
    - scripts
```
List<E> scripts
```
      [Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.
      
      For more information, see Automating application-consistent snapshots with pre and post scripts.
- Class com.amazonaws.services.dlm.model.CrossRegionCopyAction extends Object implements Serializable
  - Serialized Fields
    - target
```
String target
```
      The target Region.
    - encryptionConfiguration
```
EncryptionConfiguration encryptionConfiguration
```
      The encryption settings for the copied snapshot.
    - retainRule
```
CrossRegionCopyRetainRule retainRule
```
- Class com.amazonaws.services.dlm.model.CrossRegionCopyDeprecateRule extends Object implements Serializable
  - Serialized Fields
    - interval
```
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.
    - intervalUnit
```
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.
- Class com.amazonaws.services.dlm.model.CrossRegionCopyRetainRule extends Object implements Serializable
  - Serialized Fields
    - interval
```
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.
    - intervalUnit
```
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.
- Class com.amazonaws.services.dlm.model.CrossRegionCopyRule extends Object implements Serializable
  - Serialized Fields
    - targetRegion
```
String targetRegion
```
      Use this parameter for AMI policies only. For snapshot policies, use Target instead. For snapshot policies created before the Target parameter was introduced, this parameter indicates the target Region for snapshot copies.
      
      [Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
    - target
```
String target
```
      Use this parameter for snapshot policies only. For AMI policies, use TargetRegion instead.
      
      [Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
    - encrypted
```
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.
    - cmkArn
```
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.
    - copyTags
```
Boolean copyTags
```
      Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.
    - retainRule
```
CrossRegionCopyRetainRule retainRule
```
      The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.
    - deprecateRule
```
CrossRegionCopyDeprecateRule deprecateRule
```
      [Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
- Class com.amazonaws.services.dlm.model.CrossRegionCopyTarget extends Object implements Serializable
  - Serialized Fields
    - targetRegion
```
String targetRegion
```
      The target Region, for example us-east-1.
- Class com.amazonaws.services.dlm.model.DeleteLifecyclePolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - policyId
```
String policyId
```
      The identifier of the lifecycle policy.
- Class com.amazonaws.services.dlm.model.DeleteLifecyclePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.dlm.model.DeprecateRule extends Object implements Serializable
  - Serialized Fields
    - count
```
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.
    - interval
```
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.
    - intervalUnit
```
String intervalUnit
```
      The unit of time in which to measure the Interval.
- Class com.amazonaws.services.dlm.model.EncryptionConfiguration extends Object implements Serializable
  - Serialized Fields
    - encrypted
```
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.
    - cmkArn
```
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.
- Class com.amazonaws.services.dlm.model.EventParameters extends Object implements Serializable
  - Serialized Fields
    - eventType
```
String eventType
```
      The type of event. Currently, only snapshot sharing events are supported.
    - snapshotOwner
```
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.
    - descriptionRegex
```
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.
- Class com.amazonaws.services.dlm.model.EventSource extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The source of the event. Currently only managed CloudWatch Events rules are supported.
    - parameters
```
EventParameters parameters
```
      Information about the event.
- Class com.amazonaws.services.dlm.model.Exclusions extends Object implements Serializable
  - Serialized Fields
    - excludeBootVolumes
```
Boolean excludeBootVolumes
```
      [Default policies for EBS snapshots only] Indicates whether to exclude volumes that are attached to instances as the boot volume. If you exclude boot volumes, only volumes attached as data (non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify true.
    - excludeVolumeTypes
```
List<E> excludeVolumeTypes
```
      [Default policies for EBS snapshots only] Specifies the volume types to exclude. Volumes of the specified types will not be targeted by the policy.
    - excludeTags
```
List<E> excludeTags
```
      [Default policies for EBS-backed AMIs only] Specifies whether to exclude volumes that have specific tags.
- Class com.amazonaws.services.dlm.model.FastRestoreRule extends Object implements Serializable
  - Serialized Fields
    - count
```
Integer count
```
      The number of snapshots to be enabled with fast snapshot restore.
    - interval
```
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.
    - intervalUnit
```
String intervalUnit
```
      The unit of time for enabling fast snapshot restore.
    - availabilityZones
```
List<E> availabilityZones
```
      The Availability Zones in which to enable fast snapshot restore.
- Class com.amazonaws.services.dlm.model.GetLifecyclePoliciesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - policyIds
```
List<E> policyIds
```
      The identifiers of the data lifecycle policies.
    - state
```
String state
```
      The activation state.
    - resourceTypes
```
List<E> resourceTypes
```
      The resource type.
    - targetTags
```
List<E> targetTags
```
      The target tag for a policy.
      
      Tags are strings in the format key=value.
    - tagsToAdd
```
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.
    - defaultPolicyType
```
String defaultPolicyType
```
      [Default policies only] Specifies the type of default policy to get. Specify one of the following:
      
      VOLUME - To get only the default policy for EBS snapshots
      
      INSTANCE - To get only the default policy for EBS-backed AMIs
      
      ALL - To get all default policies
- Class com.amazonaws.services.dlm.model.GetLifecyclePoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - policies
```
List<E> policies
```
      Summary information about the lifecycle policies.
- Class com.amazonaws.services.dlm.model.GetLifecyclePolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - policyId
```
String policyId
```
      The identifier of the lifecycle policy.
- Class com.amazonaws.services.dlm.model.GetLifecyclePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - policy
```
LifecyclePolicy policy
```
      Detailed information about the lifecycle policy.
- Class com.amazonaws.services.dlm.model.InternalServerException extends AmazonDLMException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
- Class com.amazonaws.services.dlm.model.InvalidRequestException extends AmazonDLMException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
    - requiredParameters
```
List<E> requiredParameters
```
      The request omitted one or more required parameters.
    - mutuallyExclusiveParameters
```
List<E> mutuallyExclusiveParameters
```
      The request included parameters that cannot be provided together.
- Class com.amazonaws.services.dlm.model.LifecyclePolicy extends Object implements Serializable
  - Serialized Fields
    - policyId
```
String policyId
```
      The identifier of the lifecycle policy.
    - description
```
String description
```
      The description of the lifecycle policy.
    - state
```
String state
```
      The activation state of the lifecycle policy.
    - statusMessage
```
String statusMessage
```
      The description of the status.
    - executionRoleArn
```
String executionRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
    - dateCreated
```
Date dateCreated
```
      The local date and time when the lifecycle policy was created.
    - dateModified
```
Date dateModified
```
      The local date and time when the lifecycle policy was last modified.
    - policyDetails
```
PolicyDetails policyDetails
```
      The configuration of the lifecycle policy
    - tags
```
Map<K,V> tags
```
      The tags.
    - policyArn
```
String policyArn
```
      The Amazon Resource Name (ARN) of the policy.
    - defaultPolicy
```
Boolean defaultPolicy
```
      [Default policies only] The type of default policy. Values include:
      
      VOLUME - Default policy for EBS snapshots
      
      INSTANCE - Default policy for EBS-backed AMIs
- Class com.amazonaws.services.dlm.model.LifecyclePolicySummary extends Object implements Serializable
  - Serialized Fields
    - policyId
```
String policyId
```
      The identifier of the lifecycle policy.
    - description
```
String description
```
      The description of the lifecycle policy.
    - state
```
String state
```
      The activation state of the lifecycle policy.
    - tags
```
Map<K,V> tags
```
      The tags.
    - policyType
```
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.
    - defaultPolicy
```
Boolean defaultPolicy
```
      [Default policies only] The type of default policy. Values include:
      
      VOLUME - Default policy for EBS snapshots
      
      INSTANCE - Default policy for EBS-backed AMIs
- Class com.amazonaws.services.dlm.model.LimitExceededException extends AmazonDLMException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
    - resourceType
```
String resourceType
```
      Value is the type of resource for which a limit was exceeded.
- Class com.amazonaws.services.dlm.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the resource.
- Class com.amazonaws.services.dlm.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
Map<K,V> tags
```
      Information about the tags.
- Class com.amazonaws.services.dlm.model.Parameters extends Object implements Serializable
  - Serialized Fields
    - excludeBootVolume
```
Boolean excludeBootVolume
```
      [Custom 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.
    - noReboot
```
Boolean noReboot
```
      [Custom 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).
    - excludeDataVolumeTags
```
List<E> excludeDataVolumeTags
```
      [Custom 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.
- Class com.amazonaws.services.dlm.model.PolicyDetails extends Object implements Serializable
  - Serialized Fields
    - policyType
```
String policyType
```
      [Custom policies only] 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.
    - resourceTypes
```
List<E> resourceTypes
```
      [Custom 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.
    - resourceLocations
```
List<E> resourceLocations
```
      [Custom 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.
    - targetTags
```
List<E> targetTags
```
      [Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
    - schedules
```
List<E> schedules
```
      [Custom 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 parameters
```
      [Custom 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 eventSource
```
      [Event-based policies only] The event that activates the event-based policy.
    - actions
```
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.
    - policyLanguage
```
String policyLanguage
```
      The type of policy to create. Specify one of the following:
      
      SIMPLIFIED To create a default policy.
      
      STANDARD To create a custom policy.
    - resourceType
```
String resourceType
```
      [Default policies only] Specify the type of default policy to create.
      
      To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.
      
      To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.
    - createInterval
```
Integer createInterval
```
      [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.
      
      Default: 1
    - retainInterval
```
Integer retainInterval
```
      [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.
      
      Default: 7
    - copyTags
```
Boolean copyTags
```
      [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.
      
      Default: false
    - crossRegionCopyTargets
```
List<E> crossRegionCopyTargets
```
      [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
    - extendDeletion
```
Boolean extendDeletion
```
      [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.
      
      By default (ExtendDeletion=false):
      
      If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true.
      
      If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true.
      
      If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.
      
      If you do not specify a value, the default is false.
      
      Default: false
    - exclusions
```
Exclusions 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.
- Class com.amazonaws.services.dlm.model.ResourceNotFoundException extends AmazonDLMException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
    - resourceType
```
String resourceType
```
      Value is the type of resource that was not found.
    - resourceIds
```
List<E> resourceIds
```
      Value is a list of resource IDs that were not found.
- Class com.amazonaws.services.dlm.model.RetainRule extends Object implements Serializable
  - Serialized Fields
    - count
```
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.
    - interval
```
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.
    - intervalUnit
```
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.
- Class com.amazonaws.services.dlm.model.RetentionArchiveTier extends Object implements Serializable
  - Serialized Fields
    - count
```
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.
    - interval
```
Integer interval
```
      Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
    - intervalUnit
```
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.
- Class com.amazonaws.services.dlm.model.Schedule extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the schedule.
    - copyTags
```
Boolean copyTags
```
      Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
    - tagsToAdd
```
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.
    - variableTags
```
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 createRule
```
      The creation rule.
    - retainRule
```
RetainRule retainRule
```
      The retention rule for snapshots or AMIs created by the policy.
    - fastRestoreRule
```
FastRestoreRule fastRestoreRule
```
      [Custom snapshot policies only] The rule for enabling fast snapshot restore.
    - crossRegionCopyRules
```
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.
    - shareRules
```
List<E> shareRules
```
      [Custom snapshot policies only] The rule for sharing snapshots with other Amazon Web Services accounts.
    - deprecateRule
```
DeprecateRule deprecateRule
```
      [Custom AMI policies only] The AMI deprecation rule for the schedule.
    - archiveRule
```
ArchiveRule archiveRule
```
      [Custom 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.
- Class com.amazonaws.services.dlm.model.Script extends Object implements Serializable
  - Serialized Fields
    - stages
```
List<E> stages
```
      Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.
      
      To run a pre script only, specify PRE. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation.
      
      To run a post script only, specify POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the post-script parameter after initiating snapshot creation.
      
      To run both pre and post scripts, specify both PRE and POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation, and then it calls the SSM document again with the post-script parameter after initiating snapshot creation.
      
      If you are automating VSS Backups, omit this parameter.
      
      Default: PRE and POST
    - executionHandlerService
```
String executionHandlerService
```
      Indicates the service used to execute the pre and/or post scripts.
      
      If you are using custom SSM documents or automating application-consistent snapshots of SAP HANA workloads, specify AWS_SYSTEMS_MANAGER.
      
      If you are automating VSS Backups, omit this parameter.
      
      Default: AWS_SYSTEMS_MANAGER
    - executionHandler
```
String executionHandler
```
      The SSM document that includes the pre and/or post scripts to run.
      
      If you are automating VSS backups, specify AWS_VSS_BACKUP. In this case, Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot SSM document.
      
      If you are automating application-consistent snapshots for SAP HANA workloads, specify AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA.
      
      If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document.
    - executeOperationOnScriptFailure
```
Boolean executeOperationOnScriptFailure
```
      Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.
      
      To default to crash consistent snapshot if the pre script fails, specify true.
      
      To skip the instance for snapshot creation if the pre script fails, specify false.
      
      This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter.
      
      Default: true
    - executionTimeout
```
Integer executionTimeout
```
      Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. If a script does not complete within its timeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre and post scripts individually.
      
      If you are automating VSS Backups, omit this parameter.
      
      Default: 10
    - maximumRetryCount
```
Integer maximumRetryCount
```
      Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.
      
      If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation process, including running the pre and post scripts.
      
      If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this case, the pre script will have completed and the snapshot might have been created.
      
      If you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0.
      
      Default: 0
- Class com.amazonaws.services.dlm.model.ShareRule extends Object implements Serializable
  - Serialized Fields
    - targetAccounts
```
List<E> targetAccounts
```
      The IDs of the Amazon Web Services accounts with which to share the snapshots.
    - unshareInterval
```
Integer unshareInterval
```
      The period after which snapshots that are shared with other Amazon Web Services accounts are automatically unshared.
    - unshareIntervalUnit
```
String unshareIntervalUnit
```
      The unit of time for the automatic unsharing interval.
- Class com.amazonaws.services.dlm.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The tag key.
    - value
```
String value
```
      The tag value.
- Class com.amazonaws.services.dlm.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the resource.
    - tags
```
Map<K,V> tags
```
      One or more tags.
- Class com.amazonaws.services.dlm.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.dlm.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the resource.
    - tagKeys
```
List<E> tagKeys
```
      The tag keys.
- Class com.amazonaws.services.dlm.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.dlm.model.UpdateLifecyclePolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - policyId
```
String policyId
```
      The identifier of the lifecycle policy.
    - executionRoleArn
```
String executionRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
    - state
```
String state
```
      The desired activation state of the lifecycle policy after creation.
    - description
```
String description
```
      A description of the lifecycle policy.
    - policyDetails
```
PolicyDetails policyDetails
```
      The configuration of the lifecycle policy. You cannot update the policy type or the resource type.
    - createInterval
```
Integer createInterval
```
      [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.
    - retainInterval
```
Integer retainInterval
```
      [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time.
    - copyTags
```
Boolean copyTags
```
      [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.
    - extendDeletion
```
Boolean extendDeletion
```
      [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.
      
      By default (ExtendDeletion=false):
      
      If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true.
      
      If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true.
      
      If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.
      
      Default: false
    - crossRegionCopyTargets
```
List<E> crossRegionCopyTargets
```
      [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
    - exclusions
```
Exclusions 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.
- Class com.amazonaws.services.dlm.model.UpdateLifecyclePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Form

Package com.amazonaws.services.dlm.model

Class com.amazonaws.services.dlm.model.Action extends Object implements Serializable

Serialized Fields

name

crossRegionCopy

Class com.amazonaws.services.dlm.model.AmazonDLMException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.dlm.model.ArchiveRetainRule extends Object implements Serializable

Serialized Fields

retentionArchiveTier

Class com.amazonaws.services.dlm.model.ArchiveRule extends Object implements Serializable

Serialized Fields

retainRule

Class com.amazonaws.services.dlm.model.CreateLifecyclePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

executionRoleArn

description

state

policyDetails

tags

defaultPolicy

createInterval

retainInterval

copyTags

extendDeletion

crossRegionCopyTargets

exclusions

Class com.amazonaws.services.dlm.model.CreateLifecyclePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

policyId

Class com.amazonaws.services.dlm.model.CreateRule extends Object implements Serializable

Serialized Fields

location

interval

intervalUnit

times

cronExpression

scripts

Class com.amazonaws.services.dlm.model.CrossRegionCopyAction extends Object implements Serializable

Serialized Fields

target

encryptionConfiguration

retainRule

Class com.amazonaws.services.dlm.model.CrossRegionCopyDeprecateRule extends Object implements Serializable

Serialized Fields

interval

intervalUnit

Class com.amazonaws.services.dlm.model.CrossRegionCopyRetainRule extends Object implements Serializable

Serialized Fields

interval

intervalUnit

Class com.amazonaws.services.dlm.model.CrossRegionCopyRule extends Object implements Serializable

Serialized Fields

targetRegion

target

encrypted

cmkArn

copyTags

retainRule

deprecateRule

Class com.amazonaws.services.dlm.model.CrossRegionCopyTarget extends Object implements Serializable

Serialized Fields

targetRegion

Class com.amazonaws.services.dlm.model.DeleteLifecyclePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyId

Class com.amazonaws.services.dlm.model.DeleteLifecyclePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.dlm.model.DeprecateRule extends Object implements Serializable

Serialized Fields

count

interval

intervalUnit

Class com.amazonaws.services.dlm.model.EncryptionConfiguration extends Object implements Serializable

Serialized Fields

encrypted

cmkArn

Class com.amazonaws.services.dlm.model.EventParameters extends Object implements Serializable

Serialized Fields

eventType

snapshotOwner