Serialized Form (AWS Java SDK for Amazon Data Lifecycle Manager 1.12.79 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.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 desired activation state of the lifecycle policy after creation.
    - policyDetails
```
PolicyDetails policyDetails
```
      The configuration details of the lifecycle policy.
    - tags
```
Map<K,V> tags
```
      The tags to apply to the lifecycle policy during creation.
- 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
```
      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 DLM 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.
- 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.
- Class com.amazonaws.services.dlm.model.CrossRegionCopyRetainRule extends Object implements Serializable
  - Serialized Fields
    - 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.
- Class com.amazonaws.services.dlm.model.CrossRegionCopyRule extends Object implements Serializable
  - Serialized Fields
    - targetRegion
```
String 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.
    - target
```
String 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.
    - 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 to the cross-Region snapshot copy.
    - retainRule
```
CrossRegionCopyRetainRule retainRule
```
      The retention rule that indicates how long snapshot copies are to be retained in the destination Region.
    - deprecateRule
```
CrossRegionCopyDeprecateRule deprecateRule
```
      The AMI deprecation rule for cross-Region AMI copies created by the rule.
- 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.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.
- 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.
- 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.
- 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
```
      [EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots. The default is false.
    - noReboot
```
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 (instances are not rebooted).
- Class com.amazonaws.services.dlm.model.PolicyDetails extends Object implements Serializable
  - Serialized Fields
    - policyType
```
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. 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
```
      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.
      
      This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    - resourceLocations
```
List<E> resourceLocations
```
      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
```
      The single tag that identifies targeted resources for this policy.
      
      This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    - schedules
```
List<E> schedules
```
      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.
      
      This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    - parameters
```
Parameters parameters
```
      A set of optional parameters for snapshot and AMI lifecycle policies.
      
      This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    - eventSource
```
EventSource eventSource
```
      The event that triggers the event-based policy.
      
      This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
    - actions
```
List<E> actions
```
      The actions to be performed when the event-based policy is triggered. You can specify only one action per policy.
      
      This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
- 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.
    - 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.
- 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
```
      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.
    - fastRestoreRule
```
FastRestoreRule fastRestoreRule
```
      The rule for enabling fast snapshot restore.
    - crossRegionCopyRules
```
List<E> crossRegionCopyRules
```
      The rule for cross-Region snapshot copies.
      
      You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to 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
```
      The rule for sharing snapshots with other Amazon Web Services accounts.
    - deprecateRule
```
DeprecateRule deprecateRule
```
      The AMI deprecation rule for the schedule.
- 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.
- 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.CreateLifecyclePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

executionRoleArn

description

state

policyDetails

tags

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

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.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

descriptionRegex

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

Serialized Fields

type

parameters

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

Serialized Fields

count

interval

intervalUnit

availabilityZones

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

Serialized Fields

policyIds

state

resourceTypes

targetTags