« blib/lib/Paws/DLM/CreateLifecyclePolicyResponse.pm
↑ Summary
blib/lib/Paws/DLM/CrossRegionCopyAction.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DLM::CreateRule; | ||
| 3 | use Moose; | ||
| 4 | has CronExpression => (is => 'ro', isa => 'Str'); | ||
| 5 | has Interval => (is => 'ro', isa => 'Int'); | ||
| 6 | has IntervalUnit => (is => 'ro', isa => 'Str'); | ||
| 7 | has Location => (is => 'ro', isa => 'Str'); | ||
| 8 | has Times => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::DLM::CreateRule | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::DLM::CreateRule object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { CronExpression => $value, ..., Times => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::DLM::CreateRule object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->CronExpression | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Specifies when to create snapshots of EBS volumes. | ||
| 41 | |||
| 42 | You must specify either a Cron expression or an interval, interval | ||
| 43 | unit, and start time. You cannot specify both. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 CronExpression => Str | ||
| 49 | |||
| 50 | The schedule, as a Cron expression. The schedule interval must be | ||
| 51 | between 1 hour and 1 year. For more information, see Cron expressions | ||
| 52 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions) | ||
| 53 | in the I<Amazon CloudWatch User Guide>. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 Interval => Int | ||
| 57 | |||
| 58 | The interval between snapshots. The supported values are 1, 2, 3, 4, 6, | ||
| 59 | 8, 12, and 24. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 IntervalUnit => Str | ||
| 63 | |||
| 64 | The interval unit. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 Location => Str | ||
| 68 | |||
| 69 | Specifies the destination for snapshots created by the policy. To | ||
| 70 | create snapshots in the same Region as the source resource, specify | ||
| 71 | C<CLOUD>. To create snapshots on the same Outpost as the source | ||
| 72 | resource, specify C<OUTPOST_LOCAL>. If you omit this parameter, | ||
| 73 | C<CLOUD> is used by default. | ||
| 74 | |||
| 75 | If the policy targets resources in an AWS Region, then you must create | ||
| 76 | snapshots in the same Region as the source resource. | ||
| 77 | |||
| 78 | If the policy targets resources on an Outpost, then you can create | ||
| 79 | snapshots on the same Outpost as the source resource, or in the Region | ||
| 80 | of that Outpost. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 Times => ArrayRef[Str|Undef] | ||
| 84 | |||
| 85 | The time, in UTC, to start the operation. The supported format is | ||
| 86 | hh:mm. | ||
| 87 | |||
| 88 | The operation occurs within a one-hour window following the specified | ||
| 89 | time. If you do not specify a time, Amazon DLM selects a time within | ||
| 90 | the next 24 hours. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head1 SEE ALSO | ||
| 95 | |||
| 96 | This class forms part of L<Paws>, describing an object used in L<Paws::DLM> | ||
| 97 | |||
| 98 | =head1 BUGS and CONTRIBUTIONS | ||
| 99 | |||
| 100 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 101 | |||
| 102 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 103 | |||
| 104 | =cut | ||
| 105 |