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

filter: Statementstmt 0.0% 0 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 15 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::DocDB::DescribeDBClusters;
3 use Moose;
4 has DBClusterIdentifier => (is => 'ro', isa => 'Str');
5 has Filters => (is => 'ro', isa => 'ArrayRef[Paws::DocDB::Filter]');
6 has Marker => (is => 'ro', isa => 'Str');
7 has MaxRecords => (is => 'ro', isa => 'Int');
8  
9 use MooseX::ClassAttribute;
10  
11 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDBClusters');
12 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DocDB::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::DocDB::DescribeDBClusters - Arguments for method DescribeDBClusters on L<Paws::DocDB>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method DescribeDBClusters on the
25 L<Amazon DocumentDB with MongoDB compatibility|Paws::DocDB> 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 =head1 SYNOPSIS
31  
32 my $rds = Paws->service('DocDB');
33 my $DBClusterMessage = $rds->DescribeDBClusters(
34 DBClusterIdentifier => 'MyString', # OPTIONAL
35 Filters => [
36 {
37 Name => 'MyString',
38 Values => [ 'MyString', ... ],
39  
40 },
41 ...
42 ], # OPTIONAL
43 Marker => 'MyString', # OPTIONAL
44 MaxRecords => 1, # OPTIONAL
45 );
46  
47 # Results:
48 my $DBClusters = $DBClusterMessage->DBClusters;
49 my $Marker = $DBClusterMessage->Marker;
50  
51 # Returns a L<Paws::DocDB::DBClusterMessage> object.
52  
53 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.
54 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeDBClusters>
55  
56 =head1 ATTRIBUTES
57  
58  
59 =head2 DBClusterIdentifier => Str
60  
61 The user-provided cluster identifier. If this parameter is specified,
62 information from only the specific cluster is returned. This parameter
63 isn't case sensitive.
64  
65 Constraints:
66  
67 =over
68  
69 =item *
70  
71 If provided, must match an existing C<DBClusterIdentifier>.
72  
73 =back
74  
75  
76  
77  
78 =head2 Filters => ArrayRef[L<Paws::DocDB::Filter>]
79  
80 A filter that specifies one or more clusters to describe.
81  
82 Supported filters:
83  
84 =over
85  
86 =item *
87  
88 C<db-cluster-id> - Accepts cluster identifiers and cluster Amazon
89 Resource Names (ARNs). The results list only includes information about
90 the clusters identified by these ARNs.
91  
92 =back
93  
94  
95  
96  
97 =head2 Marker => Str
98  
99 An optional pagination token provided by a previous request. If this
100 parameter is specified, the response includes only records beyond the
101 marker, up to the value specified by C<MaxRecords>.
102  
103  
104  
105 =head2 MaxRecords => Int
106  
107 The maximum number of records to include in the response. If more
108 records exist than the specified C<MaxRecords> value, a pagination
109 token (marker) is included in the response so that the remaining
110 results can be retrieved.
111  
112 Default: 100
113  
114 Constraints: Minimum 20, maximum 100.
115  
116  
117  
118  
119 =head1 SEE ALSO
120  
121 This class forms part of L<Paws>, documenting arguments for method DescribeDBClusters in L<Paws::DocDB>
122  
123 =head1 BUGS and CONTRIBUTIONS
124  
125 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
126  
127 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
128  
129 =cut
130