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