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

Description

Synopsis

data Parameters = Parameters' {
- excludeBootVolume :: Maybe Bool
- excludeDataVolumeTags :: Maybe [Tag]
- noReboot :: Maybe Bool
}
newParameters :: Parameters
parameters_excludeBootVolume :: Lens' Parameters (Maybe Bool)
parameters_excludeDataVolumeTags :: Lens' Parameters (Maybe [Tag])
parameters_noReboot :: Lens' Parameters (Maybe Bool)

Documentation

data Parameters Source #

[Snapshot and AMI policies only] Specifies optional parameters for snapshot and AMI policies. The set of valid parameters depends on the combination of policy type and target resource type.

If you choose to exclude boot volumes and you specify tags that consequently exclude all of the additional data volumes attached to an instance, then Amazon Data Lifecycle Manager will not create any snapshots for the affected instance, and it will emit a SnapshotsCreateFailed Amazon CloudWatch metric. For more information, see Monitor your policies using Amazon CloudWatch.

See: newParameters smart constructor.

Constructors

Parameters'

Fields

excludeBootVolume :: Maybe Bool
[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.
excludeDataVolumeTags :: Maybe [Tag]
[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.
noReboot :: Maybe Bool
[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).

Instances

Instances details

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

newParameters :: Parameters Source #

Create a value of Parameters 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:excludeBootVolume:Parameters', parameters_excludeBootVolume - [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.

$sel:excludeDataVolumeTags:Parameters', parameters_excludeDataVolumeTags - [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.

$sel:noReboot:Parameters', parameters_noReboot - [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).

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