[ aws . dlm ]

get-lifecycle-policy

Description

Gets detailed information about the specified lifecycle policy.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-lifecycle-policy
--policy-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--policy-id (string)

The identifier of the lifecycle policy.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To describe a lifecycle policy

The following get-lifecycle-policy example displays details for the specified lifecycle policy.

aws dlm get-lifecycle-policy \
    --policy-id policy-0123456789abcdef0

Output:

{
    "Policy": {
        "PolicyId": "policy-0123456789abcdef0",
        "Description": "My policy",
        "State": "ENABLED",
        "ExecutionRoleArn": "arn:aws:iam::123456789012:role/AWSDataLifecycleManagerDefaultRole",
        "DateCreated": "2019-08-08T17:45:42Z",
        "DateModified": "2019-08-08T17:45:42Z",
        "PolicyDetails": {
            "PolicyType": "EBS_SNAPSHOT_MANAGEMENT",
            "ResourceTypes": [
                "VOLUME"
            ],
            "TargetTags": [
              {
                  "Key": "costCenter",
                  "Value": "115"
              }
            ],
            "Schedules": [
              {
                  "Name": "DailySnapshots",
                  "CopyTags": true,
                  "TagsToAdd": [
                    {
                        "Key": "type",
                        "Value": "myDailySnapshot"
                    }
                  ],
                  "CreateRule": {
                    "Interval": 24,
                    "IntervalUnit": "HOURS",
                    "Times": [
                        "03:00"
                    ]
                  },
                  "RetainRule": {
                    "Count": 5
                  }
              }
            ]
        }
    }
}

Output

Policy -> (structure)

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.

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 -> (timestamp)

The local date and time when the lifecycle policy was created.

DateModified -> (timestamp)

The local date and time when the lifecycle policy was last modified.

PolicyDetails -> (structure)

The configuration of the lifecycle policy

PolicyType -> (string)

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

The default is EBS_SNAPSHOT_MANAGEMENT .

ResourceTypes -> (list)

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

(string)

ResourceLocations -> (list)

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

(string)

TargetTags -> (list)

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

(structure)

Specifies a tag for a resource.

Key -> (string)

The tag key.

Value -> (string)

The tag value.

Schedules -> (list)

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

(structure)

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

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 -> (list)

The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.

(structure)

Specifies a tag for a resource.

Key -> (string)

The tag key.

Value -> (string)

The tag value.

VariableTags -> (list)

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

(structure)

Specifies a tag for a resource.

Key -> (string)

The tag key.

Value -> (string)

The tag value.

CreateRule -> (structure)

The creation rule.

Location -> (string)

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

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

Interval -> (integer)

The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.

IntervalUnit -> (string)

The interval unit.

Times -> (list)

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.

(string)

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 -> (structure)

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.

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.

FastRestoreRule -> (structure)

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

AvailabilityZones -> (list)

The Availability Zones in which to enable fast snapshot restore.

(string)

CrossRegionCopyRules -> (list)

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.

(structure)

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

Note

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

TargetRegion -> (string)

Note

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 -> (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 -> (structure)

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 .

DeprecateRule -> (structure)

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

ShareRules -> (list)

[Snapshot policies only] The rule for sharing snapshots with other Amazon Web Services accounts.

(structure)

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

TargetAccounts -> (list)

The IDs of the Amazon Web Services accounts with which to share the snapshots.

(string)

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.

DeprecateRule -> (structure)

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

Parameters -> (structure)

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

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

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

ExcludeDataVolumeTags -> (list)

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

(structure)

Specifies a tag for a resource.

Key -> (string)

The tag key.

Value -> (string)

The tag value.

EventSource -> (structure)

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

Type -> (string)

The source of the event. Currently only managed CloudWatch Events rules are supported.

Parameters -> (structure)

Information about the event.

EventType -> (string)

The type of event. Currently, only snapshot sharing events are supported.

SnapshotOwner -> (list)

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.

(string)

DescriptionRegex -> (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 -> (list)

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

(structure)

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

Name -> (string)

A descriptive name for the action.

CrossRegionCopy -> (list)

The rule for copying shared snapshots across Regions.

(structure)

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

Note

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

Target -> (string)

The target Region.

EncryptionConfiguration -> (structure)

The encryption settings for the copied snapshot.

Encrypted -> (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 -> (structure)

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 .

Tags -> (map)

The tags.

key -> (string)

value -> (string)

PolicyArn -> (string)

The Amazon Resource Name (ARN) of the policy.