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

filter: Statementstmt 0.0% 0 / 18 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 20 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::DocDB::CreateDBInstance;
3 use Moose;
4 has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool');
5 has AvailabilityZone => (is => 'ro', isa => 'Str');
6 has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1);
7 has DBInstanceClass => (is => 'ro', isa => 'Str', required => 1);
8 has DBInstanceIdentifier => (is => 'ro', isa => 'Str', required => 1);
9 has Engine => (is => 'ro', isa => 'Str', required => 1);
10 has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
11 has PromotionTier => (is => 'ro', isa => 'Int');
12 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::DocDB::Tag]');
13  
14 use MooseX::ClassAttribute;
15  
16 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDBInstance');
17 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DocDB::CreateDBInstanceResult');
18 class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateDBInstanceResult');
19 1;
20  
21 ### main pod documentation begin ###
22  
23 =head1 NAME
24  
25 Paws::DocDB::CreateDBInstance - Arguments for method CreateDBInstance on L<Paws::DocDB>
26  
27 =head1 DESCRIPTION
28  
29 This class represents the parameters used for calling the method CreateDBInstance on the
30 L<Amazon DocumentDB with MongoDB compatibility|Paws::DocDB> service. Use the attributes of this class
31 as arguments to method CreateDBInstance.
32  
33 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDBInstance.
34  
35 =head1 SYNOPSIS
36  
37 my $rds = Paws->service('DocDB');
38 my $CreateDBInstanceResult = $rds->CreateDBInstance(
39 DBClusterIdentifier => 'MyString',
40 DBInstanceClass => 'MyString',
41 DBInstanceIdentifier => 'MyString',
42 Engine => 'MyString',
43 AutoMinorVersionUpgrade => 1, # OPTIONAL
44 AvailabilityZone => 'MyString', # OPTIONAL
45 PreferredMaintenanceWindow => 'MyString', # OPTIONAL
46 PromotionTier => 1, # OPTIONAL
47 Tags => [
48 {
49 Key => 'MyString',
50 Value => 'MyString',
51 },
52 ...
53 ], # OPTIONAL
54 );
55  
56 # Results:
57 my $DBInstance = $CreateDBInstanceResult->DBInstance;
58  
59 # Returns a L<Paws::DocDB::CreateDBInstanceResult> object.
60  
61 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.
62 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/CreateDBInstance>
63  
64 =head1 ATTRIBUTES
65  
66  
67 =head2 AutoMinorVersionUpgrade => Bool
68  
69 This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB
70 does not perform minor version upgrades regardless of the value set.
71  
72 Default: C<false>
73  
74  
75  
76 =head2 AvailabilityZone => Str
77  
78 The Amazon EC2 Availability Zone that the instance is created in.
79  
80 Default: A random, system-chosen Availability Zone in the endpoint's
81 Region.
82  
83 Example: C<us-east-1d>
84  
85  
86  
87 =head2 B<REQUIRED> DBClusterIdentifier => Str
88  
89 The identifier of the cluster that the instance will belong to.
90  
91  
92  
93 =head2 B<REQUIRED> DBInstanceClass => Str
94  
95 The compute and memory capacity of the instance; for example,
96 C<db.r5.large>.
97  
98  
99  
100 =head2 B<REQUIRED> DBInstanceIdentifier => Str
101  
102 The instance identifier. This parameter is stored as a lowercase
103 string.
104  
105 Constraints:
106  
107 =over
108  
109 =item *
110  
111 Must contain from 1 to 63 letters, numbers, or hyphens.
112  
113 =item *
114  
115 The first character must be a letter.
116  
117 =item *
118  
119 Cannot end with a hyphen or contain two consecutive hyphens.
120  
121 =back
122  
123 Example: C<mydbinstance>
124  
125  
126  
127 =head2 B<REQUIRED> Engine => Str
128  
129 The name of the database engine to be used for this instance.
130  
131 Valid value: C<docdb>
132  
133  
134  
135 =head2 PreferredMaintenanceWindow => Str
136  
137 The time range each week during which system maintenance can occur, in
138 Universal Coordinated Time (UTC).
139  
140 Format: C<ddd:hh24:mi-ddd:hh24:mi>
141  
142 The default is a 30-minute window selected at random from an 8-hour
143 block of time for each Region, occurring on a random day of the week.
144  
145 Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
146  
147 Constraints: Minimum 30-minute window.
148  
149  
150  
151 =head2 PromotionTier => Int
152  
153 A value that specifies the order in which an Amazon DocumentDB replica
154 is promoted to the primary instance after a failure of the existing
155 primary instance.
156  
157 Default: 1
158  
159 Valid values: 0-15
160  
161  
162  
163 =head2 Tags => ArrayRef[L<Paws::DocDB::Tag>]
164  
165 The tags to be assigned to the instance. You can assign up to 10 tags
166 to an instance.
167  
168  
169  
170  
171 =head1 SEE ALSO
172  
173 This class forms part of L<Paws>, documenting arguments for method CreateDBInstance in L<Paws::DocDB>
174  
175 =head1 BUGS and CONTRIBUTIONS
176  
177 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
178  
179 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
180  
181 =cut
182