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

Description

Synopsis

Documentation

data CreateRule Source #

[Snapshot and AMI policies only] Specifies when the policy should create snapshots or AMIs.

You must specify either CronExpression, or Interval, IntervalUnit, and Times.
If you need to specify an ArchiveRule for the schedule, then you must specify a creation frequency of at least 28 days.

See: newCreateRule smart constructor.

Constructors

CreateRule'

Fields

cronExpression :: Maybe Text
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 :: Maybe Natural
The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
intervalUnit :: Maybe IntervalUnitValues
The interval unit.
location :: Maybe LocationValues
[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.
times :: Maybe [Text]
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.

Instances

Instances details

FromJSON CreateRule Source #
Instance details Defined in Amazonka.DLM.Types.CreateRule Methods parseJSON :: Value -> Parser CreateRule # parseJSONList :: Value -> Parser [CreateRule] #
ToJSON CreateRule Source #
Instance details Defined in Amazonka.DLM.Types.CreateRule Methods toJSON :: CreateRule -> Value # toEncoding :: CreateRule -> Encoding # toJSONList :: [CreateRule] -> Value # toEncodingList :: [CreateRule] -> Encoding #
Generic CreateRule Source #
Instance details Defined in Amazonka.DLM.Types.CreateRule Associated Types type Rep CreateRule :: Type -> Type # Methods from :: CreateRule -> Rep CreateRule x # to :: Rep CreateRule x -> CreateRule #
Read CreateRule Source #
Instance details Defined in Amazonka.DLM.Types.CreateRule Methods readsPrec :: Int -> ReadS CreateRule # readList :: ReadS [CreateRule] # readPrec :: ReadPrec CreateRule # readListPrec :: ReadPrec [CreateRule] #
Show CreateRule Source #
Instance details Defined in Amazonka.DLM.Types.CreateRule Methods showsPrec :: Int -> CreateRule -> ShowS # show :: CreateRule -> String # showList :: [CreateRule] -> ShowS #
NFData CreateRule Source #
Instance details Defined in Amazonka.DLM.Types.CreateRule Methods rnf :: CreateRule -> () #
Eq CreateRule Source #
Instance details Defined in Amazonka.DLM.Types.CreateRule Methods (==) :: CreateRule -> CreateRule -> Bool # (/=) :: CreateRule -> CreateRule -> Bool #
Hashable CreateRule Source #
Instance details Defined in Amazonka.DLM.Types.CreateRule Methods hashWithSalt :: Int -> CreateRule -> Int # hash :: CreateRule -> Int #
type Rep CreateRule Source #
Instance details Defined in Amazonka.DLM.Types.CreateRule type Rep CreateRule = D1 ('MetaData "CreateRule" "Amazonka.DLM.Types.CreateRule" "amazonka-dlm-2.0-KlPkRzsIoa0q62N0Ereji" 'False) (C1 ('MetaCons "CreateRule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cronExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "interval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "intervalUnit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IntervalUnitValues)) :: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LocationValues)) :: S1 ('MetaSel ('Just "times") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newCreateRule :: CreateRule Source #

Create a value of CreateRule 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:cronExpression:CreateRule', createRule_cronExpression - 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.

$sel:interval:CreateRule', createRule_interval - The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.

$sel:intervalUnit:CreateRule', createRule_intervalUnit - The interval unit.

$sel:location:CreateRule', createRule_location - [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.

$sel:times:CreateRule', createRule_times - 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.

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.