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

Description

Synopsis

data PolicyDetails = PolicyDetails' {
- actions :: Maybe (NonEmpty Action)
- eventSource :: Maybe EventSource
- parameters :: Maybe Parameters
- policyType :: Maybe PolicyTypeValues
- resourceLocations :: Maybe (NonEmpty ResourceLocationValues)
- resourceTypes :: Maybe (NonEmpty ResourceTypeValues)
- schedules :: Maybe (NonEmpty Schedule)
- targetTags :: Maybe (NonEmpty Tag)
}
newPolicyDetails :: PolicyDetails
policyDetails_actions :: Lens' PolicyDetails (Maybe (NonEmpty Action))
policyDetails_eventSource :: Lens' PolicyDetails (Maybe EventSource)
policyDetails_parameters :: Lens' PolicyDetails (Maybe Parameters)
policyDetails_policyType :: Lens' PolicyDetails (Maybe PolicyTypeValues)
policyDetails_resourceLocations :: Lens' PolicyDetails (Maybe (NonEmpty ResourceLocationValues))
policyDetails_resourceTypes :: Lens' PolicyDetails (Maybe (NonEmpty ResourceTypeValues))
policyDetails_schedules :: Lens' PolicyDetails (Maybe (NonEmpty Schedule))
policyDetails_targetTags :: Lens' PolicyDetails (Maybe (NonEmpty Tag))

Documentation

data PolicyDetails Source #

[All policy types] Specifies the configuration of a lifecycle policy.

See: newPolicyDetails smart constructor.

Constructors

PolicyDetails'

Fields

actions :: Maybe (NonEmpty Action)
[Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.
eventSource :: Maybe EventSource
[Event-based policies only] The event that activates the event-based policy.
parameters :: Maybe Parameters
[Snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.
If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.
policyType :: Maybe PolicyTypeValues
[All policy types] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.
The default is EBS_SNAPSHOT_MANAGEMENT.
resourceLocations :: Maybe (NonEmpty ResourceLocationValues)
[Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.
If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.
resourceTypes :: Maybe (NonEmpty ResourceTypeValues)
[Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.
schedules :: Maybe (NonEmpty Schedule)
[Snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.
targetTags :: Maybe (NonEmpty Tag)
[Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

Instances

Instances details

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

newPolicyDetails :: PolicyDetails Source #

Create a value of PolicyDetails 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:actions:PolicyDetails', policyDetails_actions - [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.

$sel:eventSource:PolicyDetails', policyDetails_eventSource - [Event-based policies only] The event that activates the event-based policy.

PolicyDetails, policyDetails_parameters - [Snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

$sel:policyType:PolicyDetails', policyDetails_policyType - [All policy types] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

The default is EBS_SNAPSHOT_MANAGEMENT.

$sel:resourceLocations:PolicyDetails', policyDetails_resourceLocations - [Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

$sel:resourceTypes:PolicyDetails', policyDetails_resourceTypes - [Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

$sel:schedules:PolicyDetails', policyDetails_schedules - [Snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.

$sel:targetTags:PolicyDetails', policyDetails_targetTags - [Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

policyDetails_actions :: Lens' PolicyDetails (Maybe (NonEmpty Action)) Source #

[Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.

policyDetails_eventSource :: Lens' PolicyDetails (Maybe EventSource) Source #

[Event-based policies only] The event that activates the event-based policy.

policyDetails_parameters :: Lens' PolicyDetails (Maybe Parameters) Source #

[Snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

policyDetails_policyType :: Lens' PolicyDetails (Maybe PolicyTypeValues) Source #

[All policy types] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

The default is EBS_SNAPSHOT_MANAGEMENT.

policyDetails_resourceLocations :: Lens' PolicyDetails (Maybe (NonEmpty ResourceLocationValues)) Source #

[Snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

policyDetails_resourceTypes :: Lens' PolicyDetails (Maybe (NonEmpty ResourceTypeValues)) Source #

[Snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

policyDetails_schedules :: Lens' PolicyDetails (Maybe (NonEmpty Schedule)) Source #

[Snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.

policyDetails_targetTags :: Lens' PolicyDetails (Maybe (NonEmpty Tag)) Source #

[Snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.