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

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