File Coverage

blib/lib/Paws/RedShift/DescribeClusterParameters.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::RedShift::DescribeClusterParameters;
3 1     1   830 use Moose;
  1     1   5  
  1         13  
  1         530  
  1         2  
  1         7  
4             has Marker => (is => 'ro', isa => 'Str');
5             has MaxRecords => (is => 'ro', isa => 'Int');
6             has ParameterGroupName => (is => 'ro', isa => 'Str', required => 1);
7             has Source => (is => 'ro', isa => 'Str');
8              
9 1     1   10941 use MooseX::ClassAttribute;
  1     1   4  
  1         12  
  1         6524  
  1         3  
  1         6  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeClusterParameters');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::ClusterParameterGroupDetails');
13             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeClusterParametersResult');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::RedShift::DescribeClusterParameters - Arguments for method DescribeClusterParameters on Paws::RedShift
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method DescribeClusterParameters on the
25             Amazon Redshift service. Use the attributes of this class
26             as arguments to method DescribeClusterParameters.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeClusterParameters.
29              
30             As an example:
31              
32             $service_obj->DescribeClusterParameters(Att1 => $value1, Att2 => $value2, ...);
33              
34             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.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 Marker => Str
40              
41             An optional parameter that specifies the starting point to return a set
42             of response records. When the results of a DescribeClusterParameters
43             request exceed the value specified in C<MaxRecords>, AWS returns a
44             value in the C<Marker> field of the response. You can retrieve the next
45             set of response records by providing the returned marker value in the
46             C<Marker> parameter and retrying the request.
47              
48              
49              
50             =head2 MaxRecords => Int
51              
52             The maximum number of response records to return in each call. If the
53             number of remaining response records exceeds the specified
54             C<MaxRecords> value, a value is returned in a C<marker> field of the
55             response. You can retrieve the next set of records by retrying the
56             command with the returned marker value.
57              
58             Default: C<100>
59              
60             Constraints: minimum 20, maximum 100.
61              
62              
63              
64             =head2 B<REQUIRED> ParameterGroupName => Str
65              
66             The name of a cluster parameter group for which to return details.
67              
68              
69              
70             =head2 Source => Str
71              
72             The parameter types to return. Specify C<user> to show parameters that
73             are different form the default. Similarly, specify C<engine-default> to
74             show parameters that are the same as the default parameter group.
75              
76             Default: All parameter types returned.
77              
78             Valid Values: C<user> | C<engine-default>
79              
80              
81              
82              
83             =head1 SEE ALSO
84              
85             This class forms part of L<Paws>, documenting arguments for method DescribeClusterParameters in L<Paws::RedShift>
86              
87             =head1 BUGS and CONTRIBUTIONS
88              
89             The source code is located here: https://github.com/pplu/aws-sdk-perl
90              
91             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
92              
93             =cut
94