File Coverage

blib/lib/Paws/RDS/CopyDBClusterSnapshot.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::RDS::CopyDBClusterSnapshot;
3 1     1   345 use Moose;
  1         4  
  1         6  
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::RDS::Tag]');
9             has TargetDBClusterSnapshotIdentifier => (is => 'ro', isa => 'Str', required => 1);
10              
11 1     1   5428 use MooseX::ClassAttribute;
  1         3  
  1         7  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CopyDBClusterSnapshot');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::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::RDS::CopyDBClusterSnapshot - Arguments for method CopyDBClusterSnapshot on Paws::RDS
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method CopyDBClusterSnapshot on the
27             Amazon Relational Database Service 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             As an example:
33              
34             $service_obj->CopyDBClusterSnapshot(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 CopyTags => Bool
42              
43             True to copy all tags from the source DB cluster snapshot to the target
44             DB cluster snapshot; otherwise false. The default is false.
45              
46              
47              
48             =head2 KmsKeyId => Str
49              
50             The AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID
51             is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key
52             alias for the KMS encryption key.
53              
54             If you copy an unencrypted DB cluster snapshot and specify a value for
55             the C<KmsKeyId> parameter, Amazon RDS encrypts the target DB cluster
56             snapshot using the specified KMS encryption key.
57              
58             If you copy an encrypted DB cluster snapshot from your AWS account, you
59             can specify a value for C<KmsKeyId> to encrypt the copy with a new KMS
60             encryption key. If you don't specify a value for C<KmsKeyId>, then the
61             copy of the DB cluster snapshot is encrypted with the same KMS key as
62             the source DB cluster snapshot.
63              
64             If you copy an encrypted DB cluster snapshot that is shared from
65             another AWS account, then you must specify a value for C<KmsKeyId>.
66              
67             To copy an encrypted DB cluster snapshot to another AWS Region, you
68             must set C<KmsKeyId> to the KMS key ID you want to use to encrypt the
69             copy of the DB cluster snapshot in the destination AWS Region. KMS
70             encryption keys are specific to the AWS Region that they are created
71             in, and you cannot use encryption keys from one AWS Region in another
72             AWS Region.
73              
74              
75              
76             =head2 PreSignedUrl => Str
77              
78             The URL that contains a Signature Version 4 signed request for the
79             C<CopyDBClusterSnapshot> API action in the AWS Region that contains the
80             source DB cluster snapshot to copy. The C<PreSignedUrl> parameter must
81             be used when copying an encrypted DB cluster snapshot from another AWS
82             Region.
83              
84             The pre-signed URL must be a valid request for the
85             C<CopyDBSClusterSnapshot> API action that can be executed in the source
86             AWS Region that contains the encrypted DB cluster snapshot to be
87             copied. The pre-signed URL request must contain the following parameter
88             values:
89              
90             =over
91              
92             =item *
93              
94             C<KmsKeyId> - The KMS key identifier for the key to use to encrypt the
95             copy of the DB cluster snapshot in the destination AWS Region. This is
96             the same identifier for both the C<CopyDBClusterSnapshot> action that
97             is called in the destination AWS Region, and the action contained in
98             the pre-signed URL.
99              
100             =item *
101              
102             C<DestinationRegion> - The name of the AWS Region that the DB cluster
103             snapshot will be created in.
104              
105             =item *
106              
107             C<SourceDBClusterSnapshotIdentifier> - The DB cluster snapshot
108             identifier for the encrypted DB cluster snapshot to be copied. This
109             identifier must be in the Amazon Resource Name (ARN) format for the
110             source AWS Region. For example, if you are copying an encrypted DB
111             cluster snapshot from the us-west-2 region, then your
112             C<SourceDBClusterSnapshotIdentifier> looks like the following example:
113             C<arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115>.
114              
115             =back
116              
117             To learn how to generate a Signature Version 4 signed request, see
118             Authenticating Requests: Using Query Parameters (AWS Signature Version
119             4) and Signature Version 4 Signing Process.
120              
121              
122              
123             =head2 B<REQUIRED> SourceDBClusterSnapshotIdentifier => Str
124              
125             The identifier of the DB cluster snapshot to copy. This parameter is
126             not case-sensitive.
127              
128             You cannot copy an encrypted, shared DB cluster snapshot from one AWS
129             Region to another.
130              
131             Constraints:
132              
133             =over
134              
135             =item *
136              
137             Must contain from 1 to 63 alphanumeric characters or hyphens.
138              
139             =item *
140              
141             First character must be a letter.
142              
143             =item *
144              
145             Cannot end with a hyphen or contain two consecutive hyphens.
146              
147             =item *
148              
149             Must specify a valid system snapshot in the "available" state.
150              
151             =item *
152              
153             If the source snapshot is in the same AWS Region as the copy, specify a
154             valid DB snapshot identifier.
155              
156             =item *
157              
158             If the source snapshot is in a different AWS Region than the copy,
159             specify a valid DB cluster snapshot ARN. For more information, go to
160             Copying a DB Snapshot or DB Cluster Snapshot.
161              
162             =back
163              
164             Example: C<my-cluster-snapshot1>
165              
166              
167              
168             =head2 Tags => ArrayRef[L<Paws::RDS::Tag>]
169              
170              
171              
172              
173              
174             =head2 B<REQUIRED> TargetDBClusterSnapshotIdentifier => Str
175              
176             The identifier of the new DB cluster snapshot to create from the source
177             DB cluster snapshot. This parameter is not case-sensitive.
178              
179             Constraints:
180              
181             =over
182              
183             =item *
184              
185             Must contain from 1 to 63 alphanumeric characters or hyphens.
186              
187             =item *
188              
189             First character must be a letter.
190              
191             =item *
192              
193             Cannot end with a hyphen or contain two consecutive hyphens.
194              
195             =back
196              
197             Example: C<my-cluster-snapshot2>
198              
199              
200              
201              
202             =head1 SEE ALSO
203              
204             This class forms part of L<Paws>, documenting arguments for method CopyDBClusterSnapshot in L<Paws::RDS>
205              
206             =head1 BUGS and CONTRIBUTIONS
207              
208             The source code is located here: https://github.com/pplu/aws-sdk-perl
209              
210             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
211              
212             =cut
213