blib/lib/Paws/RDS/DescribeDBEngineVersions.pm

filter: Statementstmt 100% 20 / 20 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 22 / 22 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/RDS/DBSubnetGroupMessage.pm ↑ Summary blib/lib/Paws/RDS/DescribeDBInstances.pm »
1  
2 package Paws::RDS::DescribeDBEngineVersions;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has DBParameterGroupFamily => (is => 'ro', isa => 'Str');
5 1 has DefaultOnly => (is => 'ro', isa => 'Bool');
6 1 has Engine => (is => 'ro', isa => 'Str');
7 1 has EngineVersion => (is => 'ro', isa => 'Str');
8 1 has Filters => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Filter]');
9 1 has IncludeAll => (is => 'ro', isa => 'Bool');
10 1 has ListSupportedCharacterSets => (is => 'ro', isa => 'Bool');
11 1 has ListSupportedTimezones => (is => 'ro', isa => 'Bool');
12 1 has Marker => (is => 'ro', isa => 'Str');
13 1 has MaxRecords => (is => 'ro', isa => 'Int');
14  
15 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
16  
17 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDBEngineVersions');
18 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::DBEngineVersionMessage');
19 1 class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeDBEngineVersionsResult');
20 1 1;
21  
22 ### main pod documentation begin ###
23  
24 =head1 NAME
25  
26 Paws::RDS::DescribeDBEngineVersions - Arguments for method DescribeDBEngineVersions on L<Paws::RDS>
27  
28 =head1 DESCRIPTION
29  
30 This class represents the parameters used for calling the method DescribeDBEngineVersions on the
31 L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class
32 as arguments to method DescribeDBEngineVersions.
33  
34 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBEngineVersions.
35  
36 =head1 SYNOPSIS
37  
38 my $rds = Paws->service('RDS');
39 # To list DB engine version settings
40 # This example lists settings for the specified DB engine version.
41 my $DBEngineVersionMessage = $rds->DescribeDBEngineVersions(
42 'DBParameterGroupFamily' => 'mysql5.6',
43 'DefaultOnly' => 1,
44 'Engine' => 'mysql',
45 'EngineVersion' => 5.6,
46 'ListSupportedCharacterSets' => 1
47 );
48  
49  
50 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.
51 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeDBEngineVersions>
52  
53 =head1 ATTRIBUTES
54  
55  
56 =head2 DBParameterGroupFamily => Str
57  
58 The name of a specific DB parameter group family to return details for.
59  
60 Constraints:
61  
62 =over
63  
64 =item *
65  
66 If supplied, must match an existing DBParameterGroupFamily.
67  
68 =back
69  
70  
71  
72  
73 =head2 DefaultOnly => Bool
74  
75 A value that indicates whether only the default version of the
76 specified engine or engine and major version combination is returned.
77  
78  
79  
80 =head2 Engine => Str
81  
82 The database engine to return.
83  
84 Valid Values:
85  
86 =over
87  
88 =item *
89  
90 C<aurora> (for MySQL 5.6-compatible Aurora)
91  
92 =item *
93  
94 C<aurora-mysql> (for MySQL 5.7-compatible Aurora)
95  
96 =item *
97  
98 C<aurora-postgresql>
99  
100 =item *
101  
102 C<mariadb>
103  
104 =item *
105  
106 C<mysql>
107  
108 =item *
109  
110 C<oracle-ee>
111  
112 =item *
113  
114 C<oracle-ee-cdb>
115  
116 =item *
117  
118 C<oracle-se2>
119  
120 =item *
121  
122 C<oracle-se2-cdb>
123  
124 =item *
125  
126 C<postgres>
127  
128 =item *
129  
130 C<sqlserver-ee>
131  
132 =item *
133  
134 C<sqlserver-se>
135  
136 =item *
137  
138 C<sqlserver-ex>
139  
140 =item *
141  
142 C<sqlserver-web>
143  
144 =back
145  
146  
147  
148  
149 =head2 EngineVersion => Str
150  
151 The database engine version to return.
152  
153 Example: C<5.1.49>
154  
155  
156  
157 =head2 Filters => ArrayRef[L<Paws::RDS::Filter>]
158  
159 This parameter isn't currently supported.
160  
161  
162  
163 =head2 IncludeAll => Bool
164  
165 A value that indicates whether to include engine versions that aren't
166 available in the list. The default is to list only available engine
167 versions.
168  
169  
170  
171 =head2 ListSupportedCharacterSets => Bool
172  
173 A value that indicates whether to list the supported character sets for
174 each engine version.
175  
176 If this parameter is enabled and the requested engine supports the
177 C<CharacterSetName> parameter for C<CreateDBInstance>, the response
178 includes a list of supported character sets for each engine version.
179  
180  
181  
182 =head2 ListSupportedTimezones => Bool
183  
184 A value that indicates whether to list the supported time zones for
185 each engine version.
186  
187 If this parameter is enabled and the requested engine supports the
188 C<TimeZone> parameter for C<CreateDBInstance>, the response includes a
189 list of supported time zones for each engine version.
190  
191  
192  
193 =head2 Marker => Str
194  
195 An optional pagination token provided by a previous request. If this
196 parameter is specified, the response includes only records beyond the
197 marker, up to the value specified by C<MaxRecords>.
198  
199  
200  
201 =head2 MaxRecords => Int
202  
203 The maximum number of records to include in the response. If more than
204 the C<MaxRecords> value is available, a pagination token called a
205 marker is included in the response so you can retrieve the remaining
206 results.
207  
208 Default: 100
209  
210 Constraints: Minimum 20, maximum 100.
211  
212  
213  
214  
215 =head1 SEE ALSO
216  
217 This class forms part of L<Paws>, documenting arguments for method DescribeDBEngineVersions in L<Paws::RDS>
218  
219 =head1 BUGS and CONTRIBUTIONS
220  
221 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
222  
223 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
224  
225 =cut
226  
« blib/lib/Paws/RDS/DBSubnetGroupMessage.pm ↑ Summary blib/lib/Paws/RDS/DescribeDBInstances.pm »