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

filter: Statementstmt 0.0% 0 / 33 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 35 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::RDS::ModifyDBCluster;
3 use Moose;
4 has AllowMajorVersionUpgrade => (is => 'ro', isa => 'Bool');
5 has ApplyImmediately => (is => 'ro', isa => 'Bool');
6 has BacktrackWindow => (is => 'ro', isa => 'Int');
7 has BackupRetentionPeriod => (is => 'ro', isa => 'Int');
8 has CloudwatchLogsExportConfiguration => (is => 'ro', isa => 'Paws::RDS::CloudwatchLogsExportConfiguration');
9 has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool');
10 has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1);
11 has DBClusterParameterGroupName => (is => 'ro', isa => 'Str');
12 has DBInstanceParameterGroupName => (is => 'ro', isa => 'Str');
13 has DeletionProtection => (is => 'ro', isa => 'Bool');
14 has Domain => (is => 'ro', isa => 'Str');
15 has DomainIAMRoleName => (is => 'ro', isa => 'Str');
16 has EnableGlobalWriteForwarding => (is => 'ro', isa => 'Bool');
17 has EnableHttpEndpoint => (is => 'ro', isa => 'Bool');
18 has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool');
19 has EngineVersion => (is => 'ro', isa => 'Str');
20 has MasterUserPassword => (is => 'ro', isa => 'Str');
21 has NewDBClusterIdentifier => (is => 'ro', isa => 'Str');
22 has OptionGroupName => (is => 'ro', isa => 'Str');
23 has Port => (is => 'ro', isa => 'Int');
24 has PreferredBackupWindow => (is => 'ro', isa => 'Str');
25 has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
26 has ScalingConfiguration => (is => 'ro', isa => 'Paws::RDS::ScalingConfiguration');
27 has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
28  
29 use MooseX::ClassAttribute;
30  
31 class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyDBCluster');
32 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::ModifyDBClusterResult');
33 class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyDBClusterResult');
34 1;
35  
36 ### main pod documentation begin ###
37  
38 =head1 NAME
39  
40 Paws::RDS::ModifyDBCluster - Arguments for method ModifyDBCluster on L<Paws::RDS>
41  
42 =head1 DESCRIPTION
43  
44 This class represents the parameters used for calling the method ModifyDBCluster on the
45 L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class
46 as arguments to method ModifyDBCluster.
47  
48 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyDBCluster.
49  
50 =head1 SYNOPSIS
51  
52 my $rds = Paws->service('RDS');
53 # To change DB cluster settings
54 # This example changes the specified settings for the specified DB cluster.
55 my $ModifyDBClusterResult = $rds->ModifyDBCluster(
56 'ApplyImmediately' => 1,
57 'DBClusterIdentifier' => 'mydbcluster',
58 'MasterUserPassword' => 'mynewpassword',
59 'NewDBClusterIdentifier' => 'mynewdbcluster',
60 'PreferredBackupWindow' => '04:00-04:30',
61 'PreferredMaintenanceWindow' => 'Tue:05:00-Tue:05:30'
62 );
63  
64 # Results:
65 my $DBCluster = $ModifyDBClusterResult->DBCluster;
66  
67 # Returns a L<Paws::RDS::ModifyDBClusterResult> object.
68  
69 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.
70 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/ModifyDBCluster>
71  
72 =head1 ATTRIBUTES
73  
74  
75 =head2 AllowMajorVersionUpgrade => Bool
76  
77 A value that indicates whether major version upgrades are allowed.
78  
79 Constraints: You must allow major version upgrades when specifying a
80 value for the C<EngineVersion> parameter that is a different major
81 version than the DB cluster's current version.
82  
83  
84  
85 =head2 ApplyImmediately => Bool
86  
87 A value that indicates whether the modifications in this request and
88 any pending modifications are asynchronously applied as soon as
89 possible, regardless of the C<PreferredMaintenanceWindow> setting for
90 the DB cluster. If this parameter is disabled, changes to the DB
91 cluster are applied during the next maintenance window.
92  
93 The C<ApplyImmediately> parameter only affects the
94 C<EnableIAMDatabaseAuthentication>, C<MasterUserPassword>, and
95 C<NewDBClusterIdentifier> values. If the C<ApplyImmediately> parameter
96 is disabled, then changes to the C<EnableIAMDatabaseAuthentication>,
97 C<MasterUserPassword>, and C<NewDBClusterIdentifier> values are applied
98 during the next maintenance window. All other changes are applied
99 immediately, regardless of the value of the C<ApplyImmediately>
100 parameter.
101  
102 By default, this parameter is disabled.
103  
104  
105  
106 =head2 BacktrackWindow => Int
107  
108 The target backtrack window, in seconds. To disable backtracking, set
109 this value to 0.
110  
111 Currently, Backtrack is only supported for Aurora MySQL DB clusters.
112  
113 Default: 0
114  
115 Constraints:
116  
117 =over
118  
119 =item *
120  
121 If specified, this value must be set to a number from 0 to 259,200 (72
122 hours).
123  
124 =back
125  
126  
127  
128  
129 =head2 BackupRetentionPeriod => Int
130  
131 The number of days for which automated backups are retained. You must
132 specify a minimum value of 1.
133  
134 Default: 1
135  
136 Constraints:
137  
138 =over
139  
140 =item *
141  
142 Must be a value from 1 to 35
143  
144 =back
145  
146  
147  
148  
149 =head2 CloudwatchLogsExportConfiguration => L<Paws::RDS::CloudwatchLogsExportConfiguration>
150  
151 The configuration setting for the log types to be enabled for export to
152 CloudWatch Logs for a specific DB cluster.
153  
154  
155  
156 =head2 CopyTagsToSnapshot => Bool
157  
158 A value that indicates whether to copy all tags from the DB cluster to
159 snapshots of the DB cluster. The default is not to copy them.
160  
161  
162  
163 =head2 B<REQUIRED> DBClusterIdentifier => Str
164  
165 The DB cluster identifier for the cluster being modified. This
166 parameter isn't case-sensitive.
167  
168 Constraints: This identifier must match the identifier of an existing
169 DB cluster.
170  
171  
172  
173 =head2 DBClusterParameterGroupName => Str
174  
175 The name of the DB cluster parameter group to use for the DB cluster.
176  
177  
178  
179 =head2 DBInstanceParameterGroupName => Str
180  
181 The name of the DB parameter group to apply to all instances of the DB
182 cluster.
183  
184 When you apply a parameter group using the
185 C<DBInstanceParameterGroupName> parameter, the DB cluster isn't
186 rebooted automatically. Also, parameter changes aren't applied during
187 the next maintenance window but instead are applied immediately.
188  
189 Default: The existing name setting
190  
191 Constraints:
192  
193 =over
194  
195 =item *
196  
197 The DB parameter group must be in the same DB parameter group family as
198 this DB cluster.
199  
200 =item *
201  
202 The C<DBInstanceParameterGroupName> parameter is only valid in
203 combination with the C<AllowMajorVersionUpgrade> parameter.
204  
205 =back
206  
207  
208  
209  
210 =head2 DeletionProtection => Bool
211  
212 A value that indicates whether the DB cluster has deletion protection
213 enabled. The database can't be deleted when deletion protection is
214 enabled. By default, deletion protection is disabled.
215  
216  
217  
218 =head2 Domain => Str
219  
220 The Active Directory directory ID to move the DB cluster to. Specify
221 C<none> to remove the cluster from its current domain. The domain must
222 be created prior to this operation.
223  
224 For more information, see Kerberos Authentication
225 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html)
226 in the I<Amazon Aurora User Guide>.
227  
228  
229  
230 =head2 DomainIAMRoleName => Str
231  
232 Specify the name of the IAM role to be used when making API calls to
233 the Directory Service.
234  
235  
236  
237 =head2 EnableGlobalWriteForwarding => Bool
238  
239 A value that indicates whether to enable this DB cluster to forward
240 write operations to the primary cluster of an Aurora global database
241 (GlobalCluster). By default, write operations are not allowed on Aurora
242 DB clusters that are secondary clusters in an Aurora global database.
243  
244 You can set this value only on Aurora DB clusters that are members of
245 an Aurora global database. With this parameter enabled, a secondary
246 cluster can forward writes to the current primary cluster and the
247 resulting changes are replicated back to this cluster. For the primary
248 DB cluster of an Aurora global database, this value is used immediately
249 if the primary is demoted by the FailoverGlobalCluster API operation,
250 but it does nothing until then.
251  
252  
253  
254 =head2 EnableHttpEndpoint => Bool
255  
256 A value that indicates whether to enable the HTTP endpoint for an
257 Aurora Serverless DB cluster. By default, the HTTP endpoint is
258 disabled.
259  
260 When enabled, the HTTP endpoint provides a connectionless web service
261 API for running SQL queries on the Aurora Serverless DB cluster. You
262 can also query your database from inside the RDS console with the query
263 editor.
264  
265 For more information, see Using the Data API for Aurora Serverless
266 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)
267 in the I<Amazon Aurora User Guide>.
268  
269  
270  
271 =head2 EnableIAMDatabaseAuthentication => Bool
272  
273 A value that indicates whether to enable mapping of Amazon Web Services
274 Identity and Access Management (IAM) accounts to database accounts. By
275 default, mapping is disabled.
276  
277 For more information, see IAM Database Authentication
278 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html)
279 in the I<Amazon Aurora User Guide.>
280  
281  
282  
283 =head2 EngineVersion => Str
284  
285 The version number of the database engine to which you want to upgrade.
286 Changing this parameter results in an outage. The change is applied
287 during the next maintenance window unless C<ApplyImmediately> is
288 enabled.
289  
290 To list all of the available engine versions for C<aurora> (for MySQL
291 5.6-compatible Aurora), use the following command:
292  
293 C<aws rds describe-db-engine-versions --engine aurora --query
294 "DBEngineVersions[].EngineVersion">
295  
296 To list all of the available engine versions for C<aurora-mysql> (for
297 MySQL 5.7-compatible Aurora), use the following command:
298  
299 C<aws rds describe-db-engine-versions --engine aurora-mysql --query
300 "DBEngineVersions[].EngineVersion">
301  
302 To list all of the available engine versions for C<aurora-postgresql>,
303 use the following command:
304  
305 C<aws rds describe-db-engine-versions --engine aurora-postgresql
306 --query "DBEngineVersions[].EngineVersion">
307  
308  
309  
310 =head2 MasterUserPassword => Str
311  
312 The new password for the master database user. This password can
313 contain any printable ASCII character except "/", """, or "@".
314  
315 Constraints: Must contain from 8 to 41 characters.
316  
317  
318  
319 =head2 NewDBClusterIdentifier => Str
320  
321 The new DB cluster identifier for the DB cluster when renaming a DB
322 cluster. This value is stored as a lowercase string.
323  
324 Constraints:
325  
326 =over
327  
328 =item *
329  
330 Must contain from 1 to 63 letters, numbers, or hyphens
331  
332 =item *
333  
334 The first character must be a letter
335  
336 =item *
337  
338 Can't end with a hyphen or contain two consecutive hyphens
339  
340 =back
341  
342 Example: C<my-cluster2>
343  
344  
345  
346 =head2 OptionGroupName => Str
347  
348 A value that indicates that the DB cluster should be associated with
349 the specified option group. Changing this parameter doesn't result in
350 an outage except in the following case, and the change is applied
351 during the next maintenance window unless the C<ApplyImmediately> is
352 enabled for this request. If the parameter change results in an option
353 group that enables OEM, this change can cause a brief (sub-second)
354 period during which new connections are rejected but existing
355 connections are not interrupted.
356  
357 Permanent options can't be removed from an option group. The option
358 group can't be removed from a DB cluster once it is associated with a
359 DB cluster.
360  
361  
362  
363 =head2 Port => Int
364  
365 The port number on which the DB cluster accepts connections.
366  
367 Constraints: Value must be C<1150-65535>
368  
369 Default: The same port as the original DB cluster.
370  
371  
372  
373 =head2 PreferredBackupWindow => Str
374  
375 The daily time range during which automated backups are created if
376 automated backups are enabled, using the C<BackupRetentionPeriod>
377 parameter.
378  
379 The default is a 30-minute window selected at random from an 8-hour
380 block of time for each Amazon Web Services Region. To view the time
381 blocks available, see Backup window
382 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow)
383 in the I<Amazon Aurora User Guide.>
384  
385 Constraints:
386  
387 =over
388  
389 =item *
390  
391 Must be in the format C<hh24:mi-hh24:mi>.
392  
393 =item *
394  
395 Must be in Universal Coordinated Time (UTC).
396  
397 =item *
398  
399 Must not conflict with the preferred maintenance window.
400  
401 =item *
402  
403 Must be at least 30 minutes.
404  
405 =back
406  
407  
408  
409  
410 =head2 PreferredMaintenanceWindow => Str
411  
412 The weekly time range during which system maintenance can occur, in
413 Universal Coordinated Time (UTC).
414  
415 Format: C<ddd:hh24:mi-ddd:hh24:mi>
416  
417 The default is a 30-minute window selected at random from an 8-hour
418 block of time for each Amazon Web Services Region, occurring on a
419 random day of the week. To see the time blocks available, see Adjusting
420 the Preferred DB Cluster Maintenance Window
421 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora)
422 in the I<Amazon Aurora User Guide.>
423  
424 Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
425  
426 Constraints: Minimum 30-minute window.
427  
428  
429  
430 =head2 ScalingConfiguration => L<Paws::RDS::ScalingConfiguration>
431  
432 The scaling properties of the DB cluster. You can only modify scaling
433 properties for DB clusters in C<serverless> DB engine mode.
434  
435  
436  
437 =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef]
438  
439 A list of VPC security groups that the DB cluster will belong to.
440  
441  
442  
443  
444 =head1 SEE ALSO
445  
446 This class forms part of L<Paws>, documenting arguments for method ModifyDBCluster in L<Paws::RDS>
447  
448 =head1 BUGS and CONTRIBUTIONS
449  
450 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
451  
452 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
453  
454 =cut
455