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

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 17 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Backup::StartRestoreJob;
3 use Moose;
4 has IamRoleArn => (is => 'ro', isa => 'Str', required => 1);
5 has IdempotencyToken => (is => 'ro', isa => 'Str');
6 has Metadata => (is => 'ro', isa => 'Paws::Backup::Metadata', required => 1);
7 has RecoveryPointArn => (is => 'ro', isa => 'Str', required => 1);
8 has ResourceType => (is => 'ro', isa => 'Str');
9  
10 use MooseX::ClassAttribute;
11  
12 class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartRestoreJob');
13 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restore-jobs');
14 class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
15 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Backup::StartRestoreJobOutput');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::Backup::StartRestoreJob - Arguments for method StartRestoreJob on L<Paws::Backup>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method StartRestoreJob on the
27 L<AWS Backup|Paws::Backup> service. Use the attributes of this class
28 as arguments to method StartRestoreJob.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartRestoreJob.
31  
32 =head1 SYNOPSIS
33  
34 my $backup = Paws->service('Backup');
35 my $StartRestoreJobOutput = $backup->StartRestoreJob(
36 IamRoleArn => 'MyIAMRoleArn',
37 Metadata => { 'MyMetadataKey' => 'MyMetadataValue', },
38 RecoveryPointArn => 'MyARN',
39 IdempotencyToken => 'Mystring', # OPTIONAL
40 ResourceType => 'MyResourceType', # OPTIONAL
41 );
42  
43 # Results:
44 my $RestoreJobId = $StartRestoreJobOutput->RestoreJobId;
45  
46 # Returns a L<Paws::Backup::StartRestoreJobOutput> object.
47  
48 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.
49 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/backup/StartRestoreJob>
50  
51 =head1 ATTRIBUTES
52  
53  
54 =head2 B<REQUIRED> IamRoleArn => Str
55  
56 The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to
57 create the target recovery point; for example,
58 C<arn:aws:iam::123456789012:role/S3Access>.
59  
60  
61  
62 =head2 IdempotencyToken => Str
63  
64 A customer chosen string that can be used to distinguish between calls
65 to C<StartRestoreJob>.
66  
67  
68  
69 =head2 B<REQUIRED> Metadata => L<Paws::Backup::Metadata>
70  
71 A set of metadata key-value pairs. Contains information, such as a
72 resource name, required to restore a recovery point.
73  
74 You can get configuration metadata about a resource at the time it was
75 backed up by calling C<GetRecoveryPointRestoreMetadata>. However,
76 values in addition to those provided by
77 C<GetRecoveryPointRestoreMetadata> might be required to restore a
78 resource. For example, you might need to provide a new resource name if
79 the original already exists.
80  
81 You need to specify specific metadata to restore an Amazon Elastic File
82 System (Amazon EFS) instance:
83  
84 =over
85  
86 =item *
87  
88 C<file-system-id>: The ID of the Amazon EFS file system that is backed
89 up by AWS Backup. Returned in C<GetRecoveryPointRestoreMetadata>.
90  
91 =item *
92  
93 C<Encrypted>: A Boolean value that, if true, specifies that the file
94 system is encrypted. If C<KmsKeyId> is specified, C<Encrypted> must be
95 set to C<true>.
96  
97 =item *
98  
99 C<KmsKeyId>: Specifies the AWS KMS key that is used to encrypt the
100 restored file system. You can specify a key from another AWS account
101 provided that key it is properly shared with your account via AWS KMS.
102  
103 =item *
104  
105 C<PerformanceMode>: Specifies the throughput mode of the file system.
106  
107 =item *
108  
109 C<CreationToken>: A user-supplied value that ensures the uniqueness
110 (idempotency) of the request.
111  
112 =item *
113  
114 C<newFileSystem>: A Boolean value that, if true, specifies that the
115 recovery point is restored to a new Amazon EFS file system.
116  
117 =item *
118  
119 C<ItemsToRestore >: An array of one to five strings where each string
120 is a file path. Use C<ItemsToRestore> to restore specific files or
121 directories rather than the entire file system. This parameter is
122 optional. For example, C<"itemsToRestore":"[\"/my.test\"]">.
123  
124 =back
125  
126  
127  
128  
129 =head2 B<REQUIRED> RecoveryPointArn => Str
130  
131 An ARN that uniquely identifies a recovery point; for example,
132 C<arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45>.
133  
134  
135  
136 =head2 ResourceType => Str
137  
138 Starts a job to restore a recovery point for one of the following
139 resources:
140  
141 =over
142  
143 =item *
144  
145 C<DynamoDB> for Amazon DynamoDB
146  
147 =item *
148  
149 C<EBS> for Amazon Elastic Block Store
150  
151 =item *
152  
153 C<EC2> for Amazon Elastic Compute Cloud
154  
155 =item *
156  
157 C<EFS> for Amazon Elastic File System
158  
159 =item *
160  
161 C<RDS> for Amazon Relational Database Service
162  
163 =item *
164  
165 C<Aurora> for Amazon Aurora
166  
167 =item *
168  
169 C<Storage Gateway> for AWS Storage Gateway
170  
171 =back
172  
173  
174  
175  
176  
177 =head1 SEE ALSO
178  
179 This class forms part of L<Paws>, documenting arguments for method StartRestoreJob in L<Paws::Backup>
180  
181 =head1 BUGS and CONTRIBUTIONS
182  
183 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
184  
185 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
186  
187 =cut
188