Class: AWS.DLM

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.

var params = {
  DefaultPolicyType: VOLUME | INSTANCE | ALL,
  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.

  • DefaultPolicyType — (String)

    [Default policies only] Specifies the type of default policy to get. Specify one of the following:

    • VOLUME - To get only the default policy for EBS snapshots

    • INSTANCE - To get only the default policy for EBS-backed AMIs

    • ALL - To get all default policies

    Possible values include:
    • "VOLUME"
    • "INSTANCE"
    • "ALL"

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. EVENT_BASED_POLICY indicates that the policy automates cross-account snapshot copies for snapshots that are shared with your account.

        Possible values include:
        • "EBS_SNAPSHOT_MANAGEMENT"
        • "IMAGE_MANAGEMENT"
        • "EVENT_BASED_POLICY"
      • DefaultPolicy — (Boolean)

        [Default policies only] The type of default policy. Values include:

        • VOLUME - Default policy for EBS snapshots

        • INSTANCE - Default policy for EBS-backed AMIs

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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)

          [Custom policies only] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

          The default is EBS_SNAPSHOT_MANAGEMENT.

          Possible values include:
          • "EBS_SNAPSHOT_MANAGEMENT"
          • "IMAGE_MANAGEMENT"
          • "EVENT_BASED_POLICY"
        • ResourceTypes — (Array<String>)

          [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

        • ResourceLocations — (Array<String>)

          [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

          If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

        • TargetTags — (Array<map>)

          [Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

          • Key — required — (String)

            The tag key.

          • Value — required — (String)

            The tag value.

        • Schedules — (Array<map>)

          [Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.

          • 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>)

            [AMI policies and snapshot policies that target instances only] A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.

            • Key — required — (String)

              The tag key.

            • Value — required — (String)

              The tag value.

          • CreateRule — (map)

            The creation rule.

            • Location — (String)

              [Custom snapshot policies only] Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD. To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. If you omit this parameter, CLOUD is used by default.

              If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.

              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 Data Lifecycle Manager 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.

            • Scripts — (Array<map>)

              [Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.

              For more information, see Automating application-consistent snapshots with pre and post scripts.

              • Stages — (Array<String>)

                Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

                • To run a pre script only, specify PRE. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation.

                • To run a post script only, specify POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the post-script parameter after initiating snapshot creation.

                • To run both pre and post scripts, specify both PRE and POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation, and then it calls the SSM document again with the post-script parameter after initiating snapshot creation.

                If you are automating VSS Backups, omit this parameter.

                Default: PRE and POST

              • ExecutionHandlerService — (String)

                Indicates the service used to execute the pre and/or post scripts.

                • If you are using custom SSM documents or automating application-consistent snapshots of SAP HANA workloads, specify AWS_SYSTEMS_MANAGER.

                • If you are automating VSS Backups, omit this parameter.

                Default: AWS_SYSTEMS_MANAGER

                Possible values include:
                • "AWS_SYSTEMS_MANAGER"
              • ExecutionHandler — required — (String)

                The SSM document that includes the pre and/or post scripts to run.

                • If you are automating VSS backups, specify AWS_VSS_BACKUP. In this case, Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot SSM document.

                • If you are automating application-consistent snapshots for SAP HANA workloads, specify AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA.

                • If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document.

              • ExecuteOperationOnScriptFailure — (Boolean)

                Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.

                • To default to crash consistent snapshot if the pre script fails, specify true.

                • To skip the instance for snapshot creation if the pre script fails, specify false.

                This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter.

                Default: true

              • ExecutionTimeout — (Integer)

                Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. If a script does not complete within its timeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre and post scripts individually.

                If you are automating VSS Backups, omit this parameter.

                Default: 10

              • MaximumRetryCount — (Integer)

                Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.

                • If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation process, including running the pre and post scripts.

                • If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this case, the pre script will have completed and the snapshot might have been created.

                If you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0.

                Default: 0

          • RetainRule — (map)

            The retention rule for snapshots or AMIs created by the policy.

            • Count — (Integer)

              The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to retain a maximum of three snapshots, specify 3. When the fourth snapshot is created, the oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.

            • Interval — (Integer)

              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. For example, to retain snapshots for 3 months, specify Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.

              Possible values include:
              • "DAYS"
              • "WEEKS"
              • "MONTHS"
              • "YEARS"
          • FastRestoreRule — (map)

            [Custom snapshot policies only] 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>)

            Specifies a rule for copying snapshots or AMIs across regions.

            Note: You can't specify cross-Region copy rules for policies that create snapshots on an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
            • TargetRegion — (String)
              Note: Use this parameter for AMI policies only. For snapshot policies, use Target instead. For snapshot policies created before the Target parameter was introduced, this parameter indicates the target Region for snapshot copies.

              [Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.

            • Target — (String)
              Note: Use this parameter for snapshot policies only. For AMI policies, use TargetRegion instead.

              [Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.

            • Encrypted — 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 or AMI to the cross-Region copy.

            • RetainRule — (map)

              The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.

              • Interval — (Integer)

                The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.

              • IntervalUnit — (String)

                The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.

                Possible values include:
                • "DAYS"
                • "WEEKS"
                • "MONTHS"
                • "YEARS"
            • DeprecateRule — (map)

              [Custom AMI policies only] 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. For example, to deprecate a cross-Region AMI copy after 3 months, specify Interval=3 and IntervalUnit=MONTHS.

                Possible values include:
                • "DAYS"
                • "WEEKS"
                • "MONTHS"
                • "YEARS"
          • ShareRules — (Array<map>)

            [Custom snapshot policies only] 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)

            [Custom AMI policies only] 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"
          • ArchiveRule — (map)

            [Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.

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

            • RetainRule — required — (map)

              Information about the retention period for the snapshot archiving rule.

              • RetentionArchiveTier — required — (map)

                Information about retention period in the Amazon EBS Snapshots Archive. For more information, see Archive Amazon EBS snapshots.

                • Count — (Integer)

                  The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days.

                • Interval — (Integer)

                  Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.

                • IntervalUnit — (String)

                  The unit of time in which to measure the Interval. For example, to retain a snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.

                  Possible values include:
                  • "DAYS"
                  • "WEEKS"
                  • "MONTHS"
                  • "YEARS"
        • Parameters — (map)

          [Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

          Note: If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.
          • ExcludeBootVolume — (Boolean)

            [Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.

          • NoReboot — (Boolean)

            [Custom AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instances are not rebooted).

          • ExcludeDataVolumeTags — (Array<map>)

            [Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.

            If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.

            • Key — required — (String)

              The tag key.

            • Value — required — (String)

              The tag value.

        • EventSource — (map)

          [Event-based policies only] The event that activates the event-based policy.

          • 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>)

          [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.

          • 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 a retention rule for cross-Region snapshot copies created by snapshot or event-based policies, or cross-Region AMI copies created by AMI policies. After the retention period expires, the cross-Region copy is deleted.

              • Interval — (Integer)

                The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.

              • IntervalUnit — (String)

                The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.

                Possible values include:
                • "DAYS"
                • "WEEKS"
                • "MONTHS"
                • "YEARS"
        • PolicyLanguage — (String)

          The type of policy to create. Specify one of the following:

          • SIMPLIFIED To create a default policy.

          • STANDARD To create a custom policy.

          Possible values include:
          • "SIMPLIFIED"
          • "STANDARD"
        • ResourceType — (String)

          [Default policies only] Specify the type of default policy to create.

          • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.

          • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.

          Possible values include:
          • "VOLUME"
          • "INSTANCE"
        • CreateInterval — (Integer)

          [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.

          Default: 1

        • RetainInterval — (Integer)

          [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.

          Default: 7

        • CopyTags — (Boolean)

          [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.

          Default: false

        • CrossRegionCopyTargets — (Array<map>)

          [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.

          • TargetRegion — (String)

            The target Region, for example us-east-1.

        • ExtendDeletion — (Boolean)

          [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

          By default (ExtendDeletion=false):

          • If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true.

          • If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true.

          If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.

          If you do not specify a value, the default is false.

          Default: false

        • Exclusions — (map)

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

          • ExcludeBootVolumes — (Boolean)

            [Default policies for EBS snapshots only] Indicates whether to exclude volumes that are attached to instances as the boot volume. If you exclude boot volumes, only volumes attached as data (non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify true.

          • ExcludeVolumeTypes — (Array<String>)

            [Default policies for EBS snapshots only] Specifies the volume types to exclude. Volumes of the specified types will not be targeted by the policy.

          • ExcludeTags — (Array<map>)

            [Default policies for EBS-backed AMIs only] Specifies whether to exclude volumes that have specific tags.

            • Key — required — (String)

              The tag key.

            • Value — required — (String)

              The tag value.

      • Tags — (map<String>)

        The tags.

      • PolicyArn — (String)

        The Amazon Resource Name (ARN) of the policy.

      • DefaultPolicy — (Boolean)

        [Default policies only] The type of default policy. Values include:

        • VOLUME - Default policy for EBS snapshots

        • INSTANCE - Default policy for EBS-backed AMIs

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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.

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.

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.

var params = {
  PolicyId: 'STRING_VALUE', /* required */
  CopyTags: true || false,
  CreateInterval: 'NUMBER_VALUE',
  CrossRegionCopyTargets: [
    {
      TargetRegion: 'STRING_VALUE'
    },
    /* more items */
  ],
  Description: 'STRING_VALUE',
  Exclusions: {
    ExcludeBootVolumes: true || false,
    ExcludeTags: [
      {
        Key: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ExcludeVolumeTypes: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  ExecutionRoleArn: 'STRING_VALUE',
  ExtendDeletion: true || false,
  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 */
    ],
    CopyTags: true || false,
    CreateInterval: 'NUMBER_VALUE',
    CrossRegionCopyTargets: [
      {
        TargetRegion: 'STRING_VALUE'
      },
      /* more items */
    ],
    EventSource: {
      Type: MANAGED_CWE, /* required */
      Parameters: {
        DescriptionRegex: 'STRING_VALUE', /* required */
        EventType: shareSnapshot, /* required */
        SnapshotOwner: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    Exclusions: {
      ExcludeBootVolumes: true || false,
      ExcludeTags: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      ExcludeVolumeTypes: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    ExtendDeletion: true || false,
    Parameters: {
      ExcludeBootVolume: true || false,
      ExcludeDataVolumeTags: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      NoReboot: true || false
    },
    PolicyLanguage: SIMPLIFIED | STANDARD,
    PolicyType: EBS_SNAPSHOT_MANAGEMENT | IMAGE_MANAGEMENT | EVENT_BASED_POLICY,
    ResourceLocations: [
      CLOUD | OUTPOST,
      /* more items */
    ],
    ResourceType: VOLUME | INSTANCE,
    ResourceTypes: [
      VOLUME | INSTANCE,
      /* more items */
    ],
    RetainInterval: 'NUMBER_VALUE',
    Schedules: [
      {
        ArchiveRule: {
          RetainRule: { /* required */
            RetentionArchiveTier: { /* required */
              Count: 'NUMBER_VALUE',
              Interval: 'NUMBER_VALUE',
              IntervalUnit: DAYS | WEEKS | MONTHS | YEARS
            }
          }
        },
        CopyTags: true || false,
        CreateRule: {
          CronExpression: 'STRING_VALUE',
          Interval: 'NUMBER_VALUE',
          IntervalUnit: HOURS,
          Location: CLOUD | OUTPOST_LOCAL,
          Scripts: [
            {
              ExecutionHandler: 'STRING_VALUE', /* required */
              ExecuteOperationOnScriptFailure: true || false,
              ExecutionHandlerService: AWS_SYSTEMS_MANAGER,
              ExecutionTimeout: 'NUMBER_VALUE',
              MaximumRetryCount: 'NUMBER_VALUE',
              Stages: [
                PRE | POST,
                /* more items */
              ]
            },
            /* more items */
          ],
          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 */
    ]
  },
  RetainInterval: 'NUMBER_VALUE',
  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)

      [Custom policies only] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

      The default is EBS_SNAPSHOT_MANAGEMENT.

      Possible values include:
      • "EBS_SNAPSHOT_MANAGEMENT"
      • "IMAGE_MANAGEMENT"
      • "EVENT_BASED_POLICY"
    • ResourceTypes — (Array<String>)

      [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

    • ResourceLocations — (Array<String>)

      [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

      If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

    • TargetTags — (Array<map>)

      [Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The tag value.

    • Schedules — (Array<map>)

      [Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.

      • 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>)

        [AMI policies and snapshot policies that target instances only] A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.

        • Key — required — (String)

          The tag key.

        • Value — required — (String)

          The tag value.

      • CreateRule — (map)

        The creation rule.

        • Location — (String)

          [Custom snapshot policies only] Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD. To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. If you omit this parameter, CLOUD is used by default.

          If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.

          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 Data Lifecycle Manager 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.

        • Scripts — (Array<map>)

          [Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. This is useful for creating application-consistent snapshots, or for performing specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.

          For more information, see Automating application-consistent snapshots with pre and post scripts.

          • Stages — (Array<String>)

            Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation.

            • To run a pre script only, specify PRE. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation.

            • To run a post script only, specify POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the post-script parameter after initiating snapshot creation.

            • To run both pre and post scripts, specify both PRE and POST. In this case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script parameter before initiating snapshot creation, and then it calls the SSM document again with the post-script parameter after initiating snapshot creation.

            If you are automating VSS Backups, omit this parameter.

            Default: PRE and POST

          • ExecutionHandlerService — (String)

            Indicates the service used to execute the pre and/or post scripts.

            • If you are using custom SSM documents or automating application-consistent snapshots of SAP HANA workloads, specify AWS_SYSTEMS_MANAGER.

            • If you are automating VSS Backups, omit this parameter.

            Default: AWS_SYSTEMS_MANAGER

            Possible values include:
            • "AWS_SYSTEMS_MANAGER"
          • ExecutionHandler — required — (String)

            The SSM document that includes the pre and/or post scripts to run.

            • If you are automating VSS backups, specify AWS_VSS_BACKUP. In this case, Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot SSM document.

            • If you are automating application-consistent snapshots for SAP HANA workloads, specify AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA.

            • If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document.

          • ExecuteOperationOnScriptFailure — (Boolean)

            Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails.

            • To default to crash consistent snapshot if the pre script fails, specify true.

            • To skip the instance for snapshot creation if the pre script fails, specify false.

            This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter.

            Default: true

          • ExecutionTimeout — (Integer)

            Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. If a script does not complete within its timeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre and post scripts individually.

            If you are automating VSS Backups, omit this parameter.

            Default: 10

          • MaximumRetryCount — (Integer)

            Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.

            • If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation process, including running the pre and post scripts.

            • If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this case, the pre script will have completed and the snapshot might have been created.

            If you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0.

            Default: 0

      • RetainRule — (map)

        The retention rule for snapshots or AMIs created by the policy.

        • Count — (Integer)

          The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to retain a maximum of three snapshots, specify 3. When the fourth snapshot is created, the oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.

        • Interval — (Integer)

          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. For example, to retain snapshots for 3 months, specify Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.

          Possible values include:
          • "DAYS"
          • "WEEKS"
          • "MONTHS"
          • "YEARS"
      • FastRestoreRule — (map)

        [Custom snapshot policies only] 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>)

        Specifies a rule for copying snapshots or AMIs across regions.

        Note: You can't specify cross-Region copy rules for policies that create snapshots on an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
        • TargetRegion — (String)
          Note: Use this parameter for AMI policies only. For snapshot policies, use Target instead. For snapshot policies created before the Target parameter was introduced, this parameter indicates the target Region for snapshot copies.

          [Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.

        • Target — (String)
          Note: Use this parameter for snapshot policies only. For AMI policies, use TargetRegion instead.

          [Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.

        • Encrypted — 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 or AMI to the cross-Region copy.

        • RetainRule — (map)

          The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.

          • Interval — (Integer)

            The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.

          • IntervalUnit — (String)

            The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.

            Possible values include:
            • "DAYS"
            • "WEEKS"
            • "MONTHS"
            • "YEARS"
        • DeprecateRule — (map)

          [Custom AMI policies only] 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. For example, to deprecate a cross-Region AMI copy after 3 months, specify Interval=3 and IntervalUnit=MONTHS.

            Possible values include:
            • "DAYS"
            • "WEEKS"
            • "MONTHS"
            • "YEARS"
      • ShareRules — (Array<map>)

        [Custom snapshot policies only] 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)

        [Custom AMI policies only] 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"
      • ArchiveRule — (map)

        [Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify.

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

        • RetainRule — required — (map)

          Information about the retention period for the snapshot archiving rule.

          • RetentionArchiveTier — required — (map)

            Information about retention period in the Amazon EBS Snapshots Archive. For more information, see Archive Amazon EBS snapshots.

            • Count — (Integer)

              The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days.

            • Interval — (Integer)

              Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.

            • IntervalUnit — (String)

              The unit of time in which to measure the Interval. For example, to retain a snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.

              Possible values include:
              • "DAYS"
              • "WEEKS"
              • "MONTHS"
              • "YEARS"
    • Parameters — (map)

      [Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

      Note: If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.
      • ExcludeBootVolume — (Boolean)

        [Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.

      • NoReboot — (Boolean)

        [Custom AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instances are not rebooted).

      • ExcludeDataVolumeTags — (Array<map>)

        [Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.

        If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.

        • Key — required — (String)

          The tag key.

        • Value — required — (String)

          The tag value.

    • EventSource — (map)

      [Event-based policies only] The event that activates the event-based policy.

      • 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>)

      [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.

      • 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 a retention rule for cross-Region snapshot copies created by snapshot or event-based policies, or cross-Region AMI copies created by AMI policies. After the retention period expires, the cross-Region copy is deleted.

          • Interval — (Integer)

            The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.

          • IntervalUnit — (String)

            The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.

            Possible values include:
            • "DAYS"
            • "WEEKS"
            • "MONTHS"
            • "YEARS"
    • PolicyLanguage — (String)

      The type of policy to create. Specify one of the following:

      • SIMPLIFIED To create a default policy.

      • STANDARD To create a custom policy.

      Possible values include:
      • "SIMPLIFIED"
      • "STANDARD"
    • ResourceType — (String)

      [Default policies only] Specify the type of default policy to create.

      • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.

      • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.

      Possible values include:
      • "VOLUME"
      • "INSTANCE"
    • CreateInterval — (Integer)

      [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.

      Default: 1

    • RetainInterval — (Integer)

      [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.

      Default: 7

    • CopyTags — (Boolean)

      [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.

      Default: false

    • CrossRegionCopyTargets — (Array<map>)

      [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.

      • TargetRegion — (String)

        The target Region, for example us-east-1.

    • ExtendDeletion — (Boolean)

      [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

      By default (ExtendDeletion=false):

      • If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true.

      • If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true.

      If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.

      If you do not specify a value, the default is false.

      Default: false

    • Exclusions — (map)

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

      • ExcludeBootVolumes — (Boolean)

        [Default policies for EBS snapshots only] Indicates whether to exclude volumes that are attached to instances as the boot volume. If you exclude boot volumes, only volumes attached as data (non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify true.

      • ExcludeVolumeTypes — (Array<String>)

        [Default policies for EBS snapshots only] Specifies the volume types to exclude. Volumes of the specified types will not be targeted by the policy.

      • ExcludeTags — (Array<map>)

        [Default policies for EBS-backed AMIs only] Specifies whether to exclude volumes that have specific tags.

        • Key — required — (String)

          The tag key.

        • Value — required — (String)

          The tag value.

  • CreateInterval — (Integer)

    [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.

  • RetainInterval — (Integer)

    [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time.

  • CopyTags — (Boolean)

    [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.

  • ExtendDeletion — (Boolean)

    [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

    By default (ExtendDeletion=false):

    • If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true.

    • If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true.

    If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.

    Default: false

  • CrossRegionCopyTargets — (Array<map>)

    [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.

    • TargetRegion — (String)

      The target Region, for example us-east-1.

  • Exclusions — (map)

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

    • ExcludeBootVolumes — (Boolean)

      [Default policies for EBS snapshots only] Indicates whether to exclude volumes that are attached to instances as the boot volume. If you exclude boot volumes, only volumes attached as data (non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify true.

    • ExcludeVolumeTypes — (Array<String>)

      [Default policies for EBS snapshots only] Specifies the volume types to exclude. Volumes of the specified types will not be targeted by the policy.

    • ExcludeTags — (Array<map>)

      [Default policies for EBS-backed AMIs only] Specifies whether to exclude volumes that have specific tags.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The tag value.

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.