Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DLM.Types.Schedule

Description

Synopsis

data Schedule = Schedule' {
- variableTags :: Maybe [Tag]
- createRule :: Maybe CreateRule
- deprecateRule :: Maybe DeprecateRule
- copyTags :: Maybe Bool
- name :: Maybe Text
- shareRules :: Maybe [ShareRule]
- tagsToAdd :: Maybe [Tag]
- retainRule :: Maybe RetainRule
- crossRegionCopyRules :: Maybe [CrossRegionCopyRule]
- fastRestoreRule :: Maybe FastRestoreRule
}
newSchedule :: Schedule
schedule_variableTags :: Lens' Schedule (Maybe [Tag])
schedule_createRule :: Lens' Schedule (Maybe CreateRule)
schedule_deprecateRule :: Lens' Schedule (Maybe DeprecateRule)
schedule_copyTags :: Lens' Schedule (Maybe Bool)
schedule_name :: Lens' Schedule (Maybe Text)
schedule_shareRules :: Lens' Schedule (Maybe [ShareRule])
schedule_tagsToAdd :: Lens' Schedule (Maybe [Tag])
schedule_retainRule :: Lens' Schedule (Maybe RetainRule)
schedule_crossRegionCopyRules :: Lens' Schedule (Maybe [CrossRegionCopyRule])
schedule_fastRestoreRule :: Lens' Schedule (Maybe FastRestoreRule)

Documentation

data Schedule Source #

Specifies a backup schedule for a snapshot or AMI lifecycle policy.

See: newSchedule smart constructor.

Constructors

Schedule'

Fields

variableTags :: Maybe [Tag]
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.
createRule :: Maybe CreateRule
The creation rule.
deprecateRule :: Maybe DeprecateRule
The AMI deprecation rule for the schedule.
copyTags :: Maybe Bool
Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
name :: Maybe Text
The name of the schedule.
shareRules :: Maybe [ShareRule]
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.
retainRule :: Maybe RetainRule
The retention rule.
crossRegionCopyRules :: Maybe [CrossRegionCopyRule]
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 :: Maybe FastRestoreRule
The rule for enabling fast snapshot restore.

Instances

Instances details

Eq Schedule Source #
Instance details Defined in Amazonka.DLM.Types.Schedule Methods (==) :: Schedule -> Schedule -> Bool # (/=) :: Schedule -> Schedule -> Bool #
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 #
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 #
NFData Schedule Source #
Instance details Defined in Amazonka.DLM.Types.Schedule Methods rnf :: Schedule -> () #
Hashable Schedule Source #
Instance details Defined in Amazonka.DLM.Types.Schedule Methods hashWithSalt :: Int -> Schedule -> Int # hash :: Schedule -> Int #
ToJSON Schedule Source #
Instance details Defined in Amazonka.DLM.Types.Schedule Methods toJSON :: Schedule -> Value # toEncoding :: Schedule -> Encoding # toJSONList :: [Schedule] -> Value # toEncodingList :: [Schedule] -> Encoding #
FromJSON Schedule Source #
Instance details Defined in Amazonka.DLM.Types.Schedule Methods parseJSON :: Value -> Parser Schedule # parseJSONList :: Value -> Parser [Schedule] #
type Rep Schedule Source #
Instance details Defined in Amazonka.DLM.Types.Schedule type Rep Schedule = D1 ('MetaData "Schedule" "Amazonka.DLM.Types.Schedule" "libZSservicesZSamazonka-dlmZSamazonka-dlm" 'False) (C1 ('MetaCons "Schedule'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "variableTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "createRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateRule))) :: (S1 ('MetaSel ('Just "deprecateRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeprecateRule)) :: (S1 ('MetaSel ('Just "copyTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "shareRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ShareRule])) :: S1 ('MetaSel ('Just "tagsToAdd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "retainRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetainRule)) :: (S1 ('MetaSel ('Just "crossRegionCopyRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CrossRegionCopyRule])) :*: S1 ('MetaSel ('Just "fastRestoreRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FastRestoreRule)))))))

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

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

$sel:deprecateRule:Schedule', schedule_deprecateRule - The AMI deprecation rule for the schedule.

$sel:copyTags:Schedule', schedule_copyTags - Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.

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

$sel:shareRules:Schedule', schedule_shareRules - 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:retainRule:Schedule', schedule_retainRule - The retention rule.

$sel:crossRegionCopyRules:Schedule', schedule_crossRegionCopyRules - 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.

$sel:fastRestoreRule:Schedule', schedule_fastRestoreRule - The rule for enabling fast snapshot restore.

schedule_variableTags :: Lens' Schedule (Maybe [Tag]) Source #

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

The creation rule.

schedule_deprecateRule :: Lens' Schedule (Maybe DeprecateRule) Source #

The AMI deprecation rule for the schedule.

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

The name of the schedule.

schedule_shareRules :: Lens' Schedule (Maybe [ShareRule]) Source #

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

The retention rule.

schedule_crossRegionCopyRules :: Lens' Schedule (Maybe [CrossRegionCopyRule]) Source #

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.

schedule_fastRestoreRule :: Lens' Schedule (Maybe FastRestoreRule) Source #

The rule for enabling fast snapshot restore.