File Coverage

blib/lib/Paws/RDS/DescribeDBParameters.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::DescribeDBParameters;
3 1     1   774 use Moose;
  1         5  
  1         13  
4             has DBParameterGroupName => (is => 'ro', isa => 'Str', required => 1);
5             has Filters => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Filter]');
6             has Marker => (is => 'ro', isa => 'Str');
7             has MaxRecords => (is => 'ro', isa => 'Int');
8             has Source => (is => 'ro', isa => 'Str');
9              
10 1     1   9136 use MooseX::ClassAttribute;
  1         3  
  1         14  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDBParameters');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::DBParameterGroupDetails');
14             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeDBParametersResult');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::RDS::DescribeDBParameters - Arguments for method DescribeDBParameters on Paws::RDS
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method DescribeDBParameters on the
26             Amazon Relational Database Service service. Use the attributes of this class
27             as arguments to method DescribeDBParameters.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBParameters.
30              
31             As an example:
32              
33             $service_obj->DescribeDBParameters(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 B<REQUIRED> DBParameterGroupName => Str
41              
42             The name of a specific DB parameter group to return details for.
43              
44             Constraints:
45              
46             =over
47              
48             =item *
49              
50             Must be 1 to 255 alphanumeric characters
51              
52             =item *
53              
54             First character must be a letter
55              
56             =item *
57              
58             Cannot end with a hyphen or contain two consecutive hyphens
59              
60             =back
61              
62              
63              
64              
65             =head2 Filters => ArrayRef[L<Paws::RDS::Filter>]
66              
67             This parameter is not currently supported.
68              
69              
70              
71             =head2 Marker => Str
72              
73             An optional pagination token provided by a previous
74             C<DescribeDBParameters> request. If this parameter is specified, the
75             response includes only records beyond the marker, up to the value
76             specified by C<MaxRecords>.
77              
78              
79              
80             =head2 MaxRecords => Int
81              
82             The maximum number of records to include in the response. If more
83             records exist than the specified C<MaxRecords> value, a pagination
84             token called a marker is included in the response so that the remaining
85             results can be retrieved.
86              
87             Default: 100
88              
89             Constraints: Minimum 20, maximum 100.
90              
91              
92              
93             =head2 Source => Str
94              
95             The parameter types to return.
96              
97             Default: All parameter types returned
98              
99             Valid Values: C<user | system | engine-default>
100              
101              
102              
103              
104             =head1 SEE ALSO
105              
106             This class forms part of L<Paws>, documenting arguments for method DescribeDBParameters in L<Paws::RDS>
107              
108             =head1 BUGS and CONTRIBUTIONS
109              
110             The source code is located here: https://github.com/pplu/aws-sdk-perl
111              
112             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
113              
114             =cut
115