blib/lib/Paws/Neptune/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::Neptune::DescribeDBClusters;
3 use Moose;
4 has DBClusterIdentifier => (is => 'ro', isa => 'Str');
5 has Filters => (is => 'ro', isa => 'ArrayRef[Paws::Neptune::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::Neptune::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::Neptune::DescribeDBClusters - Arguments for method DescribeDBClusters on L<Paws::Neptune>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method DescribeDBClusters on the
25 L<Amazon Neptune|Paws::Neptune> 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('Neptune');
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::Neptune::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-supplied DB cluster identifier. If this parameter is
62 specified, information from only the specific DB cluster is returned.
63 This parameter isn't case-sensitive.
64  
65 Constraints:
66  
67 =over
68  
69 =item *
70  
71 If supplied, must match an existing DBClusterIdentifier.
72  
73 =back
74  
75  
76  
77  
78 =head2 Filters => ArrayRef[L<Paws::Neptune::Filter>]
79  
80 A filter that specifies one or more DB clusters to describe.
81  
82 Supported filters:
83  
84 =over
85  
86 =item *
87  
88 C<db-cluster-id> - Accepts DB cluster identifiers and DB cluster Amazon
89 Resource Names (ARNs). The results list will only include information
90 about the DB clusters identified by these ARNs.
91  
92 =item *
93  
94 C<engine> - Accepts an engine name (such as C<neptune>), and restricts
95 the results list to DB clusters created by that engine.
96  
97 =back
98  
99 For example, to invoke this API from the Amazon CLI and filter so that
100 only Neptune DB clusters are returned, you could use the following
101 command:
102  
103  
104  
105 =head2 Marker => Str
106  
107 An optional pagination token provided by a previous DescribeDBClusters
108 request. If this parameter is specified, the response includes only
109 records beyond the marker, up to the value specified by C<MaxRecords>.
110  
111  
112  
113 =head2 MaxRecords => Int
114  
115 The maximum number of records to include in the response. If more
116 records exist than the specified C<MaxRecords> value, a pagination
117 token called a marker is included in the response so that the remaining
118 results can be retrieved.
119  
120 Default: 100
121  
122 Constraints: Minimum 20, maximum 100.
123  
124  
125  
126  
127 =head1 SEE ALSO
128  
129 This class forms part of L<Paws>, documenting arguments for method DescribeDBClusters in L<Paws::Neptune>
130  
131 =head1 BUGS and CONTRIBUTIONS
132  
133 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
134  
135 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
136  
137 =cut
138