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

Description

Synopsis

Documentation

data CreateRule Source #

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.

See: newCreateRule smart constructor.

Constructors

CreateRule'

Fields

location :: Maybe LocationValues
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.
interval :: Maybe Natural
The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
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.
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 DLM selects a time within the next 24 hours.
intervalUnit :: Maybe IntervalUnitValues
The interval unit.

Instances

Instances details

Eq CreateRule Source #
Instance details Defined in Amazonka.DLM.Types.CreateRule Methods (==) :: CreateRule -> CreateRule -> Bool # (/=) :: CreateRule -> CreateRule -> Bool #
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 #
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 #
NFData CreateRule Source #
Instance details Defined in Amazonka.DLM.Types.CreateRule Methods rnf :: CreateRule -> () #
Hashable CreateRule Source #
Instance details Defined in Amazonka.DLM.Types.CreateRule Methods hashWithSalt :: Int -> CreateRule -> Int # hash :: CreateRule -> Int #
ToJSON CreateRule Source #
Instance details Defined in Amazonka.DLM.Types.CreateRule Methods toJSON :: CreateRule -> Value # toEncoding :: CreateRule -> Encoding # toJSONList :: [CreateRule] -> Value # toEncodingList :: [CreateRule] -> Encoding #
FromJSON CreateRule Source #
Instance details Defined in Amazonka.DLM.Types.CreateRule Methods parseJSON :: Value -> Parser CreateRule # parseJSONList :: Value -> Parser [CreateRule] #
type Rep CreateRule Source #
Instance details Defined in Amazonka.DLM.Types.CreateRule type Rep CreateRule = D1 ('MetaData "CreateRule" "Amazonka.DLM.Types.CreateRule" "libZSservicesZSamazonka-dlmZSamazonka-dlm" 'False) (C1 ('MetaCons "CreateRule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LocationValues)) :: S1 ('MetaSel ('Just "interval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "cronExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "times") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "intervalUnit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IntervalUnitValues))))))

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:location:CreateRule', createRule_location - 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:interval:CreateRule', createRule_interval - The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.

$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: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 DLM selects a time within the next 24 hours.

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

createRule_location :: Lens' CreateRule (Maybe LocationValues) Source #

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

The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.

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_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 DLM selects a time within the next 24 hours.

createRule_intervalUnit :: Lens' CreateRule (Maybe IntervalUnitValues) Source #

The interval unit.