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

Amazonka.DLM.Types.Schedule

Description

Synopsis

data Schedule = Schedule' {
- archiveRule :: Maybe ArchiveRule
- copyTags :: Maybe Bool
- createRule :: Maybe CreateRule
- crossRegionCopyRules :: Maybe [CrossRegionCopyRule]
- deprecateRule :: Maybe DeprecateRule
- fastRestoreRule :: Maybe FastRestoreRule
- name :: Maybe Text
- retainRule :: Maybe RetainRule
- shareRules :: Maybe [ShareRule]
- tagsToAdd :: Maybe [Tag]
- variableTags :: Maybe [Tag]
}
newSchedule :: Schedule
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])

Documentation

data Schedule Source #

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

See: newSchedule smart constructor.

Constructors

Schedule'

Fields

archiveRule :: Maybe ArchiveRule
[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.
copyTags :: Maybe Bool
Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
createRule :: Maybe CreateRule
The creation rule.
crossRegionCopyRules :: Maybe [CrossRegionCopyRule]
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.
deprecateRule :: Maybe DeprecateRule
[AMI policies only] The AMI deprecation rule for the schedule.
fastRestoreRule :: Maybe FastRestoreRule
[Snapshot policies only] The rule for enabling fast snapshot restore.
name :: Maybe Text
The name of the schedule.
retainRule :: Maybe RetainRule
The retention rule for snapshots or AMIs created by the policy.
shareRules :: Maybe [ShareRule]
[Snapshot policies only] The rule for sharing snapshots with other Amazon Web Services accounts.
tagsToAdd :: Maybe [Tag]
The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
variableTags :: Maybe [Tag]
[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.

Instances

Instances details

FromJSON Schedule Source #
Instance details Defined in Amazonka.DLM.Types.Schedule Methods parseJSON :: Value -> Parser Schedule # parseJSONList :: Value -> Parser [Schedule] #
ToJSON Schedule Source #
Instance details Defined in Amazonka.DLM.Types.Schedule Methods toJSON :: Schedule -> Value # toEncoding :: Schedule -> Encoding # toJSONList :: [Schedule] -> Value # toEncodingList :: [Schedule] -> Encoding #
Generic Schedule Source #
Instance details Defined in Amazonka.DLM.Types.Schedule Associated Types type Rep Schedule :: Type -> Type # Methods from :: Schedule -> Rep Schedule x # to :: Rep Schedule x -> Schedule #
Read Schedule Source #
Instance details Defined in Amazonka.DLM.Types.Schedule Methods readsPrec :: Int -> ReadS Schedule # readList :: ReadS [Schedule] # readPrec :: ReadPrec Schedule # readListPrec :: ReadPrec [Schedule] #
Show Schedule Source #
Instance details Defined in Amazonka.DLM.Types.Schedule Methods showsPrec :: Int -> Schedule -> ShowS # show :: Schedule -> String # showList :: [Schedule] -> ShowS #
NFData Schedule Source #
Instance details Defined in Amazonka.DLM.Types.Schedule Methods rnf :: Schedule -> () #
Eq Schedule Source #
Instance details Defined in Amazonka.DLM.Types.Schedule Methods (==) :: Schedule -> Schedule -> Bool # (/=) :: Schedule -> Schedule -> Bool #
Hashable Schedule Source #
Instance details Defined in Amazonka.DLM.Types.Schedule Methods hashWithSalt :: Int -> Schedule -> Int # hash :: Schedule -> Int #
type Rep Schedule Source #
Instance details Defined in Amazonka.DLM.Types.Schedule type Rep Schedule = D1 ('MetaData "Schedule" "Amazonka.DLM.Types.Schedule" "amazonka-dlm-2.0-KlPkRzsIoa0q62N0Ereji" 'False) (C1 ('MetaCons "Schedule'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "archiveRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ArchiveRule)) :: S1 ('MetaSel ('Just "copyTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "createRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateRule)) :: (S1 ('MetaSel ('Just "crossRegionCopyRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CrossRegionCopyRule])) :: S1 ('MetaSel ('Just "deprecateRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeprecateRule))))) :: ((S1 ('MetaSel ('Just "fastRestoreRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FastRestoreRule)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "retainRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetainRule)))) :: (S1 ('MetaSel ('Just "shareRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ShareRule])) :: (S1 ('MetaSel ('Just "tagsToAdd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "variableTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))))))

newSchedule :: Schedule Source #

Create a value of Schedule with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:archiveRule:Schedule', schedule_archiveRule - [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, schedule_copyTags - Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.

$sel:createRule:Schedule', schedule_createRule - The creation rule.

$sel:crossRegionCopyRules:Schedule', schedule_crossRegionCopyRules - 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, schedule_deprecateRule - [AMI policies only] The AMI deprecation rule for the schedule.

$sel:fastRestoreRule:Schedule', schedule_fastRestoreRule - [Snapshot policies only] The rule for enabling fast snapshot restore.

$sel:name:Schedule', schedule_name - The name of the schedule.

Schedule, schedule_retainRule - The retention rule for snapshots or AMIs created by the policy.

$sel:shareRules:Schedule', schedule_shareRules - [Snapshot policies only] The rule for sharing snapshots with other Amazon Web Services accounts.

$sel:tagsToAdd:Schedule', schedule_tagsToAdd - The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.

$sel:variableTags:Schedule', schedule_variableTags - [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.

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_name :: Lens' Schedule (Maybe Text) Source #

The name of the schedule.

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.