You are viewing the documentation for an older major version of the AWS SDK for JavaScript.

The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.DLM

Inherits:

AWS.Service

Object
AWS.Service
AWS.DLM

show all

Identifier:: dlm

API Version:: 2018-01-12

Defined in:: (unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

With Amazon Data Lifecycle Manager, you can manage the lifecycle of your Amazon Web Services resources. You create lifecycle policies, which are used to automate operations on the specified resources.

Amazon DLM supports Amazon EBS volumes and snapshots. For information about using Amazon DLM with Amazon EBS, see Automating the Amazon EBS Snapshot Lifecycle in the Amazon EC2 User Guide.

Sending a Request Using DLM

var dlm = new AWS.DLM();
dlm.createLifecyclePolicy(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the DLM object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var dlm = new AWS.DLM({apiVersion: '2018-01-12'});

You can also set the API version globally in AWS.config.apiVersions using the dlm service identifier:

AWS.config.apiVersions = {
  dlm: '2018-01-12',
  // other service API versions
};

var dlm = new AWS.DLM();

Version:

2018-01-12

Constructor Summary collapse

new AWS.DLM(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

createLifecyclePolicy(params = {}, callback) ⇒ AWS.Request
Creates a policy to manage the lifecycle of the specified Amazon Web Services resources.
deleteLifecyclePolicy(params = {}, callback) ⇒ AWS.Request
Deletes the specified lifecycle policy and halts the automated operations that the policy specified.

.
getLifecyclePolicies(params = {}, callback) ⇒ AWS.Request
Gets summary information about all or the specified data lifecycle policies.

To get complete information about a policy, use GetLifecyclePolicy.
.
getLifecyclePolicy(params = {}, callback) ⇒ AWS.Request
Gets detailed information about the specified lifecycle policy.

.
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists the tags for the specified resource.

.
tagResource(params = {}, callback) ⇒ AWS.Request
Adds the specified tags to the specified resource.

.
untagResource(params = {}, callback) ⇒ AWS.Request
Removes the specified tags from the specified resource.

.
updateLifecyclePolicy(params = {}, callback) ⇒ AWS.Request
Updates the specified lifecycle policy.

.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.DLM(options = {}) ⇒ `Object`

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a DLM object

var dlm = new AWS.DLM({apiVersion: '2018-01-12'});

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String|AWS.Endpoint) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.DLM.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.DLM.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.DLM.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
s3UsEast1RegionalEndpoint ('legacy'|'regional') —
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy
s3UseArnRegion (Boolean) —
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean|undefined) —
whether to call operations with endpoints given by service dynamically. Setting this
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.
stsRegionalEndpoints ('legacy'|'regional') —
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

(AWS.Endpoint) —
an Endpoint object representing the endpoint URL for service requests.

Method Details

createLifecyclePolicy(params = {}, callback) ⇒ `AWS.Request`

Creates a policy to manage the lifecycle of the specified Amazon Web Services resources. You can create up to 100 lifecycle policies.

Service Reference:

CreateLifecyclePolicy

Examples:

Calling the createLifecyclePolicy operation

var params = {
  Description: 'STRING_VALUE', /* required */
  ExecutionRoleArn: 'STRING_VALUE', /* required */
  PolicyDetails: { /* required */
    Actions: [
      {
        CrossRegionCopy: [ /* required */
          {
            EncryptionConfiguration: { /* required */
              Encrypted: true || false, /* required */
              CmkArn: 'STRING_VALUE'
            },
            Target: 'STRING_VALUE', /* required */
            RetainRule: {
              Interval: 'NUMBER_VALUE',
              IntervalUnit: DAYS | WEEKS | MONTHS | YEARS
            }
          },
          /* more items */
        ],
        Name: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    EventSource: {
      Type: MANAGED_CWE, /* required */
      Parameters: {
        DescriptionRegex: 'STRING_VALUE', /* required */
        EventType: shareSnapshot, /* required */
        SnapshotOwner: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    Parameters: {
      ExcludeBootVolume: true || false,
      NoReboot: true || false
    },
    PolicyType: EBS_SNAPSHOT_MANAGEMENT | IMAGE_MANAGEMENT | EVENT_BASED_POLICY,
    ResourceLocations: [
      CLOUD | OUTPOST,
      /* more items */
    ],
    ResourceTypes: [
      VOLUME | INSTANCE,
      /* more items */
    ],
    Schedules: [
      {
        CopyTags: true || false,
        CreateRule: {
          CronExpression: 'STRING_VALUE',
          Interval: 'NUMBER_VALUE',
          IntervalUnit: HOURS,
          Location: CLOUD | OUTPOST_LOCAL,
          Times: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        CrossRegionCopyRules: [
          {
            Encrypted: true || false, /* required */
            CmkArn: 'STRING_VALUE',
            CopyTags: true || false,
            DeprecateRule: {
              Interval: 'NUMBER_VALUE',
              IntervalUnit: DAYS | WEEKS | MONTHS | YEARS
            },
            RetainRule: {
              Interval: 'NUMBER_VALUE',
              IntervalUnit: DAYS | WEEKS | MONTHS | YEARS
            },
            Target: 'STRING_VALUE',
            TargetRegion: 'STRING_VALUE'
          },
          /* more items */
        ],
        DeprecateRule: {
          Count: 'NUMBER_VALUE',
          Interval: 'NUMBER_VALUE',
          IntervalUnit: DAYS | WEEKS | MONTHS | YEARS
        },
        FastRestoreRule: {
          AvailabilityZones: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          Count: 'NUMBER_VALUE',
          Interval: 'NUMBER_VALUE',
          IntervalUnit: DAYS | WEEKS | MONTHS | YEARS
        },
        Name: 'STRING_VALUE',
        RetainRule: {
          Count: 'NUMBER_VALUE',
          Interval: 'NUMBER_VALUE',
          IntervalUnit: DAYS | WEEKS | MONTHS | YEARS
        },
        ShareRules: [
          {
            TargetAccounts: [ /* required */
              'STRING_VALUE',
              /* more items */
            ],
            UnshareInterval: 'NUMBER_VALUE',
            UnshareIntervalUnit: DAYS | WEEKS | MONTHS | YEARS
          },
          /* more items */
        ],
        TagsToAdd: [
          {
            Key: 'STRING_VALUE', /* required */
            Value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ],
        VariableTags: [
          {
            Key: 'STRING_VALUE', /* required */
            Value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      /* more items */
    ],
    TargetTags: [
      {
        Key: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  },
  State: ENABLED | DISABLED, /* required */
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
dlm.createLifecyclePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ExecutionRoleArn — (String)
  The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
- Description — (String)
  A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
- State — (String)
  The desired activation state of the lifecycle policy after creation.
  Possible values include:
  - "ENABLED"
  - "DISABLED"
- PolicyDetails — (map)
  The configuration details of the lifecycle policy.
  - PolicyType — (String)
    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.
    Possible values include:
    - "EBS_SNAPSHOT_MANAGEMENT"
    - "IMAGE_MANAGEMENT"
    - "EVENT_BASED_POLICY"
  - ResourceTypes — (Array<String>)
    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 — (Array<String>)
    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 — (Array<map>)
    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.
    - Key — required — (String)
      The tag key.
    - Value — required — (String)
      The tag value.
  - Schedules — (Array<map>)
    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.
    - Name — (String)
      The name of the schedule.
    - CopyTags — (Boolean)
      Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
    - TagsToAdd — (Array<map>)
      The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
      
      Key — required — (String)
      The tag key.
      
      Value — required — (String)
      The tag value.
    - VariableTags — (Array<map>)
      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.
      
      Key — required — (String)
      The tag key.
      
      Value — required — (String)
      The tag value.
    - CreateRule — (map)
      The creation rule.
      
      Location — (String)
      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.
      Possible values include:
      
      "CLOUD"
      
      "OUTPOST_LOCAL"
      
      Interval — (Integer)
      The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
      
      IntervalUnit — (String)
      The interval unit.
      Possible values include:
      
      "HOURS"
      
      Times — (Array<String>)
      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)
      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.
    - RetainRule — (map)
      The retention rule.
      
      Count — (Integer)
      The number of snapshots to retain for each volume, up to a maximum of 1000.
      
      Interval — (Integer)
      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)
      The unit of time for time-based retention.
      Possible values include:
      
      "DAYS"
      
      "WEEKS"
      
      "MONTHS"
      
      "YEARS"
    - FastRestoreRule — (map)
      The rule for enabling fast snapshot restore.
      
      Count — (Integer)
      The number of snapshots to be enabled with fast snapshot restore.
      
      Interval — (Integer)
      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)
      The unit of time for enabling fast snapshot restore.
      Possible values include:
      
      "DAYS"
      
      "WEEKS"
      
      "MONTHS"
      
      "YEARS"
      
      AvailabilityZones — required — (Array<String>)
      The Availability Zones in which to enable fast snapshot restore.
    - CrossRegionCopyRules — (Array<map>)
      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.
      
      TargetRegion — (String)
      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)
      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 — required — (Boolean)
      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)
      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)
      Indicates whether to copy all user-defined tags from the source snapshot to the cross-Region snapshot copy.
      
      RetainRule — (map)
      The retention rule that indicates how long snapshot copies are to be retained in the destination Region.
      
      Interval — (Integer)
      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)
      The unit of time for time-based retention.
      Possible values include:
      
      "DAYS"
      
      "WEEKS"
      
      "MONTHS"
      
      "YEARS"
      
      DeprecateRule — (map)
      The AMI deprecation rule for cross-Region AMI copies created by the rule.
      
      Interval — (Integer)
      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)
      The unit of time in which to measure the Interval.
      Possible values include:
      
      "DAYS"
      
      "WEEKS"
      
      "MONTHS"
      
      "YEARS"
    - ShareRules — (Array<map>)
      The rule for sharing snapshots with other Amazon Web Services accounts.
      
      TargetAccounts — required — (Array<String>)
      The IDs of the Amazon Web Services accounts with which to share the snapshots.
      
      UnshareInterval — (Integer)
      The period after which snapshots that are shared with other Amazon Web Services accounts are automatically unshared.
      
      UnshareIntervalUnit — (String)
      The unit of time for the automatic unsharing interval.
      Possible values include:
      
      "DAYS"
      
      "WEEKS"
      
      "MONTHS"
      
      "YEARS"
    - DeprecateRule — (map)
      The AMI deprecation rule for the schedule.
      
      Count — (Integer)
      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)
      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)
      The unit of time in which to measure the Interval.
      Possible values include:
      
      "DAYS"
      
      "WEEKS"
      
      "MONTHS"
      
      "YEARS"
  - Parameters — (map)
    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.
    - ExcludeBootVolume — (Boolean)
      [EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots. The default is false.
    - NoReboot — (Boolean)
      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).
  - EventSource — (map)
    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.
    - Type — required — (String)
      The source of the event. Currently only managed CloudWatch Events rules are supported.
      Possible values include:
      
      "MANAGED_CWE"
    - Parameters — (map)
      Information about the event.
      
      EventType — required — (String)
      The type of event. Currently, only snapshot sharing events are supported.
      Possible values include:
      
      "shareSnapshot"
      
      SnapshotOwner — required — (Array<String>)
      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 — required — (String)
      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.
  - Actions — (Array<map>)
    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.
    - Name — required — (String)
      A descriptive name for the action.
    - CrossRegionCopy — required — (Array<map>)
      The rule for copying shared snapshots across Regions.
      
      Target — required — (String)
      The target Region.
      
      EncryptionConfiguration — required — (map)
      The encryption settings for the copied snapshot.
      
      Encrypted — required — (Boolean)
      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)
      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.
      
      RetainRule — (map)
      Specifies the retention rule for cross-Region snapshot copies.
      
      Interval — (Integer)
      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)
      The unit of time for time-based retention.
      Possible values include:
      
      "DAYS"
      
      "WEEKS"
      
      "MONTHS"
      
      "YEARS"
- Tags — (map<String>)
  The tags to apply to the lifecycle policy during creation.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - PolicyId — (String)
    The identifier of the lifecycle policy.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteLifecyclePolicy(params = {}, callback) ⇒ `AWS.Request`

Deletes the specified lifecycle policy and halts the automated operations that the policy specified.

Service Reference:

DeleteLifecyclePolicy

Examples:

Calling the deleteLifecyclePolicy operation

var params = {
  PolicyId: 'STRING_VALUE' /* required */
};
dlm.deleteLifecyclePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- PolicyId — (String)
  The identifier of the lifecycle policy.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

getLifecyclePolicies(params = {}, callback) ⇒ `AWS.Request`

Gets summary information about all or the specified data lifecycle policies.

To get complete information about a policy, use GetLifecyclePolicy.

Service Reference:

GetLifecyclePolicies

Examples:

Calling the getLifecyclePolicies operation

var params = {
  PolicyIds: [
    'STRING_VALUE',
    /* more items */
  ],
  ResourceTypes: [
    VOLUME | INSTANCE,
    /* more items */
  ],
  State: ENABLED | DISABLED | ERROR,
  TagsToAdd: [
    'STRING_VALUE',
    /* more items */
  ],
  TargetTags: [
    'STRING_VALUE',
    /* more items */
  ]
};
dlm.getLifecyclePolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- PolicyIds — (Array<String>)
  The identifiers of the data lifecycle policies.
- State — (String)
  The activation state.
  Possible values include:
  - "ENABLED"
  - "DISABLED"
  - "ERROR"
- ResourceTypes — (Array<String>)
  The resource type.
- TargetTags — (Array<String>)
  The target tag for a policy.
  
  Tags are strings in the format key=value.
- TagsToAdd — (Array<String>)
  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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Policies — (Array<map>)
    Summary information about the lifecycle policies.
    
    PolicyId — (String)
    The identifier of the lifecycle policy.
    
    Description — (String)
    The description of the lifecycle policy.
    
    State — (String)
    The activation state of the lifecycle policy.
    Possible values include:
    
    "ENABLED"
    
    "DISABLED"
    
    "ERROR"
    
    Tags — (map<String>)
    The tags.
    
    PolicyType — (String)
    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.
    Possible values include:
    
    "EBS_SNAPSHOT_MANAGEMENT"
    
    "IMAGE_MANAGEMENT"
    
    "EVENT_BASED_POLICY"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

getLifecyclePolicy(params = {}, callback) ⇒ `AWS.Request`

Gets detailed information about the specified lifecycle policy.

Service Reference:

GetLifecyclePolicy

Examples:

Calling the getLifecyclePolicy operation

var params = {
  PolicyId: 'STRING_VALUE' /* required */
};
dlm.getLifecyclePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- PolicyId — (String)
  The identifier of the lifecycle policy.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Policy — (map)
    Detailed information about the lifecycle policy.
    
    PolicyId — (String)
    The identifier of the lifecycle policy.
    
    Description — (String)
    The description of the lifecycle policy.
    
    State — (String)
    The activation state of the lifecycle policy.
    Possible values include:
    
    "ENABLED"
    
    "DISABLED"
    
    "ERROR"
    
    StatusMessage — (String)
    The description of the status.
    
    ExecutionRoleArn — (String)
    The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
    
    DateCreated — (Date)
    The local date and time when the lifecycle policy was created.
    
    DateModified — (Date)
    The local date and time when the lifecycle policy was last modified.
    
    PolicyDetails — (map)
    The configuration of the lifecycle policy
    
    PolicyType — (String)
    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.
    Possible values include:
    
    "EBS_SNAPSHOT_MANAGEMENT"
    
    "IMAGE_MANAGEMENT"
    
    "EVENT_BASED_POLICY"
    
    ResourceTypes — (Array<String>)
    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 — (Array<String>)
    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 — (Array<map>)
    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.
    
    Key — required — (String)
    The tag key.
    
    Value — required — (String)
    The tag value.
    
    Schedules — (Array<map>)
    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.
    
    Name — (String)
    The name of the schedule.
    
    CopyTags — (Boolean)
    Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
    
    TagsToAdd — (Array<map>)
    The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
    
    Key — required — (String)
    The tag key.
    
    Value — required — (String)
    The tag value.
    
    VariableTags — (Array<map>)
    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.
    
    Key — required — (String)
    The tag key.
    
    Value — required — (String)
    The tag value.
    
    CreateRule — (map)
    The creation rule.
    
    Location — (String)
    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.
    Possible values include:
    
    "CLOUD"
    
    "OUTPOST_LOCAL"
    
    Interval — (Integer)
    The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
    
    IntervalUnit — (String)
    The interval unit.
    Possible values include:
    
    "HOURS"
    
    Times — (Array<String>)
    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)
    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.
    
    RetainRule — (map)
    The retention rule.
    
    Count — (Integer)
    The number of snapshots to retain for each volume, up to a maximum of 1000.
    
    Interval — (Integer)
    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)
    The unit of time for time-based retention.
    Possible values include:
    
    "DAYS"
    
    "WEEKS"
    
    "MONTHS"
    
    "YEARS"
    
    FastRestoreRule — (map)
    The rule for enabling fast snapshot restore.
    
    Count — (Integer)
    The number of snapshots to be enabled with fast snapshot restore.
    
    Interval — (Integer)
    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)
    The unit of time for enabling fast snapshot restore.
    Possible values include:
    
    "DAYS"
    
    "WEEKS"
    
    "MONTHS"
    
    "YEARS"
    
    AvailabilityZones — required — (Array<String>)
    The Availability Zones in which to enable fast snapshot restore.
    
    CrossRegionCopyRules — (Array<map>)
    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.
    
    TargetRegion — (String)
    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)
    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 — required — (Boolean)
    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)
    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)
    Indicates whether to copy all user-defined tags from the source snapshot to the cross-Region snapshot copy.
    
    RetainRule — (map)
    The retention rule that indicates how long snapshot copies are to be retained in the destination Region.
    
    Interval — (Integer)
    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)
    The unit of time for time-based retention.
    Possible values include:
    
    "DAYS"
    
    "WEEKS"
    
    "MONTHS"
    
    "YEARS"
    
    DeprecateRule — (map)
    The AMI deprecation rule for cross-Region AMI copies created by the rule.
    
    Interval — (Integer)
    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)
    The unit of time in which to measure the Interval.
    Possible values include:
    
    "DAYS"
    
    "WEEKS"
    
    "MONTHS"
    
    "YEARS"
    
    ShareRules — (Array<map>)
    The rule for sharing snapshots with other Amazon Web Services accounts.
    
    TargetAccounts — required — (Array<String>)
    The IDs of the Amazon Web Services accounts with which to share the snapshots.
    
    UnshareInterval — (Integer)
    The period after which snapshots that are shared with other Amazon Web Services accounts are automatically unshared.
    
    UnshareIntervalUnit — (String)
    The unit of time for the automatic unsharing interval.
    Possible values include:
    
    "DAYS"
    
    "WEEKS"
    
    "MONTHS"
    
    "YEARS"
    
    DeprecateRule — (map)
    The AMI deprecation rule for the schedule.
    
    Count — (Integer)
    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)
    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)
    The unit of time in which to measure the Interval.
    Possible values include:
    
    "DAYS"
    
    "WEEKS"
    
    "MONTHS"
    
    "YEARS"
    
    Parameters — (map)
    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.
    
    ExcludeBootVolume — (Boolean)
    [EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots. The default is false.
    
    NoReboot — (Boolean)
    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).
    
    EventSource — (map)
    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.
    
    Type — required — (String)
    The source of the event. Currently only managed CloudWatch Events rules are supported.
    Possible values include:
    
    "MANAGED_CWE"
    
    Parameters — (map)
    Information about the event.
    
    EventType — required — (String)
    The type of event. Currently, only snapshot sharing events are supported.
    Possible values include:
    
    "shareSnapshot"
    
    SnapshotOwner — required — (Array<String>)
    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 — required — (String)
    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.
    
    Actions — (Array<map>)
    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.
    
    Name — required — (String)
    A descriptive name for the action.
    
    CrossRegionCopy — required — (Array<map>)
    The rule for copying shared snapshots across Regions.
    
    Target — required — (String)
    The target Region.
    
    EncryptionConfiguration — required — (map)
    The encryption settings for the copied snapshot.
    
    Encrypted — required — (Boolean)
    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)
    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.
    
    RetainRule — (map)
    Specifies the retention rule for cross-Region snapshot copies.
    
    Interval — (Integer)
    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)
    The unit of time for time-based retention.
    Possible values include:
    
    "DAYS"
    
    "WEEKS"
    
    "MONTHS"
    
    "YEARS"
    
    Tags — (map<String>)
    The tags.
    
    PolicyArn — (String)
    The Amazon Resource Name (ARN) of the policy.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ `AWS.Request`

Lists the tags for the specified resource.

Service Reference:

ListTagsForResource

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
dlm.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ResourceArn — (String)
  The Amazon Resource Name (ARN) of the resource.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Tags — (map<String>)
    Information about the tags.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ `AWS.Request`

Adds the specified tags to the specified resource.

Service Reference:

TagResource

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
dlm.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ResourceArn — (String)
  The Amazon Resource Name (ARN) of the resource.
- Tags — (map<String>)
  One or more tags.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ `AWS.Request`

Removes the specified tags from the specified resource.

Service Reference:

UntagResource

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
dlm.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ResourceArn — (String)
  The Amazon Resource Name (ARN) of the resource.
- TagKeys — (Array<String>)
  The tag keys.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateLifecyclePolicy(params = {}, callback) ⇒ `AWS.Request`

Updates the specified lifecycle policy.

Service Reference:

UpdateLifecyclePolicy

Examples:

Calling the updateLifecyclePolicy operation

var params = {
  PolicyId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  ExecutionRoleArn: 'STRING_VALUE',
  PolicyDetails: {
    Actions: [
      {
        CrossRegionCopy: [ /* required */
          {
            EncryptionConfiguration: { /* required */
              Encrypted: true || false, /* required */
              CmkArn: 'STRING_VALUE'
            },
            Target: 'STRING_VALUE', /* required */
            RetainRule: {
              Interval: 'NUMBER_VALUE',
              IntervalUnit: DAYS | WEEKS | MONTHS | YEARS
            }
          },
          /* more items */
        ],
        Name: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    EventSource: {
      Type: MANAGED_CWE, /* required */
      Parameters: {
        DescriptionRegex: 'STRING_VALUE', /* required */
        EventType: shareSnapshot, /* required */
        SnapshotOwner: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    Parameters: {
      ExcludeBootVolume: true || false,
      NoReboot: true || false
    },
    PolicyType: EBS_SNAPSHOT_MANAGEMENT | IMAGE_MANAGEMENT | EVENT_BASED_POLICY,
    ResourceLocations: [
      CLOUD | OUTPOST,
      /* more items */
    ],
    ResourceTypes: [
      VOLUME | INSTANCE,
      /* more items */
    ],
    Schedules: [
      {
        CopyTags: true || false,
        CreateRule: {
          CronExpression: 'STRING_VALUE',
          Interval: 'NUMBER_VALUE',
          IntervalUnit: HOURS,
          Location: CLOUD | OUTPOST_LOCAL,
          Times: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        CrossRegionCopyRules: [
          {
            Encrypted: true || false, /* required */
            CmkArn: 'STRING_VALUE',
            CopyTags: true || false,
            DeprecateRule: {
              Interval: 'NUMBER_VALUE',
              IntervalUnit: DAYS | WEEKS | MONTHS | YEARS
            },
            RetainRule: {
              Interval: 'NUMBER_VALUE',
              IntervalUnit: DAYS | WEEKS | MONTHS | YEARS
            },
            Target: 'STRING_VALUE',
            TargetRegion: 'STRING_VALUE'
          },
          /* more items */
        ],
        DeprecateRule: {
          Count: 'NUMBER_VALUE',
          Interval: 'NUMBER_VALUE',
          IntervalUnit: DAYS | WEEKS | MONTHS | YEARS
        },
        FastRestoreRule: {
          AvailabilityZones: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          Count: 'NUMBER_VALUE',
          Interval: 'NUMBER_VALUE',
          IntervalUnit: DAYS | WEEKS | MONTHS | YEARS
        },
        Name: 'STRING_VALUE',
        RetainRule: {
          Count: 'NUMBER_VALUE',
          Interval: 'NUMBER_VALUE',
          IntervalUnit: DAYS | WEEKS | MONTHS | YEARS
        },
        ShareRules: [
          {
            TargetAccounts: [ /* required */
              'STRING_VALUE',
              /* more items */
            ],
            UnshareInterval: 'NUMBER_VALUE',
            UnshareIntervalUnit: DAYS | WEEKS | MONTHS | YEARS
          },
          /* more items */
        ],
        TagsToAdd: [
          {
            Key: 'STRING_VALUE', /* required */
            Value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ],
        VariableTags: [
          {
            Key: 'STRING_VALUE', /* required */
            Value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      /* more items */
    ],
    TargetTags: [
      {
        Key: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  },
  State: ENABLED | DISABLED
};
dlm.updateLifecyclePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- PolicyId — (String)
  The identifier of the lifecycle policy.
- ExecutionRoleArn — (String)
  The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
- State — (String)
  The desired activation state of the lifecycle policy after creation.
  Possible values include:
  - "ENABLED"
  - "DISABLED"
- Description — (String)
  A description of the lifecycle policy.
- PolicyDetails — (map)
  The configuration of the lifecycle policy. You cannot update the policy type or the resource type.
  - PolicyType — (String)
    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.
    Possible values include:
    - "EBS_SNAPSHOT_MANAGEMENT"
    - "IMAGE_MANAGEMENT"
    - "EVENT_BASED_POLICY"
  - ResourceTypes — (Array<String>)
    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 — (Array<String>)
    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 — (Array<map>)
    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.
    - Key — required — (String)
      The tag key.
    - Value — required — (String)
      The tag value.
  - Schedules — (Array<map>)
    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.
    - Name — (String)
      The name of the schedule.
    - CopyTags — (Boolean)
      Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
    - TagsToAdd — (Array<map>)
      The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
      
      Key — required — (String)
      The tag key.
      
      Value — required — (String)
      The tag value.
    - VariableTags — (Array<map>)
      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.
      
      Key — required — (String)
      The tag key.
      
      Value — required — (String)
      The tag value.
    - CreateRule — (map)
      The creation rule.
      
      Location — (String)
      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.
      Possible values include:
      
      "CLOUD"
      
      "OUTPOST_LOCAL"
      
      Interval — (Integer)
      The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
      
      IntervalUnit — (String)
      The interval unit.
      Possible values include:
      
      "HOURS"
      
      Times — (Array<String>)
      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)
      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.
    - RetainRule — (map)
      The retention rule.
      
      Count — (Integer)
      The number of snapshots to retain for each volume, up to a maximum of 1000.
      
      Interval — (Integer)
      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)
      The unit of time for time-based retention.
      Possible values include:
      
      "DAYS"
      
      "WEEKS"
      
      "MONTHS"
      
      "YEARS"
    - FastRestoreRule — (map)
      The rule for enabling fast snapshot restore.
      
      Count — (Integer)
      The number of snapshots to be enabled with fast snapshot restore.
      
      Interval — (Integer)
      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)
      The unit of time for enabling fast snapshot restore.
      Possible values include:
      
      "DAYS"
      
      "WEEKS"
      
      "MONTHS"
      
      "YEARS"
      
      AvailabilityZones — required — (Array<String>)
      The Availability Zones in which to enable fast snapshot restore.
    - CrossRegionCopyRules — (Array<map>)
      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.
      
      TargetRegion — (String)
      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)
      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 — required — (Boolean)
      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)
      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)
      Indicates whether to copy all user-defined tags from the source snapshot to the cross-Region snapshot copy.
      
      RetainRule — (map)
      The retention rule that indicates how long snapshot copies are to be retained in the destination Region.
      
      Interval — (Integer)
      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)
      The unit of time for time-based retention.
      Possible values include:
      
      "DAYS"
      
      "WEEKS"
      
      "MONTHS"
      
      "YEARS"
      
      DeprecateRule — (map)
      The AMI deprecation rule for cross-Region AMI copies created by the rule.
      
      Interval — (Integer)
      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)
      The unit of time in which to measure the Interval.
      Possible values include:
      
      "DAYS"
      
      "WEEKS"
      
      "MONTHS"
      
      "YEARS"
    - ShareRules — (Array<map>)
      The rule for sharing snapshots with other Amazon Web Services accounts.
      
      TargetAccounts — required — (Array<String>)
      The IDs of the Amazon Web Services accounts with which to share the snapshots.
      
      UnshareInterval — (Integer)
      The period after which snapshots that are shared with other Amazon Web Services accounts are automatically unshared.
      
      UnshareIntervalUnit — (String)
      The unit of time for the automatic unsharing interval.
      Possible values include:
      
      "DAYS"
      
      "WEEKS"
      
      "MONTHS"
      
      "YEARS"
    - DeprecateRule — (map)
      The AMI deprecation rule for the schedule.
      
      Count — (Integer)
      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)
      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)
      The unit of time in which to measure the Interval.
      Possible values include:
      
      "DAYS"
      
      "WEEKS"
      
      "MONTHS"
      
      "YEARS"
  - Parameters — (map)
    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.
    - ExcludeBootVolume — (Boolean)
      [EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots. The default is false.
    - NoReboot — (Boolean)
      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).
  - EventSource — (map)
    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.
    - Type — required — (String)
      The source of the event. Currently only managed CloudWatch Events rules are supported.
      Possible values include:
      
      "MANAGED_CWE"
    - Parameters — (map)
      Information about the event.
      
      EventType — required — (String)
      The type of event. Currently, only snapshot sharing events are supported.
      Possible values include:
      
      "shareSnapshot"
      
      SnapshotOwner — required — (Array<String>)
      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 — required — (String)
      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.
  - Actions — (Array<map>)
    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.
    - Name — required — (String)
      A descriptive name for the action.
    - CrossRegionCopy — required — (Array<map>)
      The rule for copying shared snapshots across Regions.
      
      Target — required — (String)
      The target Region.
      
      EncryptionConfiguration — required — (map)
      The encryption settings for the copied snapshot.
      
      Encrypted — required — (Boolean)
      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)
      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.
      
      RetainRule — (map)
      Specifies the retention rule for cross-Region snapshot copies.
      
      Interval — (Integer)
      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)
      The unit of time for time-based retention.
      Possible values include:
      
      "DAYS"
      
      "WEEKS"
      
      "MONTHS"
      
      "YEARS"

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Class: AWS.DLM

Overview

Service Description

Sending a Request Using DLM

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

new AWS.DLM(options = {}) ⇒ Object

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

createLifecyclePolicy(params = {}, callback) ⇒ AWS.Request

deleteLifecyclePolicy(params = {}, callback) ⇒ AWS.Request

getLifecyclePolicies(params = {}, callback) ⇒ AWS.Request

getLifecyclePolicy(params = {}, callback) ⇒ AWS.Request

listTagsForResource(params = {}, callback) ⇒ AWS.Request

tagResource(params = {}, callback) ⇒ AWS.Request

untagResource(params = {}, callback) ⇒ AWS.Request

updateLifecyclePolicy(params = {}, callback) ⇒ AWS.Request

new AWS.DLM(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

createLifecyclePolicy(params = {}, callback) ⇒ `AWS.Request`

deleteLifecyclePolicy(params = {}, callback) ⇒ `AWS.Request`

getLifecyclePolicies(params = {}, callback) ⇒ `AWS.Request`

getLifecyclePolicy(params = {}, callback) ⇒ `AWS.Request`

listTagsForResource(params = {}, callback) ⇒ `AWS.Request`

tagResource(params = {}, callback) ⇒ `AWS.Request`

untagResource(params = {}, callback) ⇒ `AWS.Request`

updateLifecyclePolicy(params = {}, callback) ⇒ `AWS.Request`