blib/lib/Paws/RDS/CopyDBSnapshot.pm untested

filter: Statementstmt 0.0% 0 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 19 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::RDS::CopyDBSnapshot;
3 use Moose;
4 has CopyTags => (is => 'ro', isa => 'Bool');
5 has KmsKeyId => (is => 'ro', isa => 'Str');
6 has OptionGroupName => (is => 'ro', isa => 'Str');
7 has PreSignedUrl => (is => 'ro', isa => 'Str');
8 has SourceDBSnapshotIdentifier => (is => 'ro', isa => 'Str', required => 1);
9 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]');
10 has TargetCustomAvailabilityZone => (is => 'ro', isa => 'Str');
11 has TargetDBSnapshotIdentifier => (is => 'ro', isa => 'Str', required => 1);
12  
13 use MooseX::ClassAttribute;
14  
15 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CopyDBSnapshot');
16 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::CopyDBSnapshotResult');
17 class_has _result_key => (isa => 'Str', is => 'ro', default => 'CopyDBSnapshotResult');
18 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::RDS::CopyDBSnapshot - Arguments for method CopyDBSnapshot on L<Paws::RDS>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method CopyDBSnapshot on the
29 L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class
30 as arguments to method CopyDBSnapshot.
31  
32 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CopyDBSnapshot.
33  
34 =head1 SYNOPSIS
35  
36 my $rds = Paws->service('RDS');
37 # To copy a DB snapshot
38 # This example copies a DB snapshot.
39 my $CopyDBSnapshotResult = $rds->CopyDBSnapshot(
40 'SourceDBSnapshotIdentifier' => 'mydbsnapshot',
41 'TargetDBSnapshotIdentifier' => 'mydbsnapshot-copy'
42 );
43  
44 # Results:
45 my $DBSnapshot = $CopyDBSnapshotResult->DBSnapshot;
46  
47 # Returns a L<Paws::RDS::CopyDBSnapshotResult> object.
48  
49 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.
50 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/CopyDBSnapshot>
51  
52 =head1 ATTRIBUTES
53  
54  
55 =head2 CopyTags => Bool
56  
57 A value that indicates whether to copy all tags from the source DB
58 snapshot to the target DB snapshot. By default, tags are not copied.
59  
60  
61  
62 =head2 KmsKeyId => Str
63  
64 The Amazon Web Services KMS key identifier for an encrypted DB
65 snapshot. The Amazon Web Services KMS key identifier is the key ARN,
66 key ID, alias ARN, or alias name for the Amazon Web Services KMS
67 customer master key (CMK).
68  
69 If you copy an encrypted DB snapshot from your Amazon Web Services
70 account, you can specify a value for this parameter to encrypt the copy
71 with a new Amazon Web Services KMS CMK. If you don't specify a value
72 for this parameter, then the copy of the DB snapshot is encrypted with
73 the same Amazon Web Services KMS key as the source DB snapshot.
74  
75 If you copy an encrypted DB snapshot that is shared from another Amazon
76 Web Services account, then you must specify a value for this parameter.
77  
78 If you specify this parameter when you copy an unencrypted snapshot,
79 the copy is encrypted.
80  
81 If you copy an encrypted snapshot to a different Amazon Web Services
82 Region, then you must specify a Amazon Web Services KMS key identifier
83 for the destination Amazon Web Services Region. Amazon Web Services KMS
84 CMKs are specific to the Amazon Web Services Region that they are
85 created in, and you can't use CMKs from one Amazon Web Services Region
86 in another Amazon Web Services Region.
87  
88  
89  
90 =head2 OptionGroupName => Str
91  
92 The name of an option group to associate with the copy of the snapshot.
93  
94 Specify this option if you are copying a snapshot from one Amazon Web
95 Services Region to another, and your DB instance uses a nondefault
96 option group. If your source DB instance uses Transparent Data
97 Encryption for Oracle or Microsoft SQL Server, you must specify this
98 option when copying across Amazon Web Services Regions. For more
99 information, see Option group considerations
100 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options)
101 in the I<Amazon RDS User Guide.>
102  
103  
104  
105 =head2 PreSignedUrl => Str
106  
107 The URL that contains a Signature Version 4 signed request for the
108 C<CopyDBSnapshot> API action in the source Amazon Web Services Region
109 that contains the source DB snapshot to copy.
110  
111 You must specify this parameter when you copy an encrypted DB snapshot
112 from another Amazon Web Services Region by using the Amazon RDS API.
113 Don't specify C<PreSignedUrl> when you are copying an encrypted DB
114 snapshot in the same Amazon Web Services Region.
115  
116 The presigned URL must be a valid request for the C<CopyDBSnapshot> API
117 action that can be executed in the source Amazon Web Services Region
118 that contains the encrypted DB snapshot to be copied. The presigned URL
119 request must contain the following parameter values:
120  
121 =over
122  
123 =item *
124  
125 C<DestinationRegion> - The Amazon Web Services Region that the
126 encrypted DB snapshot is copied to. This Amazon Web Services Region is
127 the same one where the C<CopyDBSnapshot> action is called that contains
128 this presigned URL.
129  
130 For example, if you copy an encrypted DB snapshot from the us-west-2
131 Amazon Web Services Region to the us-east-1 Amazon Web Services Region,
132 then you call the C<CopyDBSnapshot> action in the us-east-1 Amazon Web
133 Services Region and provide a presigned URL that contains a call to the
134 C<CopyDBSnapshot> action in the us-west-2 Amazon Web Services Region.
135 For this example, the C<DestinationRegion> in the presigned URL must be
136 set to the us-east-1 Amazon Web Services Region.
137  
138 =item *
139  
140 C<KmsKeyId> - The Amazon Web Services KMS key identifier for the
141 customer master key (CMK) to use to encrypt the copy of the DB snapshot
142 in the destination Amazon Web Services Region. This is the same
143 identifier for both the C<CopyDBSnapshot> action that is called in the
144 destination Amazon Web Services Region, and the action contained in the
145 presigned URL.
146  
147 =item *
148  
149 C<SourceDBSnapshotIdentifier> - The DB snapshot identifier for the
150 encrypted snapshot to be copied. This identifier must be in the Amazon
151 Resource Name (ARN) format for the source Amazon Web Services Region.
152 For example, if you are copying an encrypted DB snapshot from the
153 us-west-2 Amazon Web Services Region, then your
154 C<SourceDBSnapshotIdentifier> looks like the following example:
155 C<arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115>.
156  
157 =back
158  
159 To learn how to generate a Signature Version 4 signed request, see
160 Authenticating Requests: Using Query Parameters (Amazon Web Services
161 Signature Version 4)
162 (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html)
163 and Signature Version 4 Signing Process
164 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).
165  
166 If you are using an Amazon Web Services SDK tool or the CLI, you can
167 specify C<SourceRegion> (or C<--source-region> for the CLI) instead of
168 specifying C<PreSignedUrl> manually. Specifying C<SourceRegion>
169 autogenerates a pre-signed URL that is a valid request for the
170 operation that can be executed in the source Amazon Web Services
171 Region.
172  
173  
174  
175 =head2 B<REQUIRED> SourceDBSnapshotIdentifier => Str
176  
177 The identifier for the source DB snapshot.
178  
179 If the source snapshot is in the same Amazon Web Services Region as the
180 copy, specify a valid DB snapshot identifier. For example, you might
181 specify C<rds:mysql-instance1-snapshot-20130805>.
182  
183 If the source snapshot is in a different Amazon Web Services Region
184 than the copy, specify a valid DB snapshot ARN. For example, you might
185 specify
186 C<arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805>.
187  
188 If you are copying from a shared manual DB snapshot, this parameter
189 must be the Amazon Resource Name (ARN) of the shared DB snapshot.
190  
191 If you are copying an encrypted snapshot this parameter must be in the
192 ARN format for the source Amazon Web Services Region, and must match
193 the C<SourceDBSnapshotIdentifier> in the C<PreSignedUrl> parameter.
194  
195 Constraints:
196  
197 =over
198  
199 =item *
200  
201 Must specify a valid system snapshot in the "available" state.
202  
203 =back
204  
205 Example: C<rds:mydb-2012-04-02-00-01>
206  
207 Example:
208 C<arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805>
209  
210  
211  
212 =head2 Tags => ArrayRef[L<Paws::RDS::Tag>]
213  
214  
215  
216  
217  
218 =head2 TargetCustomAvailabilityZone => Str
219  
220 The external custom Availability Zone (CAZ) identifier for the target
221 CAZ.
222  
223 Example: C<rds-caz-aiqhTgQv>.
224  
225  
226  
227 =head2 B<REQUIRED> TargetDBSnapshotIdentifier => Str
228  
229 The identifier for the copy of the snapshot.
230  
231 Constraints:
232  
233 =over
234  
235 =item *
236  
237 Can't be null, empty, or blank
238  
239 =item *
240  
241 Must contain from 1 to 255 letters, numbers, or hyphens
242  
243 =item *
244  
245 First character must be a letter
246  
247 =item *
248  
249 Can't end with a hyphen or contain two consecutive hyphens
250  
251 =back
252  
253 Example: C<my-db-snapshot>
254  
255  
256  
257  
258 =head1 SEE ALSO
259  
260 This class forms part of L<Paws>, documenting arguments for method CopyDBSnapshot in L<Paws::RDS>
261  
262 =head1 BUGS and CONTRIBUTIONS
263  
264 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
265  
266 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
267  
268 =cut
269