File Coverage

blib/lib/Paws/RDS/ModifyDBCluster.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::ModifyDBCluster;
3 1     1   326 use Moose;
  1         2  
  1         6  
4             has ApplyImmediately => (is => 'ro', isa => 'Bool');
5             has BackupRetentionPeriod => (is => 'ro', isa => 'Int');
6             has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1);
7             has DBClusterParameterGroupName => (is => 'ro', isa => 'Str');
8             has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool');
9             has MasterUserPassword => (is => 'ro', isa => 'Str');
10             has NewDBClusterIdentifier => (is => 'ro', isa => 'Str');
11             has OptionGroupName => (is => 'ro', isa => 'Str');
12             has Port => (is => 'ro', isa => 'Int');
13             has PreferredBackupWindow => (is => 'ro', isa => 'Str');
14             has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
15             has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
16              
17 1     1   5477 use MooseX::ClassAttribute;
  1         2  
  1         9  
18              
19             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyDBCluster');
20             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::ModifyDBClusterResult');
21             class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyDBClusterResult');
22             1;
23              
24             ### main pod documentation begin ###
25              
26             =head1 NAME
27              
28             Paws::RDS::ModifyDBCluster - Arguments for method ModifyDBCluster on Paws::RDS
29              
30             =head1 DESCRIPTION
31              
32             This class represents the parameters used for calling the method ModifyDBCluster on the
33             Amazon Relational Database Service service. Use the attributes of this class
34             as arguments to method ModifyDBCluster.
35              
36             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyDBCluster.
37              
38             As an example:
39              
40             $service_obj->ModifyDBCluster(Att1 => $value1, Att2 => $value2, ...);
41              
42             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.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 ApplyImmediately => Bool
48              
49             A value that specifies whether the modifications in this request and
50             any pending modifications are asynchronously applied as soon as
51             possible, regardless of the C<PreferredMaintenanceWindow> setting for
52             the DB cluster. If this parameter is set to C<false>, changes to the DB
53             cluster are applied during the next maintenance window.
54              
55             The C<ApplyImmediately> parameter only affects the
56             C<NewDBClusterIdentifier> and C<MasterUserPassword> values. If you set
57             the C<ApplyImmediately> parameter value to false, then changes to the
58             C<NewDBClusterIdentifier> and C<MasterUserPassword> values are applied
59             during the next maintenance window. All other changes are applied
60             immediately, regardless of the value of the C<ApplyImmediately>
61             parameter.
62              
63             Default: C<false>
64              
65              
66              
67             =head2 BackupRetentionPeriod => Int
68              
69             The number of days for which automated backups are retained. You must
70             specify a minimum value of 1.
71              
72             Default: 1
73              
74             Constraints:
75              
76             =over
77              
78             =item *
79              
80             Must be a value from 1 to 35
81              
82             =back
83              
84              
85              
86              
87             =head2 B<REQUIRED> DBClusterIdentifier => Str
88              
89             The DB cluster identifier for the cluster being modified. This
90             parameter is not case-sensitive.
91              
92             Constraints:
93              
94             =over
95              
96             =item *
97              
98             Must be the identifier for an existing DB cluster.
99              
100             =item *
101              
102             Must contain from 1 to 63 alphanumeric characters or hyphens.
103              
104             =item *
105              
106             First character must be a letter.
107              
108             =item *
109              
110             Cannot end with a hyphen or contain two consecutive hyphens.
111              
112             =back
113              
114              
115              
116              
117             =head2 DBClusterParameterGroupName => Str
118              
119             The name of the DB cluster parameter group to use for the DB cluster.
120              
121              
122              
123             =head2 EnableIAMDatabaseAuthentication => Bool
124              
125             A Boolean value that is true to enable mapping of AWS Identity and
126             Access Management (IAM) accounts to database accounts, and otherwise
127             false.
128              
129             Default: C<false>
130              
131              
132              
133             =head2 MasterUserPassword => Str
134              
135             The new password for the master database user. This password can
136             contain any printable ASCII character except "/", """, or "@".
137              
138             Constraints: Must contain from 8 to 41 characters.
139              
140              
141              
142             =head2 NewDBClusterIdentifier => Str
143              
144             The new DB cluster identifier for the DB cluster when renaming a DB
145             cluster. This value is stored as a lowercase string.
146              
147             Constraints:
148              
149             =over
150              
151             =item *
152              
153             Must contain from 1 to 63 alphanumeric characters or hyphens
154              
155             =item *
156              
157             First character must be a letter
158              
159             =item *
160              
161             Cannot end with a hyphen or contain two consecutive hyphens
162              
163             =back
164              
165             Example: C<my-cluster2>
166              
167              
168              
169             =head2 OptionGroupName => Str
170              
171             A value that indicates that the DB cluster should be associated with
172             the specified option group. Changing this parameter does not result in
173             an outage except in the following case, and the change is applied
174             during the next maintenance window unless the C<ApplyImmediately>
175             parameter is set to C<true> for this request. If the parameter change
176             results in an option group that enables OEM, this change can cause a
177             brief (sub-second) period during which new connections are rejected but
178             existing connections are not interrupted.
179              
180             Permanent options cannot be removed from an option group. The option
181             group cannot be removed from a DB cluster once it is associated with a
182             DB cluster.
183              
184              
185              
186             =head2 Port => Int
187              
188             The port number on which the DB cluster accepts connections.
189              
190             Constraints: Value must be C<1150-65535>
191              
192             Default: The same port as the original DB cluster.
193              
194              
195              
196             =head2 PreferredBackupWindow => Str
197              
198             The daily time range during which automated backups are created if
199             automated backups are enabled, using the C<BackupRetentionPeriod>
200             parameter.
201              
202             Default: A 30-minute window selected at random from an 8-hour block of
203             time per AWS Region. To see the time blocks available, see Adjusting
204             the Preferred Maintenance Window in the I<Amazon RDS User Guide.>
205              
206             Constraints:
207              
208             =over
209              
210             =item *
211              
212             Must be in the format C<hh24:mi-hh24:mi>.
213              
214             =item *
215              
216             Times should be in Universal Coordinated Time (UTC).
217              
218             =item *
219              
220             Must not conflict with the preferred maintenance window.
221              
222             =item *
223              
224             Must be at least 30 minutes.
225              
226             =back
227              
228              
229              
230              
231             =head2 PreferredMaintenanceWindow => Str
232              
233             The weekly time range during which system maintenance can occur, in
234             Universal Coordinated Time (UTC).
235              
236             Format: C<ddd:hh24:mi-ddd:hh24:mi>
237              
238             Default: A 30-minute window selected at random from an 8-hour block of
239             time per AWS Region, occurring on a random day of the week. To see the
240             time blocks available, see Adjusting the Preferred Maintenance Window
241             in the I<Amazon RDS User Guide.>
242              
243             Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
244              
245             Constraints: Minimum 30-minute window.
246              
247              
248              
249             =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef]
250              
251             A list of VPC security groups that the DB cluster will belong to.
252              
253              
254              
255              
256             =head1 SEE ALSO
257              
258             This class forms part of L<Paws>, documenting arguments for method ModifyDBCluster in L<Paws::RDS>
259              
260             =head1 BUGS and CONTRIBUTIONS
261              
262             The source code is located here: https://github.com/pplu/aws-sdk-perl
263              
264             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
265              
266             =cut
267