| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Backup::BackupRule; | ||
| 3 | use Moose; | ||
| 4 | has CompletionWindowMinutes => (is => 'ro', isa => 'Int'); | ||
| 5 | has CopyActions => (is => 'ro', isa => 'ArrayRef[Paws::Backup::CopyAction]'); | ||
| 6 | has EnableContinuousBackup => (is => 'ro', isa => 'Bool'); | ||
| 7 | has Lifecycle => (is => 'ro', isa => 'Paws::Backup::Lifecycle'); | ||
| 8 | has RecoveryPointTags => (is => 'ro', isa => 'Paws::Backup::Tags'); | ||
| 9 | has RuleId => (is => 'ro', isa => 'Str'); | ||
| 10 | has RuleName => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has ScheduleExpression => (is => 'ro', isa => 'Str'); | ||
| 12 | has StartWindowMinutes => (is => 'ro', isa => 'Int'); | ||
| 13 | has TargetBackupVaultName => (is => 'ro', isa => 'Str', required => 1); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Backup::BackupRule | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::Backup::BackupRule object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { CompletionWindowMinutes => $value, ..., TargetBackupVaultName => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::Backup::BackupRule object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->CompletionWindowMinutes | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | Specifies a scheduled task used to back up a selection of resources. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 CompletionWindowMinutes => Int | ||
| 51 | |||
| 52 | A value in minutes after a backup job is successfully started before it | ||
| 53 | must be completed or it will be canceled by AWS Backup. This value is | ||
| 54 | optional. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 CopyActions => ArrayRef[L<Paws::Backup::CopyAction>] | ||
| 58 | |||
| 59 | An array of C<CopyAction> objects, which contains the details of the | ||
| 60 | copy operation. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 EnableContinuousBackup => Bool | ||
| 64 | |||
| 65 | Specifies whether AWS Backup creates continuous backups. True causes | ||
| 66 | AWS Backup to create continuous backups capable of point-in-time | ||
| 67 | restore (PITR). False (or not specified) causes AWS Backup to create | ||
| 68 | snapshot backups. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 Lifecycle => L<Paws::Backup::Lifecycle> | ||
| 72 | |||
| 73 | The lifecycle defines when a protected resource is transitioned to cold | ||
| 74 | storage and when it expires. AWS Backup transitions and expires backups | ||
| 75 | automatically according to the lifecycle that you define. | ||
| 76 | |||
| 77 | Backups transitioned to cold storage must be stored in cold storage for | ||
| 78 | a minimum of 90 days. Therefore, the E<ldquo>expire after daysE<rdquo> | ||
| 79 | setting must be 90 days greater than the E<ldquo>transition to cold | ||
| 80 | after daysE<rdquo> setting. The E<ldquo>transition to cold after | ||
| 81 | daysE<rdquo> setting cannot be changed after a backup has been | ||
| 82 | transitioned to cold. | ||
| 83 | |||
| 84 | Only Amazon EFS file system backups can be transitioned to cold | ||
| 85 | storage. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 RecoveryPointTags => L<Paws::Backup::Tags> | ||
| 89 | |||
| 90 | An array of key-value pair strings that are assigned to resources that | ||
| 91 | are associated with this rule when restored from backup. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 RuleId => Str | ||
| 95 | |||
| 96 | Uniquely identifies a rule that is used to schedule the backup of a | ||
| 97 | selection of resources. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 B<REQUIRED> RuleName => Str | ||
| 101 | |||
| 102 | An optional display name for a backup rule. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 ScheduleExpression => Str | ||
| 106 | |||
| 107 | A CRON expression specifying when AWS Backup initiates a backup job. | ||
| 108 | For more information about cron expressions, see Schedule Expressions | ||
| 109 | for Rules | ||
| 110 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html) | ||
| 111 | in the I<Amazon CloudWatch Events User Guide.>. Prior to specifying a | ||
| 112 | value for this parameter, we recommend testing your cron expression | ||
| 113 | using one of the many available cron generator and testing tools. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 StartWindowMinutes => Int | ||
| 117 | |||
| 118 | A value in minutes after a backup is scheduled before a job will be | ||
| 119 | canceled if it doesn't start successfully. This value is optional. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 B<REQUIRED> TargetBackupVaultName => Str | ||
| 123 | |||
| 124 | The name of a logical container where backups are stored. Backup vaults | ||
| 125 | are identified by names that are unique to the account used to create | ||
| 126 | them and the AWS Region where they are created. They consist of | ||
| 127 | lowercase letters, numbers, and hyphens. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head1 SEE ALSO | ||
| 132 | |||
| 133 | This class forms part of L<Paws>, describing an object used in L<Paws::Backup> | ||
| 134 | |||
| 135 | =head1 BUGS and CONTRIBUTIONS | ||
| 136 | |||
| 137 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 138 | |||
| 139 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 140 | |||
| 141 | =cut | ||
| 142 |