blib/lib/Paws/DocDB/CopyDBClusterSnapshot.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::DocDB::CopyDBClusterSnapshot;
3 use Moose;
4 has CopyTags => (is => 'ro', isa => 'Bool');
5 has KmsKeyId => (is => 'ro', isa => 'Str');
6 has PreSignedUrl => (is => 'ro', isa => 'Str');
7 has SourceDBClusterSnapshotIdentifier => (is => 'ro', isa => 'Str', required => 1);
8 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::DocDB::Tag]');
9 has TargetDBClusterSnapshotIdentifier => (is => 'ro', isa => 'Str', required => 1);
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CopyDBClusterSnapshot');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DocDB::CopyDBClusterSnapshotResult');
15 class_has _result_key => (isa => 'Str', is => 'ro', default => 'CopyDBClusterSnapshotResult');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::DocDB::CopyDBClusterSnapshot - Arguments for method CopyDBClusterSnapshot on L<Paws::DocDB>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method CopyDBClusterSnapshot on the
27 L<Amazon DocumentDB with MongoDB compatibility|Paws::DocDB> service. Use the attributes of this class
28 as arguments to method CopyDBClusterSnapshot.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CopyDBClusterSnapshot.
31  
32 =head1 SYNOPSIS
33  
34 my $rds = Paws->service('DocDB');
35 my $CopyDBClusterSnapshotResult = $rds->CopyDBClusterSnapshot(
36 SourceDBClusterSnapshotIdentifier => 'MyString',
37 TargetDBClusterSnapshotIdentifier => 'MyString',
38 CopyTags => 1, # OPTIONAL
39 KmsKeyId => 'MyString', # OPTIONAL
40 PreSignedUrl => 'MyString', # OPTIONAL
41 Tags => [
42 {
43 Key => 'MyString',
44 Value => 'MyString',
45 },
46 ...
47 ], # OPTIONAL
48 );
49  
50 # Results:
51 my $DBClusterSnapshot = $CopyDBClusterSnapshotResult->DBClusterSnapshot;
52  
53 # Returns a L<Paws::DocDB::CopyDBClusterSnapshotResult> object.
54  
55 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.
56 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/CopyDBClusterSnapshot>
57  
58 =head1 ATTRIBUTES
59  
60  
61 =head2 CopyTags => Bool
62  
63 Set to C<true> to copy all tags from the source cluster snapshot to the
64 target cluster snapshot, and otherwise C<false>. The default is
65 C<false>.
66  
67  
68  
69 =head2 KmsKeyId => Str
70  
71 The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the
72 Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias
73 for the KMS encryption key.
74  
75 If you copy an encrypted cluster snapshot from your account, you can
76 specify a value for C<KmsKeyId> to encrypt the copy with a new KMS
77 encryption key. If you don't specify a value for C<KmsKeyId>, then the
78 copy of the cluster snapshot is encrypted with the same KMS key as the
79 source cluster snapshot.
80  
81 If you copy an encrypted cluster snapshot that is shared from another
82 account, then you must specify a value for C<KmsKeyId>.
83  
84 To copy an encrypted cluster snapshot to another Region, set
85 C<KmsKeyId> to the KMS key ID that you want to use to encrypt the copy
86 of the cluster snapshot in the destination Region. KMS encryption keys
87 are specific to the Region that they are created in, and you can't use
88 encryption keys from one Region in another Region.
89  
90 If you copy an unencrypted cluster snapshot and specify a value for the
91 C<KmsKeyId> parameter, an error is returned.
92  
93  
94  
95 =head2 PreSignedUrl => Str
96  
97 The URL that contains a Signature Version 4 signed request for
98 theC<CopyDBClusterSnapshot> API action in the Region that contains the
99 source cluster snapshot to copy. You must use the C<PreSignedUrl>
100 parameter when copying a cluster snapshot from another Region.
101  
102 If you are using an Amazon Web Services SDK tool or the CLI, you can
103 specify C<SourceRegion> (or C<--source-region> for the CLI) instead of
104 specifying C<PreSignedUrl> manually. Specifying C<SourceRegion>
105 autogenerates a pre-signed URL that is a valid request for the
106 operation that can be executed in the source Region.
107  
108 The presigned URL must be a valid request for the
109 C<CopyDBClusterSnapshot> API action that can be executed in the source
110 Region that contains the cluster snapshot to be copied. The presigned
111 URL request must contain the following parameter values:
112  
113 =over
114  
115 =item *
116  
117 C<SourceRegion> - The ID of the region that contains the snapshot to be
118 copied.
119  
120 =item *
121  
122 C<SourceDBClusterSnapshotIdentifier> - The identifier for the the
123 encrypted cluster snapshot to be copied. This identifier must be in the
124 Amazon Resource Name (ARN) format for the source Region. For example,
125 if you are copying an encrypted cluster snapshot from the us-east-1
126 Region, then your C<SourceDBClusterSnapshotIdentifier> looks something
127 like the following:
128 C<arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot>.
129  
130 =item *
131  
132 C<TargetDBClusterSnapshotIdentifier> - The identifier for the new
133 cluster snapshot to be created. This parameter isn't case sensitive.
134  
135 =back
136  
137  
138  
139  
140 =head2 B<REQUIRED> SourceDBClusterSnapshotIdentifier => Str
141  
142 The identifier of the cluster snapshot to copy. This parameter is not
143 case sensitive.
144  
145 Constraints:
146  
147 =over
148  
149 =item *
150  
151 Must specify a valid system snapshot in the I<available> state.
152  
153 =item *
154  
155 If the source snapshot is in the same Region as the copy, specify a
156 valid snapshot identifier.
157  
158 =item *
159  
160 If the source snapshot is in a different Region than the copy, specify
161 a valid cluster snapshot ARN.
162  
163 =back
164  
165 Example: C<my-cluster-snapshot1>
166  
167  
168  
169 =head2 Tags => ArrayRef[L<Paws::DocDB::Tag>]
170  
171 The tags to be assigned to the cluster snapshot.
172  
173  
174  
175 =head2 B<REQUIRED> TargetDBClusterSnapshotIdentifier => Str
176  
177 The identifier of the new cluster snapshot to create from the source
178 cluster snapshot. This parameter is not case sensitive.
179  
180 Constraints:
181  
182 =over
183  
184 =item *
185  
186 Must contain from 1 to 63 letters, numbers, or hyphens.
187  
188 =item *
189  
190 The first character must be a letter.
191  
192 =item *
193  
194 Cannot end with a hyphen or contain two consecutive hyphens.
195  
196 =back
197  
198 Example: C<my-cluster-snapshot2>
199  
200  
201  
202  
203 =head1 SEE ALSO
204  
205 This class forms part of L<Paws>, documenting arguments for method CopyDBClusterSnapshot in L<Paws::DocDB>
206  
207 =head1 BUGS and CONTRIBUTIONS
208  
209 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
210  
211 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
212  
213 =cut
214