File Coverage

blib/lib/Paws/RDS/DescribeDBInstances.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::RDS::DescribeDBInstances;
3 1     1   321 use Moose;
  1     1   3  
  1         8  
  1         407  
  1         1  
  1         9  
4             has DBInstanceIdentifier => (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   5345 use MooseX::ClassAttribute;
  1     1   3  
  1         7  
  1         6637  
  1         2  
  1         9  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDBInstances');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::DBInstanceMessage');
13             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeDBInstancesResult');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::RDS::DescribeDBInstances - Arguments for method DescribeDBInstances on Paws::RDS
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method DescribeDBInstances on the
25             Amazon Relational Database Service service. Use the attributes of this class
26             as arguments to method DescribeDBInstances.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBInstances.
29              
30             As an example:
31              
32             $service_obj->DescribeDBInstances(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 DBInstanceIdentifier => Str
40              
41             The user-supplied instance identifier. If this parameter is specified,
42             information from only the specific DB instance is returned. This
43             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 instances 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 instances associated with the DB Clusters identified by
79             these ARNs.
80              
81             =item *
82              
83             C<db-instance-id> - Accepts DB instance identifiers and DB instance
84             Amazon Resource Names (ARNs). The results list will only include
85             information about the DB instances identified by these ARNs.
86              
87             =back
88              
89              
90              
91              
92             =head2 Marker => Str
93              
94             An optional pagination token provided by a previous
95             C<DescribeDBInstances> 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 that the remaining
106             results can be retrieved.
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 DescribeDBInstances in L<Paws::RDS>
118              
119             =head1 BUGS and CONTRIBUTIONS
120              
121             The source code is located here: https://github.com/pplu/aws-sdk-perl
122              
123             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
124              
125             =cut
126