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

Description

Synopsis

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

Documentation

data PolicyDetails Source #

Specifies the configuration of a lifecycle policy.

See: newPolicyDetails smart constructor.

Constructors

PolicyDetails'

Fields

actions :: Maybe (NonEmpty Action)
The actions to be performed when the event-based policy is triggered. You can specify only one action per policy.
This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
targetTags :: Maybe (NonEmpty Tag)
The single tag that identifies targeted resources for this policy.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
policyType :: Maybe PolicyTypeValues
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)
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.
parameters :: Maybe Parameters
A set of optional parameters for snapshot and AMI lifecycle policies.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
schedules :: Maybe (NonEmpty Schedule)
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.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
eventSource :: Maybe EventSource
The event that triggers the event-based policy.
This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
resourceTypes :: Maybe (NonEmpty ResourceTypeValues)
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.
This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

Instances

Instances details

Eq PolicyDetails Source #
Instance details Defined in Amazonka.DLM.Types.PolicyDetails Methods (==) :: PolicyDetails -> PolicyDetails -> Bool # (/=) :: PolicyDetails -> PolicyDetails -> Bool #
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 #
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 #
NFData PolicyDetails Source #
Instance details Defined in Amazonka.DLM.Types.PolicyDetails Methods rnf :: PolicyDetails -> () #
Hashable PolicyDetails Source #
Instance details Defined in Amazonka.DLM.Types.PolicyDetails Methods hashWithSalt :: Int -> PolicyDetails -> Int # hash :: PolicyDetails -> Int #
ToJSON PolicyDetails Source #
Instance details Defined in Amazonka.DLM.Types.PolicyDetails Methods toJSON :: PolicyDetails -> Value # toEncoding :: PolicyDetails -> Encoding # toJSONList :: [PolicyDetails] -> Value # toEncodingList :: [PolicyDetails] -> Encoding #
FromJSON PolicyDetails Source #
Instance details Defined in Amazonka.DLM.Types.PolicyDetails Methods parseJSON :: Value -> Parser PolicyDetails # parseJSONList :: Value -> Parser [PolicyDetails] #
type Rep PolicyDetails Source #
Instance details Defined in Amazonka.DLM.Types.PolicyDetails type Rep PolicyDetails = D1 ('MetaData "PolicyDetails" "Amazonka.DLM.Types.PolicyDetails" "libZSservicesZSamazonka-dlmZSamazonka-dlm" 'False) (C1 ('MetaCons "PolicyDetails'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "actions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Action))) :: S1 ('MetaSel ('Just "targetTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))) :: (S1 ('MetaSel ('Just "policyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PolicyTypeValues)) :: S1 ('MetaSel ('Just "resourceLocations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ResourceLocationValues))))) :: ((S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Parameters)) :: S1 ('MetaSel ('Just "schedules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Schedule)))) :: (S1 ('MetaSel ('Just "eventSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSource)) :*: S1 ('MetaSel ('Just "resourceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ResourceTypeValues)))))))

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 - The actions to be performed when the event-based policy is triggered. You can specify only one action per policy.

This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.

$sel:targetTags:PolicyDetails', policyDetails_targetTags - The single tag that identifies targeted resources for this policy.

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

$sel:policyType:PolicyDetails', policyDetails_policyType - 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 - 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:parameters:PolicyDetails', policyDetails_parameters - A set of optional parameters for snapshot and AMI lifecycle policies.

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

$sel:schedules:PolicyDetails', policyDetails_schedules - 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.

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

$sel:eventSource:PolicyDetails', policyDetails_eventSource - The event that triggers the event-based policy.

This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.

$sel:resourceTypes:PolicyDetails', policyDetails_resourceTypes - 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.

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

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

The actions to be performed when the event-based policy is triggered. You can specify only one action per policy.

This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.

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

The single tag that identifies targeted resources for this policy.

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

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

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 #

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_parameters :: Lens' PolicyDetails (Maybe Parameters) Source #

A set of optional parameters for snapshot and AMI lifecycle policies.

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

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

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.

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.

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

The event that triggers the event-based policy.

This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.

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

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.

This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.