blib/lib/Paws/Backup/StartBackupJob.pm untested

filter: Statementstmt 0.0% 0 / 19 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 21 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Backup::StartBackupJob;
3 use Moose;
4 has BackupOptions => (is => 'ro', isa => 'Paws::Backup::BackupOptions');
5 has BackupVaultName => (is => 'ro', isa => 'Str', required => 1);
6 has CompleteWindowMinutes => (is => 'ro', isa => 'Int');
7 has IamRoleArn => (is => 'ro', isa => 'Str', required => 1);
8 has IdempotencyToken => (is => 'ro', isa => 'Str');
9 has Lifecycle => (is => 'ro', isa => 'Paws::Backup::Lifecycle');
10 has RecoveryPointTags => (is => 'ro', isa => 'Paws::Backup::Tags');
11 has ResourceArn => (is => 'ro', isa => 'Str', required => 1);
12 has StartWindowMinutes => (is => 'ro', isa => 'Int');
13  
14 use MooseX::ClassAttribute;
15  
16 class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartBackupJob');
17 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/backup-jobs');
18 class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
19 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Backup::StartBackupJobOutput');
20 1;
21  
22 ### main pod documentation begin ###
23  
24 =head1 NAME
25  
26 Paws::Backup::StartBackupJob - Arguments for method StartBackupJob on L<Paws::Backup>
27  
28 =head1 DESCRIPTION
29  
30 This class represents the parameters used for calling the method StartBackupJob on the
31 L<AWS Backup|Paws::Backup> service. Use the attributes of this class
32 as arguments to method StartBackupJob.
33  
34 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartBackupJob.
35  
36 =head1 SYNOPSIS
37  
38 my $backup = Paws->service('Backup');
39 my $StartBackupJobOutput = $backup->StartBackupJob(
40 BackupVaultName => 'MyBackupVaultName',
41 IamRoleArn => 'MyIAMRoleArn',
42 ResourceArn => 'MyARN',
43 BackupOptions => { 'MyBackupOptionKey' => 'MyBackupOptionValue', }
44 , # OPTIONAL
45 CompleteWindowMinutes => 1, # OPTIONAL
46 IdempotencyToken => 'Mystring', # OPTIONAL
47 Lifecycle => {
48 DeleteAfterDays => 1, # OPTIONAL
49 MoveToColdStorageAfterDays => 1, # OPTIONAL
50 }, # OPTIONAL
51 RecoveryPointTags => { 'MyTagKey' => 'MyTagValue', }, # OPTIONAL
52 StartWindowMinutes => 1, # OPTIONAL
53 );
54  
55 # Results:
56 my $BackupJobId = $StartBackupJobOutput->BackupJobId;
57 my $CreationDate = $StartBackupJobOutput->CreationDate;
58 my $RecoveryPointArn = $StartBackupJobOutput->RecoveryPointArn;
59  
60 # Returns a L<Paws::Backup::StartBackupJobOutput> object.
61  
62 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
63 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/backup/StartBackupJob>
64  
65 =head1 ATTRIBUTES
66  
67  
68 =head2 BackupOptions => L<Paws::Backup::BackupOptions>
69  
70 Specifies the backup option for a selected resource. This option is
71 only available for Windows VSS backup jobs.
72  
73 Valid values: Set to C<"WindowsVSSE<rdquo>:E<ldquo>enabled"> to enable
74 WindowsVSS backup option and create a VSS Windows backup. Set to
75 E<ldquo>WindowsVSSE<rdquo>:E<rdquo>disabledE<rdquo> to create a regular
76 backup. The WindowsVSS option is not enabled by default.
77  
78  
79  
80 =head2 B<REQUIRED> BackupVaultName => Str
81  
82 The name of a logical container where backups are stored. Backup vaults
83 are identified by names that are unique to the account used to create
84 them and the AWS Region where they are created. They consist of
85 lowercase letters, numbers, and hyphens.
86  
87  
88  
89 =head2 CompleteWindowMinutes => Int
90  
91 A value in minutes during which a successfully started backup must
92 complete, or else AWS Backup will cancel the job. This value is
93 optional. This value begins counting down from when the backup was
94 scheduled. It does not add additional time for C<StartWindowMinutes>,
95 or if the backup started later than scheduled.
96  
97  
98  
99 =head2 B<REQUIRED> IamRoleArn => Str
100  
101 Specifies the IAM role ARN used to create the target recovery point;
102 for example, C<arn:aws:iam::123456789012:role/S3Access>.
103  
104  
105  
106 =head2 IdempotencyToken => Str
107  
108 A customer chosen string that can be used to distinguish between calls
109 to C<StartBackupJob>.
110  
111  
112  
113 =head2 Lifecycle => L<Paws::Backup::Lifecycle>
114  
115 The lifecycle defines when a protected resource is transitioned to cold
116 storage and when it expires. AWS Backup will transition and expire
117 backups automatically according to the lifecycle that you define.
118  
119 Backups transitioned to cold storage must be stored in cold storage for
120 a minimum of 90 days. Therefore, the E<ldquo>expire after daysE<rdquo>
121 setting must be 90 days greater than the E<ldquo>transition to cold
122 after daysE<rdquo> setting. The E<ldquo>transition to cold after
123 daysE<rdquo> setting cannot be changed after a backup has been
124 transitioned to cold.
125  
126 Only Amazon EFS file system backups can be transitioned to cold
127 storage.
128  
129  
130  
131 =head2 RecoveryPointTags => L<Paws::Backup::Tags>
132  
133 To help organize your resources, you can assign your own metadata to
134 the resources that you create. Each tag is a key-value pair.
135  
136  
137  
138 =head2 B<REQUIRED> ResourceArn => Str
139  
140 An Amazon Resource Name (ARN) that uniquely identifies a resource. The
141 format of the ARN depends on the resource type.
142  
143  
144  
145 =head2 StartWindowMinutes => Int
146  
147 A value in minutes after a backup is scheduled before a job will be
148 canceled if it doesn't start successfully. This value is optional, and
149 the default is 8 hours.
150  
151  
152  
153  
154 =head1 SEE ALSO
155  
156 This class forms part of L<Paws>, documenting arguments for method StartBackupJob in L<Paws::Backup>
157  
158 =head1 BUGS and CONTRIBUTIONS
159  
160 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
161  
162 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
163  
164 =cut
165