File Coverage

blib/lib/Paws/RDS/DescribeDBClusters.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::DescribeDBClusters;
3 1     1   643 use Moose;
  1         4  
  1         15  
4             has DBClusterIdentifier => (is => 'ro', isa => 'Str');
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              
9 1     1   6987 use MooseX::ClassAttribute;
  1         3  
  1         11  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDBClusters');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::DBClusterMessage');
13             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeDBClustersResult');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::RDS::DescribeDBClusters - Arguments for method DescribeDBClusters on Paws::RDS
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method DescribeDBClusters on the
25             Amazon Relational Database Service service. Use the attributes of this class
26             as arguments to method DescribeDBClusters.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBClusters.
29              
30             As an example:
31              
32             $service_obj->DescribeDBClusters(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 DBClusterIdentifier => Str
40              
41             The user-supplied DB cluster identifier. If this parameter is
42             specified, information from only the specific DB cluster is returned.
43             This parameter isn't case-sensitive.
44              
45             Constraints:
46              
47             =over
48              
49             =item *
50              
51             Must contain from 1 to 63 alphanumeric characters or hyphens
52              
53             =item *
54              
55             First character must be a letter
56              
57             =item *
58              
59             Cannot end with a hyphen or contain two consecutive hyphens
60              
61             =back
62              
63              
64              
65              
66             =head2 Filters => ArrayRef[L<Paws::RDS::Filter>]
67              
68             A filter that specifies one or more DB clusters to describe.
69              
70             Supported filters:
71              
72             =over
73              
74             =item *
75              
76             C<db-cluster-id> - Accepts DB cluster identifiers and DB cluster Amazon
77             Resource Names (ARNs). The results list will only include information
78             about the DB clusters identified by these ARNs.
79              
80             =back
81              
82              
83              
84              
85             =head2 Marker => Str
86              
87             An optional pagination token provided by a previous DescribeDBClusters
88             request. If this parameter is specified, the response includes only
89             records beyond the marker, up to the value specified by C<MaxRecords>.
90              
91              
92              
93             =head2 MaxRecords => Int
94              
95             The maximum number of records to include in the response. If more
96             records exist than the specified C<MaxRecords> value, a pagination
97             token called a marker is included in the response so that the remaining
98             results can be retrieved.
99              
100             Default: 100
101              
102             Constraints: Minimum 20, maximum 100.
103              
104              
105              
106              
107             =head1 SEE ALSO
108              
109             This class forms part of L<Paws>, documenting arguments for method DescribeDBClusters in L<Paws::RDS>
110              
111             =head1 BUGS and CONTRIBUTIONS
112              
113             The source code is located here: https://github.com/pplu/aws-sdk-perl
114              
115             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
116              
117             =cut
118