| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DLM::PolicyDetails; | ||
| 3 | use Moose; | ||
| 4 | has Actions => (is => 'ro', isa => 'ArrayRef[Paws::DLM::Action]'); | ||
| 5 | has EventSource => (is => 'ro', isa => 'Paws::DLM::EventSource'); | ||
| 6 | has Parameters => (is => 'ro', isa => 'Paws::DLM::Parameters'); | ||
| 7 | has PolicyType => (is => 'ro', isa => 'Str'); | ||
| 8 | has ResourceLocations => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 9 | has ResourceTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 10 | has Schedules => (is => 'ro', isa => 'ArrayRef[Paws::DLM::Schedule]'); | ||
| 11 | has TargetTags => (is => 'ro', isa => 'ArrayRef[Paws::DLM::Tag]'); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::DLM::PolicyDetails | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::DLM::PolicyDetails object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { Actions => $value, ..., TargetTags => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::DLM::PolicyDetails object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->Actions | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Specifies the configuration of a lifecycle policy. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 Actions => ArrayRef[L<Paws::DLM::Action>] | ||
| 49 | |||
| 50 | The actions to be performed when the event-based policy is triggered. | ||
| 51 | You can specify only one action per policy. | ||
| 52 | |||
| 53 | This parameter is required for event-based policies only. If you are | ||
| 54 | creating a snapshot or AMI policy, omit this parameter. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 EventSource => L<Paws::DLM::EventSource> | ||
| 58 | |||
| 59 | The event that triggers the event-based policy. | ||
| 60 | |||
| 61 | This parameter is required for event-based policies only. If you are | ||
| 62 | creating a snapshot or AMI policy, omit this parameter. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 Parameters => L<Paws::DLM::Parameters> | ||
| 66 | |||
| 67 | A set of optional parameters for snapshot and AMI lifecycle policies. | ||
| 68 | |||
| 69 | This parameter is required for snapshot and AMI policies only. If you | ||
| 70 | are creating an event-based policy, omit this parameter. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 PolicyType => Str | ||
| 74 | |||
| 75 | The valid target resource types and actions a policy can manage. | ||
| 76 | Specify C<EBS_SNAPSHOT_MANAGEMENT> to create a lifecycle policy that | ||
| 77 | manages the lifecycle of Amazon EBS snapshots. Specify | ||
| 78 | C<IMAGE_MANAGEMENT> to create a lifecycle policy that manages the | ||
| 79 | lifecycle of EBS-backed AMIs. Specify C<EVENT_BASED_POLICY > to create | ||
| 80 | an event-based policy that performs specific actions when a defined | ||
| 81 | event occurs in your AWS account. | ||
| 82 | |||
| 83 | The default is C<EBS_SNAPSHOT_MANAGEMENT>. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 ResourceLocations => ArrayRef[Str|Undef] | ||
| 87 | |||
| 88 | The location of the resources to backup. If the source resources are | ||
| 89 | located in an AWS Region, specify C<CLOUD>. If the source resources are | ||
| 90 | located on an AWS Outpost in your account, specify C<OUTPOST>. | ||
| 91 | |||
| 92 | If you specify C<OUTPOST>, Amazon Data Lifecycle Manager backs up all | ||
| 93 | resources of the specified type with matching target tags across all of | ||
| 94 | the Outposts in your account. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 ResourceTypes => ArrayRef[Str|Undef] | ||
| 98 | |||
| 99 | The target resource type for snapshot and AMI lifecycle policies. Use | ||
| 100 | C<VOLUME >to create snapshots of individual volumes or use C<INSTANCE> | ||
| 101 | to create multi-volume snapshots from the volumes for an instance. | ||
| 102 | |||
| 103 | This parameter is required for snapshot and AMI policies only. If you | ||
| 104 | are creating an event-based policy, omit this parameter. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 Schedules => ArrayRef[L<Paws::DLM::Schedule>] | ||
| 108 | |||
| 109 | The schedules of policy-defined actions for snapshot and AMI lifecycle | ||
| 110 | policies. A policy can have up to four schedulesE<mdash>one mandatory | ||
| 111 | schedule and up to three optional schedules. | ||
| 112 | |||
| 113 | This parameter is required for snapshot and AMI policies only. If you | ||
| 114 | are creating an event-based policy, omit this parameter. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 TargetTags => ArrayRef[L<Paws::DLM::Tag>] | ||
| 118 | |||
| 119 | The single tag that identifies targeted resources for this policy. | ||
| 120 | |||
| 121 | This parameter is required for snapshot and AMI policies only. If you | ||
| 122 | are creating an event-based policy, omit this parameter. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head1 SEE ALSO | ||
| 127 | |||
| 128 | This class forms part of L<Paws>, describing an object used in L<Paws::DLM> | ||
| 129 | |||
| 130 | =head1 BUGS and CONTRIBUTIONS | ||
| 131 | |||
| 132 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 133 | |||
| 134 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 135 | |||
| 136 | =cut | ||
| 137 |