Amazon Data Lifecycle Manager 2018-01-12
- Client: Aws\DLM\DLMClient
- Service ID: dlm
- Version: 2018-01-12
This page describes the parameters and results for the operations of the Amazon Data Lifecycle Manager (2018-01-12), and shows how to use the Aws\DLM\DLMClient object to call the described operations. This documentation is specific to the 2018-01-12 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateLifecyclePolicy ( array $params = [] )
Creates a policy to manage the lifecycle of the specified AWS resources.
- DeleteLifecyclePolicy ( array $params = [] )
Deletes the specified lifecycle policy and halts the automated operations that the policy specified.
- GetLifecyclePolicies ( array $params = [] )
Gets summary information about all or the specified data lifecycle policies.
- GetLifecyclePolicy ( array $params = [] )
Gets detailed information about the specified lifecycle policy.
- ListTagsForResource ( array $params = [] )
Lists the tags for the specified resource.
- TagResource ( array $params = [] )
Adds the specified tags to the specified resource.
- UntagResource ( array $params = [] )
Removes the specified tags from the specified resource.
- UpdateLifecyclePolicy ( array $params = [] )
Updates the specified lifecycle policy.
Operations
CreateLifecyclePolicy
$result = $client->createLifecyclePolicy([/* ... */]); $promise = $client->createLifecyclePolicyAsync([/* ... */]);
Creates a policy to manage the lifecycle of the specified AWS resources. You can create up to 100 lifecycle policies.
Parameter Syntax
$result = $client->createLifecyclePolicy([
'Description' => '<string>', // REQUIRED
'ExecutionRoleArn' => '<string>', // REQUIRED
'PolicyDetails' => [ // REQUIRED
'Actions' => [
[
'CrossRegionCopy' => [ // REQUIRED
[
'EncryptionConfiguration' => [ // REQUIRED
'CmkArn' => '<string>',
'Encrypted' => true || false, // REQUIRED
],
'RetainRule' => [
'Interval' => <integer>,
'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
],
'Target' => '<string>', // REQUIRED
],
// ...
],
'Name' => '<string>', // REQUIRED
],
// ...
],
'EventSource' => [
'Parameters' => [
'DescriptionRegex' => '<string>', // REQUIRED
'EventType' => 'shareSnapshot', // REQUIRED
'SnapshotOwner' => ['<string>', ...], // REQUIRED
],
'Type' => 'MANAGED_CWE', // REQUIRED
],
'Parameters' => [
'ExcludeBootVolume' => true || false,
'NoReboot' => true || false,
],
'PolicyType' => 'EBS_SNAPSHOT_MANAGEMENT|IMAGE_MANAGEMENT|EVENT_BASED_POLICY',
'ResourceLocations' => ['<string>', ...],
'ResourceTypes' => ['<string>', ...],
'Schedules' => [
[
'CopyTags' => true || false,
'CreateRule' => [
'CronExpression' => '<string>',
'Interval' => <integer>,
'IntervalUnit' => 'HOURS',
'Location' => 'CLOUD|OUTPOST_LOCAL',
'Times' => ['<string>', ...],
],
'CrossRegionCopyRules' => [
[
'CmkArn' => '<string>',
'CopyTags' => true || false,
'Encrypted' => true || false, // REQUIRED
'RetainRule' => [
'Interval' => <integer>,
'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
],
'Target' => '<string>',
'TargetRegion' => '<string>',
],
// ...
],
'FastRestoreRule' => [
'AvailabilityZones' => ['<string>', ...], // REQUIRED
'Count' => <integer>,
'Interval' => <integer>,
'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
],
'Name' => '<string>',
'RetainRule' => [
'Count' => <integer>,
'Interval' => <integer>,
'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
],
'ShareRules' => [
[
'TargetAccounts' => ['<string>', ...], // REQUIRED
'UnshareInterval' => <integer>,
'UnshareIntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
],
// ...
],
'TagsToAdd' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'VariableTags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
],
// ...
],
'TargetTags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
],
'State' => 'ENABLED|DISABLED', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- Description
-
- Required: Yes
- Type: string
A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
- ExecutionRoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
- PolicyDetails
-
- Required: Yes
- Type: PolicyDetails structure
The configuration details of the lifecycle policy.
- State
-
- Required: Yes
- Type: string
The desired activation state of the lifecycle policy after creation.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags to apply to the lifecycle policy during creation.
Result Syntax
[
'PolicyId' => '<string>',
]
Result Details
Errors
-
Bad request. The request is missing required parameters or has invalid parameters.
-
The request failed because a limit was exceeded.
-
The service failed in an unexpected way.
DeleteLifecyclePolicy
$result = $client->deleteLifecyclePolicy([/* ... */]); $promise = $client->deleteLifecyclePolicyAsync([/* ... */]);
Deletes the specified lifecycle policy and halts the automated operations that the policy specified.
Parameter Syntax
$result = $client->deleteLifecyclePolicy([
'PolicyId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
A requested resource was not found.
-
The service failed in an unexpected way.
-
The request failed because a limit was exceeded.
GetLifecyclePolicies
$result = $client->getLifecyclePolicies([/* ... */]); $promise = $client->getLifecyclePoliciesAsync([/* ... */]);
Gets summary information about all or the specified data lifecycle policies.
To get complete information about a policy, use GetLifecyclePolicy.
Parameter Syntax
$result = $client->getLifecyclePolicies([
'PolicyIds' => ['<string>', ...],
'ResourceTypes' => ['<string>', ...],
'State' => 'ENABLED|DISABLED|ERROR',
'TagsToAdd' => ['<string>', ...],
'TargetTags' => ['<string>', ...],
]);
Parameter Details
Members
- PolicyIds
-
- Type: Array of strings
The identifiers of the data lifecycle policies.
- ResourceTypes
-
- Type: Array of strings
The resource type.
- State
-
- Type: string
The activation state.
- TagsToAdd
-
- Type: Array of strings
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 AWS-added lifecycle tags.
- TargetTags
-
- Type: Array of strings
The target tag for a policy.
Tags are strings in the format
key=value.
Result Syntax
[
'Policies' => [
[
'Description' => '<string>',
'PolicyId' => '<string>',
'PolicyType' => 'EBS_SNAPSHOT_MANAGEMENT|IMAGE_MANAGEMENT|EVENT_BASED_POLICY',
'State' => 'ENABLED|DISABLED|ERROR',
'Tags' => ['<string>', ...],
],
// ...
],
]
Result Details
Members
- Policies
-
- Type: Array of LifecyclePolicySummary structures
Summary information about the lifecycle policies.
Errors
-
A requested resource was not found.
-
Bad request. The request is missing required parameters or has invalid parameters.
-
The service failed in an unexpected way.
-
The request failed because a limit was exceeded.
GetLifecyclePolicy
$result = $client->getLifecyclePolicy([/* ... */]); $promise = $client->getLifecyclePolicyAsync([/* ... */]);
Gets detailed information about the specified lifecycle policy.
Parameter Syntax
$result = $client->getLifecyclePolicy([
'PolicyId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Policy' => [
'DateCreated' => <DateTime>,
'DateModified' => <DateTime>,
'Description' => '<string>',
'ExecutionRoleArn' => '<string>',
'PolicyArn' => '<string>',
'PolicyDetails' => [
'Actions' => [
[
'CrossRegionCopy' => [
[
'EncryptionConfiguration' => [
'CmkArn' => '<string>',
'Encrypted' => true || false,
],
'RetainRule' => [
'Interval' => <integer>,
'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
],
'Target' => '<string>',
],
// ...
],
'Name' => '<string>',
],
// ...
],
'EventSource' => [
'Parameters' => [
'DescriptionRegex' => '<string>',
'EventType' => 'shareSnapshot',
'SnapshotOwner' => ['<string>', ...],
],
'Type' => 'MANAGED_CWE',
],
'Parameters' => [
'ExcludeBootVolume' => true || false,
'NoReboot' => true || false,
],
'PolicyType' => 'EBS_SNAPSHOT_MANAGEMENT|IMAGE_MANAGEMENT|EVENT_BASED_POLICY',
'ResourceLocations' => ['<string>', ...],
'ResourceTypes' => ['<string>', ...],
'Schedules' => [
[
'CopyTags' => true || false,
'CreateRule' => [
'CronExpression' => '<string>',
'Interval' => <integer>,
'IntervalUnit' => 'HOURS',
'Location' => 'CLOUD|OUTPOST_LOCAL',
'Times' => ['<string>', ...],
],
'CrossRegionCopyRules' => [
[
'CmkArn' => '<string>',
'CopyTags' => true || false,
'Encrypted' => true || false,
'RetainRule' => [
'Interval' => <integer>,
'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
],
'Target' => '<string>',
'TargetRegion' => '<string>',
],
// ...
],
'FastRestoreRule' => [
'AvailabilityZones' => ['<string>', ...],
'Count' => <integer>,
'Interval' => <integer>,
'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
],
'Name' => '<string>',
'RetainRule' => [
'Count' => <integer>,
'Interval' => <integer>,
'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
],
'ShareRules' => [
[
'TargetAccounts' => ['<string>', ...],
'UnshareInterval' => <integer>,
'UnshareIntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
],
// ...
],
'TagsToAdd' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'VariableTags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
// ...
],
'TargetTags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
'PolicyId' => '<string>',
'State' => 'ENABLED|DISABLED|ERROR',
'StatusMessage' => '<string>',
'Tags' => ['<string>', ...],
],
]
Result Details
Members
- Policy
-
- Type: LifecyclePolicy structure
Detailed information about the lifecycle policy.
Errors
-
A requested resource was not found.
-
The service failed in an unexpected way.
-
The request failed because a limit was exceeded.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists the tags for the specified resource.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Tags' => ['<string>', ...],
]
Result Details
Members
Errors
-
The service failed in an unexpected way.
-
Bad request. The request is missing required parameters or has invalid parameters.
-
A requested resource was not found.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds the specified tags to the specified resource.
Parameter Syntax
$result = $client->tagResource([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The service failed in an unexpected way.
-
Bad request. The request is missing required parameters or has invalid parameters.
-
A requested resource was not found.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes the specified tags from the specified resource.
Parameter Syntax
$result = $client->untagResource([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The service failed in an unexpected way.
-
Bad request. The request is missing required parameters or has invalid parameters.
-
A requested resource was not found.
UpdateLifecyclePolicy
$result = $client->updateLifecyclePolicy([/* ... */]); $promise = $client->updateLifecyclePolicyAsync([/* ... */]);
Updates the specified lifecycle policy.
Parameter Syntax
$result = $client->updateLifecyclePolicy([
'Description' => '<string>',
'ExecutionRoleArn' => '<string>',
'PolicyDetails' => [
'Actions' => [
[
'CrossRegionCopy' => [ // REQUIRED
[
'EncryptionConfiguration' => [ // REQUIRED
'CmkArn' => '<string>',
'Encrypted' => true || false, // REQUIRED
],
'RetainRule' => [
'Interval' => <integer>,
'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
],
'Target' => '<string>', // REQUIRED
],
// ...
],
'Name' => '<string>', // REQUIRED
],
// ...
],
'EventSource' => [
'Parameters' => [
'DescriptionRegex' => '<string>', // REQUIRED
'EventType' => 'shareSnapshot', // REQUIRED
'SnapshotOwner' => ['<string>', ...], // REQUIRED
],
'Type' => 'MANAGED_CWE', // REQUIRED
],
'Parameters' => [
'ExcludeBootVolume' => true || false,
'NoReboot' => true || false,
],
'PolicyType' => 'EBS_SNAPSHOT_MANAGEMENT|IMAGE_MANAGEMENT|EVENT_BASED_POLICY',
'ResourceLocations' => ['<string>', ...],
'ResourceTypes' => ['<string>', ...],
'Schedules' => [
[
'CopyTags' => true || false,
'CreateRule' => [
'CronExpression' => '<string>',
'Interval' => <integer>,
'IntervalUnit' => 'HOURS',
'Location' => 'CLOUD|OUTPOST_LOCAL',
'Times' => ['<string>', ...],
],
'CrossRegionCopyRules' => [
[
'CmkArn' => '<string>',
'CopyTags' => true || false,
'Encrypted' => true || false, // REQUIRED
'RetainRule' => [
'Interval' => <integer>,
'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
],
'Target' => '<string>',
'TargetRegion' => '<string>',
],
// ...
],
'FastRestoreRule' => [
'AvailabilityZones' => ['<string>', ...], // REQUIRED
'Count' => <integer>,
'Interval' => <integer>,
'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
],
'Name' => '<string>',
'RetainRule' => [
'Count' => <integer>,
'Interval' => <integer>,
'IntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
],
'ShareRules' => [
[
'TargetAccounts' => ['<string>', ...], // REQUIRED
'UnshareInterval' => <integer>,
'UnshareIntervalUnit' => 'DAYS|WEEKS|MONTHS|YEARS',
],
// ...
],
'TagsToAdd' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'VariableTags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
],
// ...
],
'TargetTags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
],
'PolicyId' => '<string>', // REQUIRED
'State' => 'ENABLED|DISABLED',
]);
Parameter Details
Members
- Description
-
- Type: string
A description of the lifecycle policy.
- ExecutionRoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
- PolicyDetails
-
- Type: PolicyDetails structure
The configuration of the lifecycle policy. You cannot update the policy type or the resource type.
- PolicyId
-
- Required: Yes
- Type: string
The identifier of the lifecycle policy.
- State
-
- Type: string
The desired activation state of the lifecycle policy after creation.
Result Syntax
[]
Result Details
Errors
-
A requested resource was not found.
-
Bad request. The request is missing required parameters or has invalid parameters.
-
The service failed in an unexpected way.
-
The request failed because a limit was exceeded.
Shapes
Action
Description
Specifies an action for an event-based policy.
Members
- CrossRegionCopy
-
- Required: Yes
- Type: Array of CrossRegionCopyAction structures
The rule for copying shared snapshots across Regions.
- Name
-
- Required: Yes
- Type: string
A descriptive name for the action.
CreateRule
Description
Specifies when to create snapshots of EBS volumes.
You must specify either a Cron expression or an interval, interval unit, and start time. You cannot specify both.
Members
- CronExpression
-
- Type: 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.
- Interval
-
- Type: int
The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
- IntervalUnit
-
- Type: string
The interval unit.
- Location
-
- Type: string
Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify
CLOUD. To create snapshots on the same Outpost as the source resource, specifyOUTPOST_LOCAL. If you omit this parameter,CLOUDis used by default.If the policy targets resources in an AWS 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.
- Times
-
- Type: Array of strings
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.
CrossRegionCopyAction
Description
Specifies a rule for copying shared snapshots across Regions.
Members
- EncryptionConfiguration
-
- Required: Yes
- Type: EncryptionConfiguration structure
The encryption settings for the copied snapshot.
- RetainRule
-
- Type: CrossRegionCopyRetainRule structure
Specifies the retention rule for cross-Region snapshot copies.
- Target
-
- Required: Yes
- Type: string
The target Region.
CrossRegionCopyRetainRule
Description
Specifies the retention rule for cross-Region snapshot copies.
Members
CrossRegionCopyRule
Description
Specifies a rule for cross-Region snapshot copies.
Members
- CmkArn
-
- Type: string
The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used.
- CopyTags
-
- Type: boolean
Copy all user-defined tags from the source snapshot to the copied snapshot.
- Encrypted
-
- Required: Yes
- Type: 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.
- RetainRule
-
- Type: CrossRegionCopyRetainRule structure
The retention rule.
- Target
-
- Type: string
The Amazon Resource Name (ARN) of the target AWS Outpost for the snapshot copies.
If you specify an ARN, you must omit TargetRegion. You cannot specify a target Region and a target Outpost in the same rule.
- TargetRegion
-
- Type: string
The target Region for the snapshot copies.
If you specify a target Region, you must omit Target. You cannot specify a target Region and a target Outpost in the same rule.
EncryptionConfiguration
Description
Specifies the encryption settings for shared snapshots that are copied across Regions.
Members
- CmkArn
-
- Type: string
The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used.
- Encrypted
-
- Required: Yes
- Type: 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.
EventParameters
Description
Specifies an event that triggers an event-based policy.
Members
- DescriptionRegex
-
- Required: Yes
- Type: 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 policypolicy-1234567890abcdef0are shared with your account. - EventType
-
- Required: Yes
- Type: string
The type of event. Currently, only snapshot sharing events are supported.
- SnapshotOwner
-
- Required: Yes
- Type: Array of strings
The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified AWS accounts shares a snapshot with your account.
EventSource
Description
Specifies an event that triggers an event-based policy.
Members
- Parameters
-
- Type: EventParameters structure
Information about the event.
- Type
-
- Required: Yes
- Type: string
The source of the event. Currently only managed AWS CloudWatch Events rules are supported.
FastRestoreRule
Description
Specifies a rule for enabling fast snapshot restore. You can enable fast snapshot restore based on either a count or a time interval.
Members
- AvailabilityZones
-
- Required: Yes
- Type: Array of strings
The Availability Zones in which to enable fast snapshot restore.
- Count
-
- Type: int
The number of snapshots to be enabled with fast snapshot restore.
- Interval
-
- Type: int
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
-
- Type: string
The unit of time for enabling fast snapshot restore.
InternalServerException
InvalidRequestException
Description
Bad request. The request is missing required parameters or has invalid parameters.
Members
LifecyclePolicy
Description
Detailed information about a lifecycle policy.
Members
- DateCreated
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The local date and time when the lifecycle policy was created.
- DateModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The local date and time when the lifecycle policy was last modified.
- Description
-
- Type: string
The description of the lifecycle policy.
- ExecutionRoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
- PolicyArn
-
- Type: string
The Amazon Resource Name (ARN) of the policy.
- PolicyDetails
-
- Type: PolicyDetails structure
The configuration of the lifecycle policy
- PolicyId
-
- Type: string
The identifier of the lifecycle policy.
- State
-
- Type: string
The activation state of the lifecycle policy.
- StatusMessage
-
- Type: string
The description of the status.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags.
LifecyclePolicySummary
Description
Summary information about a lifecycle policy.
Members
- Description
-
- Type: string
The description of the lifecycle policy.
- PolicyId
-
- Type: string
The identifier of the lifecycle policy.
- PolicyType
-
- Type: string
The type of policy.
EBS_SNAPSHOT_MANAGEMENTindicates that the policy manages the lifecycle of Amazon EBS snapshots.IMAGE_MANAGEMENTindicates that the policy manages the lifecycle of EBS-backed AMIs. - State
-
- Type: string
The activation state of the lifecycle policy.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags.
LimitExceededException
Description
The request failed because a limit was exceeded.
Members
Parameters
Description
Specifies optional parameters to add to a policy. The set of valid parameters depends on the combination of policy type and resource type.
Members
- ExcludeBootVolume
-
- Type: boolean
[EBS Snapshot Management – Instance policies only] Indicates whether to exclude the root volume from snapshots created using CreateSnapshots. The default is false.
- NoReboot
-
- Type: boolean
Applies to AMI lifecycle policies only. Indicates whether targeted instances are rebooted when the lifecycle policy runs.
trueindicates that targeted instances are not rebooted when the policy runs.falseindicates that target instances are rebooted when the policy runs. The default istrue(instances are not rebooted).
PolicyDetails
Description
Specifies the configuration of a lifecycle policy.
Members
- Actions
-
- Type: Array of Action structures
The actions to be performed when the event-based policy is triggered. You can specify only one action per policy.
This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
- EventSource
-
- Type: EventSource structure
The event that triggers the event-based policy.
This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
- Parameters
-
- Type: Parameters structure
A set of optional parameters for snapshot and AMI lifecycle policies.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
- PolicyType
-
- Type: string
The valid target resource types and actions a policy can manage. Specify
EBS_SNAPSHOT_MANAGEMENTto create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. SpecifyIMAGE_MANAGEMENTto create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. SpecifyEVENT_BASED_POLICYto create an event-based policy that performs specific actions when a defined event occurs in your AWS account.The default is
EBS_SNAPSHOT_MANAGEMENT. - ResourceLocations
-
- Type: Array of strings
The location of the resources to backup. If the source resources are located in an AWS Region, specify
CLOUD. If the source resources are located on an AWS Outpost in your account, specifyOUTPOST.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. - ResourceTypes
-
- Type: Array of strings
The target resource type for snapshot and AMI lifecycle policies. Use
VOLUMEto create snapshots of individual volumes or useINSTANCEto create multi-volume snapshots from the volumes for an instance.This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
- Schedules
-
- Type: Array of Schedule structures
The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
- TargetTags
-
- Type: Array of Tag structures
The single tag that identifies targeted resources for this policy.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
ResourceNotFoundException
Description
A requested resource was not found.
Members
RetainRule
Description
Specifies the retention rule for a lifecycle policy. You can retain snapshots based on either a count or a time interval.
Members
- Count
-
- Type: int
The number of snapshots to retain for each volume, up to a maximum of 1000.
- Interval
-
- Type: int
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
-
- Type: string
The unit of time for time-based retention.
Schedule
Description
Specifies a backup schedule for a snapshot or AMI lifecycle policy.
Members
- CopyTags
-
- Type: boolean
Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
- CreateRule
-
- Type: CreateRule structure
The creation rule.
- CrossRegionCopyRules
-
- Type: Array of CrossRegionCopyRule structures
The rule for cross-Region snapshot copies.
You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
- FastRestoreRule
-
- Type: FastRestoreRule structure
The rule for enabling fast snapshot restore.
- Name
-
- Type: string
The name of the schedule.
- RetainRule
-
- Type: RetainRule structure
The retention rule.
- ShareRules
-
- Type: Array of ShareRule structures
The rule for sharing snapshots with other AWS accounts.
- TagsToAdd
-
- Type: Array of Tag structures
The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.
- VariableTags
-
- Type: Array of Tag structures
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.
ShareRule
Description
Specifies a rule for sharing snapshots across AWS accounts.
Members
- TargetAccounts
-
- Required: Yes
- Type: Array of strings
The IDs of the AWS accounts with which to share the snapshots.
- UnshareInterval
-
- Type: int
The period after which snapshots that are shared with other AWS accounts are automatically unshared.
- UnshareIntervalUnit
-
- Type: string
The unit of time for the automatic unsharing interval.