File Coverage

blib/lib/Paws/RDS/CreateDBInstanceReadReplica.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::CreateDBInstanceReadReplica;
3 1     1   322 use Moose;
  1         3  
  1         5  
4             has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool');
5             has AvailabilityZone => (is => 'ro', isa => 'Str');
6             has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool');
7             has DBInstanceClass => (is => 'ro', isa => 'Str');
8             has DBInstanceIdentifier => (is => 'ro', isa => 'Str', required => 1);
9             has DBSubnetGroupName => (is => 'ro', isa => 'Str');
10             has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool');
11             has EnablePerformanceInsights => (is => 'ro', isa => 'Bool');
12             has Iops => (is => 'ro', isa => 'Int');
13             has KmsKeyId => (is => 'ro', isa => 'Str');
14             has MonitoringInterval => (is => 'ro', isa => 'Int');
15             has MonitoringRoleArn => (is => 'ro', isa => 'Str');
16             has OptionGroupName => (is => 'ro', isa => 'Str');
17             has PerformanceInsightsKMSKeyId => (is => 'ro', isa => 'Str');
18             has Port => (is => 'ro', isa => 'Int');
19             has PreSignedUrl => (is => 'ro', isa => 'Str');
20             has PubliclyAccessible => (is => 'ro', isa => 'Bool');
21             has SourceDBInstanceIdentifier => (is => 'ro', isa => 'Str', required => 1);
22             has StorageType => (is => 'ro', isa => 'Str');
23             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]');
24              
25 1     1   5398 use MooseX::ClassAttribute;
  1         3  
  1         8  
26              
27             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDBInstanceReadReplica');
28             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::CreateDBInstanceReadReplicaResult');
29             class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateDBInstanceReadReplicaResult');
30             1;
31              
32             ### main pod documentation begin ###
33              
34             =head1 NAME
35              
36             Paws::RDS::CreateDBInstanceReadReplica - Arguments for method CreateDBInstanceReadReplica on Paws::RDS
37              
38             =head1 DESCRIPTION
39              
40             This class represents the parameters used for calling the method CreateDBInstanceReadReplica on the
41             Amazon Relational Database Service service. Use the attributes of this class
42             as arguments to method CreateDBInstanceReadReplica.
43              
44             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDBInstanceReadReplica.
45              
46             As an example:
47              
48             $service_obj->CreateDBInstanceReadReplica(Att1 => $value1, Att2 => $value2, ...);
49              
50             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.
51              
52             =head1 ATTRIBUTES
53              
54              
55             =head2 AutoMinorVersionUpgrade => Bool
56              
57             Indicates that minor engine upgrades will be applied automatically to
58             the Read Replica during the maintenance window.
59              
60             Default: Inherits from the source DB instance
61              
62              
63              
64             =head2 AvailabilityZone => Str
65              
66             The Amazon EC2 Availability Zone that the Read Replica will be created
67             in.
68              
69             Default: A random, system-chosen Availability Zone in the endpoint's
70             AWS Region.
71              
72             Example: C<us-east-1d>
73              
74              
75              
76             =head2 CopyTagsToSnapshot => Bool
77              
78             True to copy all tags from the Read Replica to snapshots of the Read
79             Replica; otherwise false. The default is false.
80              
81              
82              
83             =head2 DBInstanceClass => Str
84              
85             The compute and memory capacity of the Read Replica. Note that not all
86             instance classes are available in all regions for all DB engines.
87              
88             Valid Values: C<db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge
89             | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium |
90             db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge
91             | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large |
92             db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge |
93             db.t2.micro | db.t2.small | db.t2.medium | db.t2.large>
94              
95             Default: Inherits from the source DB instance.
96              
97              
98              
99             =head2 B<REQUIRED> DBInstanceIdentifier => Str
100              
101             The DB instance identifier of the Read Replica. This identifier is the
102             unique key that identifies a DB instance. This parameter is stored as a
103             lowercase string.
104              
105              
106              
107             =head2 DBSubnetGroupName => Str
108              
109             Specifies a DB subnet group for the DB instance. The new DB instance
110             will be created in the VPC associated with the DB subnet group. If no
111             DB subnet group is specified, then the new DB instance is not created
112             in a VPC.
113              
114             Constraints:
115              
116             =over
117              
118             =item *
119              
120             Can only be specified if the source DB instance identifier specifies a
121             DB instance in another AWS Region.
122              
123             =item *
124              
125             The specified DB subnet group must be in the same AWS Region in which
126             the operation is running.
127              
128             =item *
129              
130             All Read Replicas in one AWS Region that are created from the same
131             source DB instance must either:E<gt>
132              
133             =over
134              
135             =item *
136              
137             Specify DB subnet groups from the same VPC. All these Read Replicas
138             will be created in the same VPC.
139              
140             =item *
141              
142             Not specify a DB subnet group. All these Read Replicas will be created
143             outside of any VPC.
144              
145             =back
146              
147             =back
148              
149             Constraints: Must contain no more than 255 alphanumeric characters,
150             periods, underscores, spaces, or hyphens. Must not be default.
151              
152             Example: C<mySubnetgroup>
153              
154              
155              
156             =head2 EnableIAMDatabaseAuthentication => Bool
157              
158             True to enable mapping of AWS Identity and Access Management (IAM)
159             accounts to database accounts; otherwise false.
160              
161             You can enable IAM database authentication for the following database
162             engines
163              
164             =over
165              
166             =item *
167              
168             For MySQL 5.6, minor version 5.6.34 or higher
169              
170             =item *
171              
172             For MySQL 5.7, minor version 5.7.16 or higher
173              
174             =item *
175              
176             Aurora 5.6 or higher.
177              
178             =back
179              
180             Default: C<false>
181              
182              
183              
184             =head2 EnablePerformanceInsights => Bool
185              
186              
187              
188              
189              
190             =head2 Iops => Int
191              
192             The amount of Provisioned IOPS (input/output operations per second) to
193             be initially allocated for the DB instance.
194              
195              
196              
197             =head2 KmsKeyId => Str
198              
199             The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the
200             Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias
201             for the KMS encryption key.
202              
203             If you specify this parameter when you create a Read Replica from an
204             unencrypted DB instance, the Read Replica is encrypted.
205              
206             If you create an encrypted Read Replica in the same AWS Region as the
207             source DB instance, then you do not have to specify a value for this
208             parameter. The Read Replica is encrypted with the same KMS key as the
209             source DB instance.
210              
211             If you create an encrypted Read Replica in a different AWS Region, then
212             you must specify a KMS key for the destination AWS Region. KMS
213             encryption keys are specific to the AWS Region that they are created
214             in, and you cannot use encryption keys from one AWS Region in another
215             AWS Region.
216              
217              
218              
219             =head2 MonitoringInterval => Int
220              
221             The interval, in seconds, between points when Enhanced Monitoring
222             metrics are collected for the Read Replica. To disable collecting
223             Enhanced Monitoring metrics, specify 0. The default is 0.
224              
225             If C<MonitoringRoleArn> is specified, then you must also set
226             C<MonitoringInterval> to a value other than 0.
227              
228             Valid Values: C<0, 1, 5, 10, 15, 30, 60>
229              
230              
231              
232             =head2 MonitoringRoleArn => Str
233              
234             The ARN for the IAM role that permits RDS to send enhanced monitoring
235             metrics to CloudWatch Logs. For example,
236             C<arn:aws:iam:123456789012:role/emaccess>. For information on creating
237             a monitoring role, go to To create an IAM role for Amazon RDS Enhanced
238             Monitoring.
239              
240             If C<MonitoringInterval> is set to a value other than 0, then you must
241             supply a C<MonitoringRoleArn> value.
242              
243              
244              
245             =head2 OptionGroupName => Str
246              
247             The option group the DB instance will be associated with. If omitted,
248             the default option group for the engine specified will be used.
249              
250              
251              
252             =head2 PerformanceInsightsKMSKeyId => Str
253              
254              
255              
256              
257              
258             =head2 Port => Int
259              
260             The port number that the DB instance uses for connections.
261              
262             Default: Inherits from the source DB instance
263              
264             Valid Values: C<1150-65535>
265              
266              
267              
268             =head2 PreSignedUrl => Str
269              
270             The URL that contains a Signature Version 4 signed request for the
271             C<CreateDBInstanceReadReplica> API action in the source AWS Region that
272             contains the source DB instance.
273              
274             You must specify this parameter when you create an encrypted Read
275             Replica from another AWS Region by using the Amazon RDS API. You can
276             specify the source region option instead of this parameter when you
277             create an encrypted Read Replica from another AWS Region by using the
278             AWS CLI.
279              
280             The presigned URL must be a valid request for the
281             C<CreateDBInstanceReadReplica> API action that can be executed in the
282             source AWS Region that contains the encrypted source DB instance. The
283             presigned URL request must contain the following parameter values:
284              
285             =over
286              
287             =item *
288              
289             C<DestinationRegion> - The AWS Region that the encrypted Read Replica
290             will be created in. This AWS Region is the same one where the
291             C<CreateDBInstanceReadReplica> action is called that contains this
292             presigned URL.
293              
294             For example, if you create an encrypted DB instance in the us-west-1
295             region, from a source DB instance in the us-east-2 region, then you
296             call the C<CreateDBInstanceReadReplica> action in the us-east-1 region
297             and provide a presigned URL that contains a call to the
298             C<CreateDBInstanceReadReplica> action in the us-west-2 region. For this
299             example, the C<DestinationRegion> in the presigned URL must be set to
300             the us-east-1 region.
301              
302             =item *
303              
304             C<KmsKeyId> - The KMS key identifier for the key to use to encrypt the
305             Read Replica in the destination AWS Region. This is the same identifier
306             for both the C<CreateDBInstanceReadReplica> action that is called in
307             the destination AWS Region, and the action contained in the presigned
308             URL.
309              
310             =item *
311              
312             C<SourceDBInstanceIdentifier> - The DB instance identifier for the
313             encrypted DB instance to be replicated. This identifier must be in the
314             Amazon Resource Name (ARN) format for the source AWS Region. For
315             example, if you are creating an encrypted Read Replica from a DB
316             instance in the us-west-2 region, then your
317             C<SourceDBInstanceIdentifier> looks like the following example:
318             C<arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115>.
319              
320             =back
321              
322             To learn how to generate a Signature Version 4 signed request, see
323             Authenticating Requests: Using Query Parameters (AWS Signature Version
324             4) and Signature Version 4 Signing Process.
325              
326              
327              
328             =head2 PubliclyAccessible => Bool
329              
330             Specifies the accessibility options for the DB instance. A value of
331             true specifies an Internet-facing instance with a publicly resolvable
332             DNS name, which resolves to a public IP address. A value of false
333             specifies an internal instance with a DNS name that resolves to a
334             private IP address.
335              
336             Default: The default behavior varies depending on whether a VPC has
337             been requested or not. The following list shows the default behavior in
338             each case.
339              
340             =over
341              
342             =item *
343              
344             B<Default VPC:>true
345              
346             =item *
347              
348             B<VPC:>false
349              
350             =back
351              
352             If no DB subnet group has been specified as part of the request and the
353             PubliclyAccessible value has not been set, the DB instance will be
354             publicly accessible. If a specific DB subnet group has been specified
355             as part of the request and the PubliclyAccessible value has not been
356             set, the DB instance will be private.
357              
358              
359              
360             =head2 B<REQUIRED> SourceDBInstanceIdentifier => Str
361              
362             The identifier of the DB instance that will act as the source for the
363             Read Replica. Each DB instance can have up to five Read Replicas.
364              
365             Constraints:
366              
367             =over
368              
369             =item *
370              
371             Must be the identifier of an existing MySQL, MariaDB, or PostgreSQL DB
372             instance.
373              
374             =item *
375              
376             Can specify a DB instance that is a MySQL Read Replica only if the
377             source is running MySQL 5.6.
378              
379             =item *
380              
381             Can specify a DB instance that is a PostgreSQL DB instance only if the
382             source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross
383             region replication).
384              
385             =item *
386              
387             The specified DB instance must have automatic backups enabled, its
388             backup retention period must be greater than 0.
389              
390             =item *
391              
392             If the source DB instance is in the same AWS Region as the Read
393             Replica, specify a valid DB instance identifier.
394              
395             =item *
396              
397             If the source DB instance is in a different AWS Region than the Read
398             Replica, specify a valid DB instance ARN. For more information, go to
399             Constructing a Amazon RDS Amazon Resource Name (ARN).
400              
401             =back
402              
403              
404              
405              
406             =head2 StorageType => Str
407              
408             Specifies the storage type to be associated with the Read Replica.
409              
410             Valid values: C<standard | gp2 | io1>
411              
412             If you specify C<io1>, you must also include a value for the C<Iops>
413             parameter.
414              
415             Default: C<io1> if the C<Iops> parameter is specified; otherwise
416             C<standard>
417              
418              
419              
420             =head2 Tags => ArrayRef[L<Paws::RDS::Tag>]
421              
422              
423              
424              
425              
426              
427             =head1 SEE ALSO
428              
429             This class forms part of L<Paws>, documenting arguments for method CreateDBInstanceReadReplica in L<Paws::RDS>
430              
431             =head1 BUGS and CONTRIBUTIONS
432              
433             The source code is located here: https://github.com/pplu/aws-sdk-perl
434              
435             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
436              
437             =cut
438