Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Operations
- Types
- Action
- ArchiveRetainRule
- ArchiveRule
- CreateRule
- CrossRegionCopyAction
- CrossRegionCopyDeprecateRule
- CrossRegionCopyRetainRule
- CrossRegionCopyRule
- DeprecateRule
- EncryptionConfiguration
- EventParameters
- EventSource
- FastRestoreRule
- LifecyclePolicy
- LifecyclePolicySummary
- Parameters
- PolicyDetails
- RetainRule
- RetentionArchiveTier
- Schedule
- ShareRule
- Tag
Synopsis
- createLifecyclePolicy_tags :: Lens' CreateLifecyclePolicy (Maybe (HashMap Text Text))
- createLifecyclePolicy_executionRoleArn :: Lens' CreateLifecyclePolicy Text
- createLifecyclePolicy_description :: Lens' CreateLifecyclePolicy Text
- createLifecyclePolicy_state :: Lens' CreateLifecyclePolicy SettablePolicyStateValues
- createLifecyclePolicy_policyDetails :: Lens' CreateLifecyclePolicy PolicyDetails
- createLifecyclePolicyResponse_policyId :: Lens' CreateLifecyclePolicyResponse (Maybe Text)
- createLifecyclePolicyResponse_httpStatus :: Lens' CreateLifecyclePolicyResponse Int
- deleteLifecyclePolicy_policyId :: Lens' DeleteLifecyclePolicy Text
- deleteLifecyclePolicyResponse_httpStatus :: Lens' DeleteLifecyclePolicyResponse Int
- getLifecyclePolicies_policyIds :: Lens' GetLifecyclePolicies (Maybe [Text])
- getLifecyclePolicies_resourceTypes :: Lens' GetLifecyclePolicies (Maybe (NonEmpty ResourceTypeValues))
- getLifecyclePolicies_state :: Lens' GetLifecyclePolicies (Maybe GettablePolicyStateValues)
- getLifecyclePolicies_tagsToAdd :: Lens' GetLifecyclePolicies (Maybe [Text])
- getLifecyclePolicies_targetTags :: Lens' GetLifecyclePolicies (Maybe (NonEmpty Text))
- getLifecyclePoliciesResponse_policies :: Lens' GetLifecyclePoliciesResponse (Maybe [LifecyclePolicySummary])
- getLifecyclePoliciesResponse_httpStatus :: Lens' GetLifecyclePoliciesResponse Int
- getLifecyclePolicy_policyId :: Lens' GetLifecyclePolicy Text
- getLifecyclePolicyResponse_policy :: Lens' GetLifecyclePolicyResponse (Maybe LifecyclePolicy)
- getLifecyclePolicyResponse_httpStatus :: Lens' GetLifecyclePolicyResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (HashMap Text Text)
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text)
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateLifecyclePolicy_description :: Lens' UpdateLifecyclePolicy (Maybe Text)
- updateLifecyclePolicy_executionRoleArn :: Lens' UpdateLifecyclePolicy (Maybe Text)
- updateLifecyclePolicy_policyDetails :: Lens' UpdateLifecyclePolicy (Maybe PolicyDetails)
- updateLifecyclePolicy_state :: Lens' UpdateLifecyclePolicy (Maybe SettablePolicyStateValues)
- updateLifecyclePolicy_policyId :: Lens' UpdateLifecyclePolicy Text
- updateLifecyclePolicyResponse_httpStatus :: Lens' UpdateLifecyclePolicyResponse Int
- action_name :: Lens' Action Text
- action_crossRegionCopy :: Lens' Action [CrossRegionCopyAction]
- archiveRetainRule_retentionArchiveTier :: Lens' ArchiveRetainRule RetentionArchiveTier
- archiveRule_retainRule :: Lens' ArchiveRule ArchiveRetainRule
- createRule_cronExpression :: Lens' CreateRule (Maybe Text)
- createRule_interval :: Lens' CreateRule (Maybe Natural)
- createRule_intervalUnit :: Lens' CreateRule (Maybe IntervalUnitValues)
- createRule_location :: Lens' CreateRule (Maybe LocationValues)
- createRule_times :: Lens' CreateRule (Maybe [Text])
- crossRegionCopyAction_retainRule :: Lens' CrossRegionCopyAction (Maybe CrossRegionCopyRetainRule)
- crossRegionCopyAction_target :: Lens' CrossRegionCopyAction Text
- crossRegionCopyAction_encryptionConfiguration :: Lens' CrossRegionCopyAction EncryptionConfiguration
- crossRegionCopyDeprecateRule_interval :: Lens' CrossRegionCopyDeprecateRule (Maybe Natural)
- crossRegionCopyDeprecateRule_intervalUnit :: Lens' CrossRegionCopyDeprecateRule (Maybe RetentionIntervalUnitValues)
- crossRegionCopyRetainRule_interval :: Lens' CrossRegionCopyRetainRule (Maybe Natural)
- crossRegionCopyRetainRule_intervalUnit :: Lens' CrossRegionCopyRetainRule (Maybe RetentionIntervalUnitValues)
- crossRegionCopyRule_cmkArn :: Lens' CrossRegionCopyRule (Maybe Text)
- crossRegionCopyRule_copyTags :: Lens' CrossRegionCopyRule (Maybe Bool)
- crossRegionCopyRule_deprecateRule :: Lens' CrossRegionCopyRule (Maybe CrossRegionCopyDeprecateRule)
- crossRegionCopyRule_retainRule :: Lens' CrossRegionCopyRule (Maybe CrossRegionCopyRetainRule)
- crossRegionCopyRule_target :: Lens' CrossRegionCopyRule (Maybe Text)
- crossRegionCopyRule_targetRegion :: Lens' CrossRegionCopyRule (Maybe Text)
- crossRegionCopyRule_encrypted :: Lens' CrossRegionCopyRule Bool
- deprecateRule_count :: Lens' DeprecateRule (Maybe Natural)
- deprecateRule_interval :: Lens' DeprecateRule (Maybe Natural)
- deprecateRule_intervalUnit :: Lens' DeprecateRule (Maybe RetentionIntervalUnitValues)
- encryptionConfiguration_cmkArn :: Lens' EncryptionConfiguration (Maybe Text)
- encryptionConfiguration_encrypted :: Lens' EncryptionConfiguration Bool
- eventParameters_eventType :: Lens' EventParameters EventTypeValues
- eventParameters_snapshotOwner :: Lens' EventParameters [Text]
- eventParameters_descriptionRegex :: Lens' EventParameters Text
- eventSource_parameters :: Lens' EventSource (Maybe EventParameters)
- eventSource_type :: Lens' EventSource EventSourceValues
- fastRestoreRule_count :: Lens' FastRestoreRule (Maybe Natural)
- fastRestoreRule_interval :: Lens' FastRestoreRule (Maybe Natural)
- fastRestoreRule_intervalUnit :: Lens' FastRestoreRule (Maybe RetentionIntervalUnitValues)
- fastRestoreRule_availabilityZones :: Lens' FastRestoreRule (NonEmpty Text)
- lifecyclePolicy_dateCreated :: Lens' LifecyclePolicy (Maybe UTCTime)
- lifecyclePolicy_dateModified :: Lens' LifecyclePolicy (Maybe UTCTime)
- lifecyclePolicy_description :: Lens' LifecyclePolicy (Maybe Text)
- lifecyclePolicy_executionRoleArn :: Lens' LifecyclePolicy (Maybe Text)
- lifecyclePolicy_policyArn :: Lens' LifecyclePolicy (Maybe Text)
- lifecyclePolicy_policyDetails :: Lens' LifecyclePolicy (Maybe PolicyDetails)
- lifecyclePolicy_policyId :: Lens' LifecyclePolicy (Maybe Text)
- lifecyclePolicy_state :: Lens' LifecyclePolicy (Maybe GettablePolicyStateValues)
- lifecyclePolicy_statusMessage :: Lens' LifecyclePolicy (Maybe Text)
- lifecyclePolicy_tags :: Lens' LifecyclePolicy (Maybe (HashMap Text Text))
- lifecyclePolicySummary_description :: Lens' LifecyclePolicySummary (Maybe Text)
- lifecyclePolicySummary_policyId :: Lens' LifecyclePolicySummary (Maybe Text)
- lifecyclePolicySummary_policyType :: Lens' LifecyclePolicySummary (Maybe PolicyTypeValues)
- lifecyclePolicySummary_state :: Lens' LifecyclePolicySummary (Maybe GettablePolicyStateValues)
- lifecyclePolicySummary_tags :: Lens' LifecyclePolicySummary (Maybe (HashMap Text Text))
- parameters_excludeBootVolume :: Lens' Parameters (Maybe Bool)
- parameters_excludeDataVolumeTags :: Lens' Parameters (Maybe [Tag])
- parameters_noReboot :: Lens' Parameters (Maybe Bool)
- policyDetails_actions :: Lens' PolicyDetails (Maybe (NonEmpty Action))
- policyDetails_eventSource :: Lens' PolicyDetails (Maybe EventSource)
- policyDetails_parameters :: Lens' PolicyDetails (Maybe Parameters)
- policyDetails_policyType :: Lens' PolicyDetails (Maybe PolicyTypeValues)
- policyDetails_resourceLocations :: Lens' PolicyDetails (Maybe (NonEmpty ResourceLocationValues))
- policyDetails_resourceTypes :: Lens' PolicyDetails (Maybe (NonEmpty ResourceTypeValues))
- policyDetails_schedules :: Lens' PolicyDetails (Maybe (NonEmpty Schedule))
- policyDetails_targetTags :: Lens' PolicyDetails (Maybe (NonEmpty Tag))
- retainRule_count :: Lens' RetainRule (Maybe Natural)
- retainRule_interval :: Lens' RetainRule (Maybe Natural)
- retainRule_intervalUnit :: Lens' RetainRule (Maybe RetentionIntervalUnitValues)
- retentionArchiveTier_count :: Lens' RetentionArchiveTier (Maybe Natural)
- retentionArchiveTier_interval :: Lens' RetentionArchiveTier (Maybe Natural)
- retentionArchiveTier_intervalUnit :: Lens' RetentionArchiveTier (Maybe RetentionIntervalUnitValues)
- schedule_archiveRule :: Lens' Schedule (Maybe ArchiveRule)
- schedule_copyTags :: Lens' Schedule (Maybe Bool)
- schedule_createRule :: Lens' Schedule (Maybe CreateRule)
- schedule_crossRegionCopyRules :: Lens' Schedule (Maybe [CrossRegionCopyRule])
- schedule_deprecateRule :: Lens' Schedule (Maybe DeprecateRule)
- schedule_fastRestoreRule :: Lens' Schedule (Maybe FastRestoreRule)
- schedule_name :: Lens' Schedule (Maybe Text)
- schedule_retainRule :: Lens' Schedule (Maybe RetainRule)
- schedule_shareRules :: Lens' Schedule (Maybe [ShareRule])
- schedule_tagsToAdd :: Lens' Schedule (Maybe [Tag])
- schedule_variableTags :: Lens' Schedule (Maybe [Tag])
- shareRule_unshareInterval :: Lens' ShareRule (Maybe Natural)
- shareRule_unshareIntervalUnit :: Lens' ShareRule (Maybe RetentionIntervalUnitValues)
- shareRule_targetAccounts :: Lens' ShareRule (NonEmpty Text)
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
Operations
CreateLifecyclePolicy
createLifecyclePolicy_tags :: Lens' CreateLifecyclePolicy (Maybe (HashMap Text Text)) Source #
The tags to apply to the lifecycle policy during creation.
createLifecyclePolicy_executionRoleArn :: Lens' CreateLifecyclePolicy Text Source #
The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
createLifecyclePolicy_description :: Lens' CreateLifecyclePolicy Text Source #
A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
createLifecyclePolicy_state :: Lens' CreateLifecyclePolicy SettablePolicyStateValues Source #
The desired activation state of the lifecycle policy after creation.
createLifecyclePolicy_policyDetails :: Lens' CreateLifecyclePolicy PolicyDetails Source #
The configuration details of the lifecycle policy.
createLifecyclePolicyResponse_policyId :: Lens' CreateLifecyclePolicyResponse (Maybe Text) Source #
The identifier of the lifecycle policy.
createLifecyclePolicyResponse_httpStatus :: Lens' CreateLifecyclePolicyResponse Int Source #
The response's http status code.
DeleteLifecyclePolicy
deleteLifecyclePolicy_policyId :: Lens' DeleteLifecyclePolicy Text Source #
The identifier of the lifecycle policy.
deleteLifecyclePolicyResponse_httpStatus :: Lens' DeleteLifecyclePolicyResponse Int Source #
The response's http status code.
GetLifecyclePolicies
getLifecyclePolicies_policyIds :: Lens' GetLifecyclePolicies (Maybe [Text]) Source #
The identifiers of the data lifecycle policies.
getLifecyclePolicies_resourceTypes :: Lens' GetLifecyclePolicies (Maybe (NonEmpty ResourceTypeValues)) Source #
The resource type.
getLifecyclePolicies_state :: Lens' GetLifecyclePolicies (Maybe GettablePolicyStateValues) Source #
The activation state.
getLifecyclePolicies_tagsToAdd :: Lens' GetLifecyclePolicies (Maybe [Text]) Source #
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.
getLifecyclePolicies_targetTags :: Lens' GetLifecyclePolicies (Maybe (NonEmpty Text)) Source #
The target tag for a policy.
Tags are strings in the format key=value
.
getLifecyclePoliciesResponse_policies :: Lens' GetLifecyclePoliciesResponse (Maybe [LifecyclePolicySummary]) Source #
Summary information about the lifecycle policies.
getLifecyclePoliciesResponse_httpStatus :: Lens' GetLifecyclePoliciesResponse Int Source #
The response's http status code.
GetLifecyclePolicy
getLifecyclePolicy_policyId :: Lens' GetLifecyclePolicy Text Source #
The identifier of the lifecycle policy.
getLifecyclePolicyResponse_policy :: Lens' GetLifecyclePolicyResponse (Maybe LifecyclePolicy) Source #
Detailed information about the lifecycle policy.
getLifecyclePolicyResponse_httpStatus :: Lens' GetLifecyclePolicyResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The Amazon Resource Name (ARN) of the resource.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #
Information about the tags.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN) of the resource.
tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #
One or more tags.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The Amazon Resource Name (ARN) of the resource.
untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #
The tag keys.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateLifecyclePolicy
updateLifecyclePolicy_description :: Lens' UpdateLifecyclePolicy (Maybe Text) Source #
A description of the lifecycle policy.
updateLifecyclePolicy_executionRoleArn :: Lens' UpdateLifecyclePolicy (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
updateLifecyclePolicy_policyDetails :: Lens' UpdateLifecyclePolicy (Maybe PolicyDetails) Source #
The configuration of the lifecycle policy. You cannot update the policy type or the resource type.
updateLifecyclePolicy_state :: Lens' UpdateLifecyclePolicy (Maybe SettablePolicyStateValues) Source #
The desired activation state of the lifecycle policy after creation.
updateLifecyclePolicy_policyId :: Lens' UpdateLifecyclePolicy Text Source #
The identifier of the lifecycle policy.
updateLifecyclePolicyResponse_httpStatus :: Lens' UpdateLifecyclePolicyResponse Int Source #
The response's http status code.
Types
Action
action_crossRegionCopy :: Lens' Action [CrossRegionCopyAction] Source #
The rule for copying shared snapshots across Regions.
ArchiveRetainRule
archiveRetainRule_retentionArchiveTier :: Lens' ArchiveRetainRule RetentionArchiveTier Source #
Information about retention period in the Amazon EBS Snapshots Archive. For more information, see Archive Amazon EBS snapshots.
ArchiveRule
archiveRule_retainRule :: Lens' ArchiveRule ArchiveRetainRule Source #
Information about the retention period for the snapshot archiving rule.
CreateRule
createRule_cronExpression :: Lens' CreateRule (Maybe Text) Source #
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.
createRule_interval :: Lens' CreateRule (Maybe Natural) Source #
The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
createRule_intervalUnit :: Lens' CreateRule (Maybe IntervalUnitValues) Source #
The interval unit.
createRule_location :: Lens' CreateRule (Maybe LocationValues) Source #
[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.
createRule_times :: Lens' CreateRule (Maybe [Text]) Source #
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.
CrossRegionCopyAction
crossRegionCopyAction_retainRule :: Lens' CrossRegionCopyAction (Maybe CrossRegionCopyRetainRule) Source #
Undocumented member.
crossRegionCopyAction_target :: Lens' CrossRegionCopyAction Text Source #
The target Region.
crossRegionCopyAction_encryptionConfiguration :: Lens' CrossRegionCopyAction EncryptionConfiguration Source #
The encryption settings for the copied snapshot.
CrossRegionCopyDeprecateRule
crossRegionCopyDeprecateRule_interval :: Lens' CrossRegionCopyDeprecateRule (Maybe Natural) Source #
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.
crossRegionCopyDeprecateRule_intervalUnit :: Lens' CrossRegionCopyDeprecateRule (Maybe RetentionIntervalUnitValues) Source #
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
.
CrossRegionCopyRetainRule
crossRegionCopyRetainRule_interval :: Lens' CrossRegionCopyRetainRule (Maybe Natural) Source #
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.
crossRegionCopyRetainRule_intervalUnit :: Lens' CrossRegionCopyRetainRule (Maybe RetentionIntervalUnitValues) Source #
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
.
CrossRegionCopyRule
crossRegionCopyRule_cmkArn :: Lens' CrossRegionCopyRule (Maybe Text) Source #
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.
crossRegionCopyRule_copyTags :: Lens' CrossRegionCopyRule (Maybe Bool) Source #
Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.
crossRegionCopyRule_deprecateRule :: Lens' CrossRegionCopyRule (Maybe CrossRegionCopyDeprecateRule) Source #
[AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
crossRegionCopyRule_retainRule :: Lens' CrossRegionCopyRule (Maybe CrossRegionCopyRetainRule) Source #
The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.
crossRegionCopyRule_target :: Lens' CrossRegionCopyRule (Maybe Text) Source #
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.
crossRegionCopyRule_targetRegion :: Lens' CrossRegionCopyRule (Maybe Text) Source #
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.
crossRegionCopyRule_encrypted :: Lens' CrossRegionCopyRule Bool Source #
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.
DeprecateRule
deprecateRule_count :: Lens' DeprecateRule (Maybe Natural) Source #
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.
deprecateRule_interval :: Lens' DeprecateRule (Maybe Natural) Source #
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.
deprecateRule_intervalUnit :: Lens' DeprecateRule (Maybe RetentionIntervalUnitValues) Source #
The unit of time in which to measure the Interval.
EncryptionConfiguration
encryptionConfiguration_cmkArn :: Lens' EncryptionConfiguration (Maybe Text) Source #
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.
encryptionConfiguration_encrypted :: Lens' EncryptionConfiguration Bool Source #
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
eventParameters_eventType :: Lens' EventParameters EventTypeValues Source #
The type of event. Currently, only snapshot sharing events are supported.
eventParameters_snapshotOwner :: Lens' EventParameters [Text] Source #
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.
eventParameters_descriptionRegex :: Lens' EventParameters Text Source #
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.
EventSource
eventSource_parameters :: Lens' EventSource (Maybe EventParameters) Source #
Information about the event.
eventSource_type :: Lens' EventSource EventSourceValues Source #
The source of the event. Currently only managed CloudWatch Events rules are supported.
FastRestoreRule
fastRestoreRule_count :: Lens' FastRestoreRule (Maybe Natural) Source #
The number of snapshots to be enabled with fast snapshot restore.
fastRestoreRule_interval :: Lens' FastRestoreRule (Maybe Natural) Source #
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.
fastRestoreRule_intervalUnit :: Lens' FastRestoreRule (Maybe RetentionIntervalUnitValues) Source #
The unit of time for enabling fast snapshot restore.
fastRestoreRule_availabilityZones :: Lens' FastRestoreRule (NonEmpty Text) Source #
The Availability Zones in which to enable fast snapshot restore.
LifecyclePolicy
lifecyclePolicy_dateCreated :: Lens' LifecyclePolicy (Maybe UTCTime) Source #
The local date and time when the lifecycle policy was created.
lifecyclePolicy_dateModified :: Lens' LifecyclePolicy (Maybe UTCTime) Source #
The local date and time when the lifecycle policy was last modified.
lifecyclePolicy_description :: Lens' LifecyclePolicy (Maybe Text) Source #
The description of the lifecycle policy.
lifecyclePolicy_executionRoleArn :: Lens' LifecyclePolicy (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
lifecyclePolicy_policyArn :: Lens' LifecyclePolicy (Maybe Text) Source #
The Amazon Resource Name (ARN) of the policy.
lifecyclePolicy_policyDetails :: Lens' LifecyclePolicy (Maybe PolicyDetails) Source #
The configuration of the lifecycle policy
lifecyclePolicy_policyId :: Lens' LifecyclePolicy (Maybe Text) Source #
The identifier of the lifecycle policy.
lifecyclePolicy_state :: Lens' LifecyclePolicy (Maybe GettablePolicyStateValues) Source #
The activation state of the lifecycle policy.
lifecyclePolicy_statusMessage :: Lens' LifecyclePolicy (Maybe Text) Source #
The description of the status.
lifecyclePolicy_tags :: Lens' LifecyclePolicy (Maybe (HashMap Text Text)) Source #
The tags.
LifecyclePolicySummary
lifecyclePolicySummary_description :: Lens' LifecyclePolicySummary (Maybe Text) Source #
The description of the lifecycle policy.
lifecyclePolicySummary_policyId :: Lens' LifecyclePolicySummary (Maybe Text) Source #
The identifier of the lifecycle policy.
lifecyclePolicySummary_policyType :: Lens' LifecyclePolicySummary (Maybe PolicyTypeValues) Source #
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.
lifecyclePolicySummary_state :: Lens' LifecyclePolicySummary (Maybe GettablePolicyStateValues) Source #
The activation state of the lifecycle policy.
lifecyclePolicySummary_tags :: Lens' LifecyclePolicySummary (Maybe (HashMap Text Text)) Source #
The tags.
Parameters
parameters_excludeBootVolume :: Lens' Parameters (Maybe Bool) Source #
[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.
parameters_excludeDataVolumeTags :: Lens' Parameters (Maybe [Tag]) Source #
[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.
parameters_noReboot :: Lens' Parameters (Maybe Bool) Source #
[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).
PolicyDetails
policyDetails_actions :: Lens' PolicyDetails (Maybe (NonEmpty Action)) Source #
[Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.
policyDetails_eventSource :: Lens' PolicyDetails (Maybe EventSource) Source #
[Event-based policies only] The event that activates the event-based policy.
policyDetails_parameters :: Lens' PolicyDetails (Maybe Parameters) Source #
[Snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.
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.
policyDetails_policyType :: Lens' PolicyDetails (Maybe PolicyTypeValues) Source #
[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
.
policyDetails_resourceLocations :: Lens' PolicyDetails (Maybe (NonEmpty ResourceLocationValues)) Source #
[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.
policyDetails_resourceTypes :: Lens' PolicyDetails (Maybe (NonEmpty ResourceTypeValues)) Source #
[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.
policyDetails_schedules :: Lens' PolicyDetails (Maybe (NonEmpty Schedule)) Source #
[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.
policyDetails_targetTags :: Lens' PolicyDetails (Maybe (NonEmpty Tag)) Source #
[Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
RetainRule
retainRule_count :: Lens' RetainRule (Maybe Natural) Source #
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.
retainRule_interval :: Lens' RetainRule (Maybe Natural) Source #
The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
retainRule_intervalUnit :: Lens' RetainRule (Maybe RetentionIntervalUnitValues) Source #
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.
RetentionArchiveTier
retentionArchiveTier_count :: Lens' RetentionArchiveTier (Maybe Natural) Source #
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.
retentionArchiveTier_interval :: Lens' RetentionArchiveTier (Maybe Natural) Source #
Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
retentionArchiveTier_intervalUnit :: Lens' RetentionArchiveTier (Maybe RetentionIntervalUnitValues) Source #
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
.
Schedule
schedule_archiveRule :: Lens' Schedule (Maybe ArchiveRule) Source #
[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.
schedule_copyTags :: Lens' Schedule (Maybe Bool) Source #
Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
schedule_createRule :: Lens' Schedule (Maybe CreateRule) Source #
The creation rule.
schedule_crossRegionCopyRules :: Lens' Schedule (Maybe [CrossRegionCopyRule]) Source #
Specifies a rule for copying snapshots or AMIs across regions.
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.
schedule_deprecateRule :: Lens' Schedule (Maybe DeprecateRule) Source #
[AMI policies only] The AMI deprecation rule for the schedule.
schedule_fastRestoreRule :: Lens' Schedule (Maybe FastRestoreRule) Source #
[Snapshot policies only] The rule for enabling fast snapshot restore.
schedule_retainRule :: Lens' Schedule (Maybe RetainRule) Source #
The retention rule for snapshots or AMIs created by the policy.
schedule_shareRules :: Lens' Schedule (Maybe [ShareRule]) Source #
[Snapshot policies only] The rule for sharing snapshots with other Amazon Web Services accounts.
schedule_tagsToAdd :: Lens' Schedule (Maybe [Tag]) Source #
The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
schedule_variableTags :: Lens' Schedule (Maybe [Tag]) Source #
[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.
ShareRule
shareRule_unshareInterval :: Lens' ShareRule (Maybe Natural) Source #
The period after which snapshots that are shared with other Amazon Web Services accounts are automatically unshared.
shareRule_unshareIntervalUnit :: Lens' ShareRule (Maybe RetentionIntervalUnitValues) Source #
The unit of time for the automatic unsharing interval.
shareRule_targetAccounts :: Lens' ShareRule (NonEmpty Text) Source #
The IDs of the Amazon Web Services accounts with which to share the snapshots.