blib/lib/Paws/DocDB/ModifyDBInstance.pm untested

filter: Statementstmt 0.0% 0 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 19 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::DocDB::ModifyDBInstance;
3 use Moose;
4 has ApplyImmediately => (is => 'ro', isa => 'Bool');
5 has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool');
6 has CACertificateIdentifier => (is => 'ro', isa => 'Str');
7 has DBInstanceClass => (is => 'ro', isa => 'Str');
8 has DBInstanceIdentifier => (is => 'ro', isa => 'Str', required => 1);
9 has NewDBInstanceIdentifier => (is => 'ro', isa => 'Str');
10 has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
11 has PromotionTier => (is => 'ro', isa => 'Int');
12  
13 use MooseX::ClassAttribute;
14  
15 class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyDBInstance');
16 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DocDB::ModifyDBInstanceResult');
17 class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyDBInstanceResult');
18 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::DocDB::ModifyDBInstance - Arguments for method ModifyDBInstance on L<Paws::DocDB>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method ModifyDBInstance on the
29 L<Amazon DocumentDB with MongoDB compatibility|Paws::DocDB> service. Use the attributes of this class
30 as arguments to method ModifyDBInstance.
31  
32 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyDBInstance.
33  
34 =head1 SYNOPSIS
35  
36 my $rds = Paws->service('DocDB');
37 my $ModifyDBInstanceResult = $rds->ModifyDBInstance(
38 DBInstanceIdentifier => 'MyString',
39 ApplyImmediately => 1, # OPTIONAL
40 AutoMinorVersionUpgrade => 1, # OPTIONAL
41 CACertificateIdentifier => 'MyString', # OPTIONAL
42 DBInstanceClass => 'MyString', # OPTIONAL
43 NewDBInstanceIdentifier => 'MyString', # OPTIONAL
44 PreferredMaintenanceWindow => 'MyString', # OPTIONAL
45 PromotionTier => 1, # OPTIONAL
46 );
47  
48 # Results:
49 my $DBInstance = $ModifyDBInstanceResult->DBInstance;
50  
51 # Returns a L<Paws::DocDB::ModifyDBInstanceResult> object.
52  
53 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.
54 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/ModifyDBInstance>
55  
56 =head1 ATTRIBUTES
57  
58  
59 =head2 ApplyImmediately => Bool
60  
61 Specifies whether the modifications in this request and any pending
62 modifications are asynchronously applied as soon as possible,
63 regardless of the C<PreferredMaintenanceWindow> setting for the
64 instance.
65  
66 If this parameter is set to C<false>, changes to the instance are
67 applied during the next maintenance window. Some parameter changes can
68 cause an outage and are applied on the next reboot.
69  
70 Default: C<false>
71  
72  
73  
74 =head2 AutoMinorVersionUpgrade => Bool
75  
76 This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB
77 does not perform minor version upgrades regardless of the value set.
78  
79  
80  
81 =head2 CACertificateIdentifier => Str
82  
83 Indicates the certificate that needs to be associated with the
84 instance.
85  
86  
87  
88 =head2 DBInstanceClass => Str
89  
90 The new compute and memory capacity of the instance; for example,
91 C<db.r5.large>. Not all instance classes are available in all Regions.
92  
93 If you modify the instance class, an outage occurs during the change.
94 The change is applied during the next maintenance window, unless
95 C<ApplyImmediately> is specified as C<true> for this request.
96  
97 Default: Uses existing setting.
98  
99  
100  
101 =head2 B<REQUIRED> DBInstanceIdentifier => Str
102  
103 The instance identifier. This value is stored as a lowercase string.
104  
105 Constraints:
106  
107 =over
108  
109 =item *
110  
111 Must match the identifier of an existing C<DBInstance>.
112  
113 =back
114  
115  
116  
117  
118 =head2 NewDBInstanceIdentifier => Str
119  
120 The new instance identifier for the instance when renaming an instance.
121 When you change the instance identifier, an instance reboot occurs
122 immediately if you set C<Apply Immediately> to C<true>. It occurs
123 during the next maintenance window if you set C<Apply Immediately> to
124 C<false>. This value is stored as a lowercase string.
125  
126 Constraints:
127  
128 =over
129  
130 =item *
131  
132 Must contain from 1 to 63 letters, numbers, or hyphens.
133  
134 =item *
135  
136 The first character must be a letter.
137  
138 =item *
139  
140 Cannot end with a hyphen or contain two consecutive hyphens.
141  
142 =back
143  
144 Example: C<mydbinstance>
145  
146  
147  
148 =head2 PreferredMaintenanceWindow => Str
149  
150 The weekly time range (in UTC) during which system maintenance can
151 occur, which might result in an outage. Changing this parameter doesn't
152 result in an outage except in the following situation, and the change
153 is asynchronously applied as soon as possible. If there are pending
154 actions that cause a reboot, and the maintenance window is changed to
155 include the current time, changing this parameter causes a reboot of
156 the instance. If you are moving this window to the current time, there
157 must be at least 30 minutes between the current time and end of the
158 window to ensure that pending changes are applied.
159  
160 Default: Uses existing setting.
161  
162 Format: C<ddd:hh24:mi-ddd:hh24:mi>
163  
164 Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
165  
166 Constraints: Must be at least 30 minutes.
167  
168  
169  
170 =head2 PromotionTier => Int
171  
172 A value that specifies the order in which an Amazon DocumentDB replica
173 is promoted to the primary instance after a failure of the existing
174 primary instance.
175  
176 Default: 1
177  
178 Valid values: 0-15
179  
180  
181  
182  
183 =head1 SEE ALSO
184  
185 This class forms part of L<Paws>, documenting arguments for method ModifyDBInstance in L<Paws::DocDB>
186  
187 =head1 BUGS and CONTRIBUTIONS
188  
189 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
190  
191 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
192  
193 =cut
194