blib/lib/Paws/Lightsail/CreateRelationalDatabase.pm untested

filter: Statementstmt 0.0% 0 / 31 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 33 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Lightsail::CreateRelationalDatabase;
3 use Moose;
4 has AvailabilityZone => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'availabilityZone' );
5 has MasterDatabaseName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'masterDatabaseName' , required => 1);
6 has MasterUsername => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'masterUsername' , required => 1);
7 has MasterUserPassword => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'masterUserPassword' );
8 has PreferredBackupWindow => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'preferredBackupWindow' );
9 has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'preferredMaintenanceWindow' );
10 has PubliclyAccessible => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'publiclyAccessible' );
11 has RelationalDatabaseBlueprintId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'relationalDatabaseBlueprintId' , required => 1);
12 has RelationalDatabaseBundleId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'relationalDatabaseBundleId' , required => 1);
13 has RelationalDatabaseName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'relationalDatabaseName' , required => 1);
14 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Lightsail::Tag]', traits => ['NameInRequest'], request_name => 'tags' );
15  
16 use MooseX::ClassAttribute;
17  
18 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateRelationalDatabase');
19 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Lightsail::CreateRelationalDatabaseResult');
20 class_has _result_key => (isa => 'Str', is => 'ro');
21 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::Lightsail::CreateRelationalDatabase - Arguments for method CreateRelationalDatabase on L<Paws::Lightsail>
28  
29 =head1 DESCRIPTION
30  
31 This class represents the parameters used for calling the method CreateRelationalDatabase on the
32 L<Amazon Lightsail|Paws::Lightsail> service. Use the attributes of this class
33 as arguments to method CreateRelationalDatabase.
34  
35 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateRelationalDatabase.
36  
37 =head1 SYNOPSIS
38  
39 my $lightsail = Paws->service('Lightsail');
40 my $CreateRelationalDatabaseResult = $lightsail->CreateRelationalDatabase(
41 MasterDatabaseName => 'Mystring',
42 MasterUsername => 'Mystring',
43 RelationalDatabaseBlueprintId => 'Mystring',
44 RelationalDatabaseBundleId => 'Mystring',
45 RelationalDatabaseName => 'MyResourceName',
46 AvailabilityZone => 'Mystring', # OPTIONAL
47 MasterUserPassword => 'MySensitiveString', # OPTIONAL
48 PreferredBackupWindow => 'Mystring', # OPTIONAL
49 PreferredMaintenanceWindow => 'Mystring', # OPTIONAL
50 PubliclyAccessible => 1, # OPTIONAL
51 Tags => [
52 {
53 Key => 'MyTagKey', # OPTIONAL
54 Value => 'MyTagValue', # OPTIONAL
55 },
56 ...
57 ], # OPTIONAL
58 );
59  
60 # Results:
61 my $Operations = $CreateRelationalDatabaseResult->Operations;
62  
63 # Returns a L<Paws::Lightsail::CreateRelationalDatabaseResult> object.
64  
65 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.
66 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lightsail/CreateRelationalDatabase>
67  
68 =head1 ATTRIBUTES
69  
70  
71 =head2 AvailabilityZone => Str
72  
73 The Availability Zone in which to create your new database. Use the
74 C<us-east-2a> case-sensitive format.
75  
76 You can get a list of Availability Zones by using the C<get regions>
77 operation. Be sure to add the C<include relational database
78 Availability Zones> parameter to your request.
79  
80  
81  
82 =head2 B<REQUIRED> MasterDatabaseName => Str
83  
84 The meaning of this parameter differs according to the database engine
85 you use.
86  
87 B<MySQL>
88  
89 The name of the database to create when the Lightsail database resource
90 is created. If this parameter isn't specified, no database is created
91 in the database resource.
92  
93 Constraints:
94  
95 =over
96  
97 =item *
98  
99 Must contain 1 to 64 letters or numbers.
100  
101 =item *
102  
103 Must begin with a letter. Subsequent characters can be letters,
104 underscores, or digits (0- 9).
105  
106 =item *
107  
108 Can't be a word reserved by the specified database engine.
109  
110 For more information about reserved words in MySQL, see the Keywords
111 and Reserved Words articles for MySQL 5.6
112 (https://dev.mysql.com/doc/refman/5.6/en/keywords.html), MySQL 5.7
113 (https://dev.mysql.com/doc/refman/5.7/en/keywords.html), and MySQL 8.0
114 (https://dev.mysql.com/doc/refman/8.0/en/keywords.html).
115  
116 =back
117  
118 B<PostgreSQL>
119  
120 The name of the database to create when the Lightsail database resource
121 is created. If this parameter isn't specified, a database named
122 C<postgres> is created in the database resource.
123  
124 Constraints:
125  
126 =over
127  
128 =item *
129  
130 Must contain 1 to 63 letters or numbers.
131  
132 =item *
133  
134 Must begin with a letter. Subsequent characters can be letters,
135 underscores, or digits (0- 9).
136  
137 =item *
138  
139 Can't be a word reserved by the specified database engine.
140  
141 For more information about reserved words in PostgreSQL, see the SQL
142 Key Words articles for PostgreSQL 9.6
143 (https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html),
144 PostgreSQL 10
145 (https://www.postgresql.org/docs/10/sql-keywords-appendix.html),
146 PostgreSQL 11
147 (https://www.postgresql.org/docs/11/sql-keywords-appendix.html), and
148 PostgreSQL 12
149 (https://www.postgresql.org/docs/12/sql-keywords-appendix.html).
150  
151 =back
152  
153  
154  
155  
156 =head2 B<REQUIRED> MasterUsername => Str
157  
158 The name for the master user.
159  
160 B<MySQL>
161  
162 Constraints:
163  
164 =over
165  
166 =item *
167  
168 Required for MySQL.
169  
170 =item *
171  
172 Must be 1 to 16 letters or numbers. Can contain underscores.
173  
174 =item *
175  
176 First character must be a letter.
177  
178 =item *
179  
180 Can't be a reserved word for the chosen database engine.
181  
182 For more information about reserved words in MySQL 5.6 or 5.7, see the
183 Keywords and Reserved Words articles for MySQL 5.6
184 (https://dev.mysql.com/doc/refman/5.6/en/keywords.html), MySQL 5.7
185 (https://dev.mysql.com/doc/refman/5.7/en/keywords.html), or MySQL 8.0
186 (https://dev.mysql.com/doc/refman/8.0/en/keywords.html).
187  
188 =back
189  
190 B<PostgreSQL>
191  
192 Constraints:
193  
194 =over
195  
196 =item *
197  
198 Required for PostgreSQL.
199  
200 =item *
201  
202 Must be 1 to 63 letters or numbers. Can contain underscores.
203  
204 =item *
205  
206 First character must be a letter.
207  
208 =item *
209  
210 Can't be a reserved word for the chosen database engine.
211  
212 For more information about reserved words in MySQL 5.6 or 5.7, see the
213 Keywords and Reserved Words articles for PostgreSQL 9.6
214 (https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html),
215 PostgreSQL 10
216 (https://www.postgresql.org/docs/10/sql-keywords-appendix.html),
217 PostgreSQL 11
218 (https://www.postgresql.org/docs/11/sql-keywords-appendix.html), and
219 PostgreSQL 12
220 (https://www.postgresql.org/docs/12/sql-keywords-appendix.html).
221  
222 =back
223  
224  
225  
226  
227 =head2 MasterUserPassword => Str
228  
229 The password for the master user. The password can include any
230 printable ASCII character except "/", """, or "@". It cannot contain
231 spaces.
232  
233 B<MySQL>
234  
235 Constraints: Must contain from 8 to 41 characters.
236  
237 B<PostgreSQL>
238  
239 Constraints: Must contain from 8 to 128 characters.
240  
241  
242  
243 =head2 PreferredBackupWindow => Str
244  
245 The daily time range during which automated backups are created for
246 your new database if automated backups are enabled.
247  
248 The default is a 30-minute window selected at random from an 8-hour
249 block of time for each AWS Region. For more information about the
250 preferred backup window time blocks for each region, see the Working
251 With Backups
252 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow)
253 guide in the Amazon Relational Database Service (Amazon RDS)
254 documentation.
255  
256 Constraints:
257  
258 =over
259  
260 =item *
261  
262 Must be in the C<hh24:mi-hh24:mi> format.
263  
264 Example: C<16:00-16:30>
265  
266 =item *
267  
268 Specified in Coordinated Universal Time (UTC).
269  
270 =item *
271  
272 Must not conflict with the preferred maintenance window.
273  
274 =item *
275  
276 Must be at least 30 minutes.
277  
278 =back
279  
280  
281  
282  
283 =head2 PreferredMaintenanceWindow => Str
284  
285 The weekly time range during which system maintenance can occur on your
286 new database.
287  
288 The default is a 30-minute window selected at random from an 8-hour
289 block of time for each AWS Region, occurring on a random day of the
290 week.
291  
292 Constraints:
293  
294 =over
295  
296 =item *
297  
298 Must be in the C<ddd:hh24:mi-ddd:hh24:mi> format.
299  
300 =item *
301  
302 Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
303  
304 =item *
305  
306 Must be at least 30 minutes.
307  
308 =item *
309  
310 Specified in Coordinated Universal Time (UTC).
311  
312 =item *
313  
314 Example: C<Tue:17:00-Tue:17:30>
315  
316 =back
317  
318  
319  
320  
321 =head2 PubliclyAccessible => Bool
322  
323 Specifies the accessibility options for your new database. A value of
324 C<true> specifies a database that is available to resources outside of
325 your Lightsail account. A value of C<false> specifies a database that
326 is available only to your Lightsail resources in the same region as
327 your database.
328  
329  
330  
331 =head2 B<REQUIRED> RelationalDatabaseBlueprintId => Str
332  
333 The blueprint ID for your new database. A blueprint describes the major
334 engine version of a database.
335  
336 You can get a list of database blueprints IDs by using the C<get
337 relational database blueprints> operation.
338  
339  
340  
341 =head2 B<REQUIRED> RelationalDatabaseBundleId => Str
342  
343 The bundle ID for your new database. A bundle describes the performance
344 specifications for your database.
345  
346 You can get a list of database bundle IDs by using the C<get relational
347 database bundles> operation.
348  
349  
350  
351 =head2 B<REQUIRED> RelationalDatabaseName => Str
352  
353 The name to use for your new Lightsail database resource.
354  
355 Constraints:
356  
357 =over
358  
359 =item *
360  
361 Must contain from 2 to 255 alphanumeric characters, or hyphens.
362  
363 =item *
364  
365 The first and last character must be a letter or number.
366  
367 =back
368  
369  
370  
371  
372 =head2 Tags => ArrayRef[L<Paws::Lightsail::Tag>]
373  
374 The tag keys and optional values to add to the resource during create.
375  
376 Use the C<TagResource> action to tag a resource after it's created.
377  
378  
379  
380  
381 =head1 SEE ALSO
382  
383 This class forms part of L<Paws>, documenting arguments for method CreateRelationalDatabase in L<Paws::Lightsail>
384  
385 =head1 BUGS and CONTRIBUTIONS
386  
387 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
388  
389 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
390  
391 =cut
392