blib/lib/Paws/RDS/DescribeReservedDBInstances.pm

filter: Statementstmt 100% 21 / 21 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 23 / 23 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/RDS/DescribeOptionGroups.pm ↑ Summary blib/lib/Paws/RDS/DescribeReservedDBInstancesOfferings.pm »
1  
2 package Paws::RDS::DescribeReservedDBInstances;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has DBInstanceClass => (is => 'ro', isa => 'Str');
5 1 has Duration => (is => 'ro', isa => 'Str');
6 1 has Filters => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Filter]');
7 1 has LeaseId => (is => 'ro', isa => 'Str');
8 1 has Marker => (is => 'ro', isa => 'Str');
9 1 has MaxRecords => (is => 'ro', isa => 'Int');
10 1 has MultiAZ => (is => 'ro', isa => 'Bool');
11 1 has OfferingType => (is => 'ro', isa => 'Str');
12 1 has ProductDescription => (is => 'ro', isa => 'Str');
13 1 has ReservedDBInstanceId => (is => 'ro', isa => 'Str');
14 1 has ReservedDBInstancesOfferingId => (is => 'ro', isa => 'Str');
15  
16 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
17  
18 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeReservedDBInstances');
19 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::ReservedDBInstanceMessage');
20 1 class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeReservedDBInstancesResult');
21 1 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::RDS::DescribeReservedDBInstances - Arguments for method DescribeReservedDBInstances on L<Paws::RDS>
28  
29 =head1 DESCRIPTION
30  
31 This class represents the parameters used for calling the method DescribeReservedDBInstances on the
32 L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class
33 as arguments to method DescribeReservedDBInstances.
34  
35 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeReservedDBInstances.
36  
37 =head1 SYNOPSIS
38  
39 my $rds = Paws->service('RDS');
40 # To list information about reserved DB instances
41 # This example lists information for all reserved DB instances for the specified
42 # DB instance class, duration, product, offering type, and availability zone
43 # settings.
44 my $ReservedDBInstanceMessage = $rds->DescribeReservedDBInstances(
45 'DBInstanceClass' => 'db.t2.micro',
46 'Duration' => '1y',
47 'MultiAZ' => 0,
48 'OfferingType' => 'No Upfront',
49 'ProductDescription' => 'mysql'
50 );
51  
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/DescribeReservedDBInstances>
55  
56 =head1 ATTRIBUTES
57  
58  
59 =head2 DBInstanceClass => Str
60  
61 The DB instance class filter value. Specify this parameter to show only
62 those reservations matching the specified DB instances class.
63  
64  
65  
66 =head2 Duration => Str
67  
68 The duration filter value, specified in years or seconds. Specify this
69 parameter to show only reservations for this duration.
70  
71 Valid Values: C<1 | 3 | 31536000 | 94608000>
72  
73  
74  
75 =head2 Filters => ArrayRef[L<Paws::RDS::Filter>]
76  
77 This parameter isn't currently supported.
78  
79  
80  
81 =head2 LeaseId => Str
82  
83 The lease identifier filter value. Specify this parameter to show only
84 the reservation that matches the specified lease ID.
85  
86 Amazon Web Services Support might request the lease ID for an issue
87 related to a reserved DB instance.
88  
89  
90  
91 =head2 Marker => Str
92  
93 An optional pagination token provided by a previous request. If this
94 parameter is specified, the response includes only records beyond the
95 marker, up to the value specified by C<MaxRecords>.
96  
97  
98  
99 =head2 MaxRecords => Int
100  
101 The maximum number of records to include in the response. If more than
102 the C<MaxRecords> value is available, a pagination token called a
103 marker is included in the response so you can retrieve the remaining
104 results.
105  
106 Default: 100
107  
108 Constraints: Minimum 20, maximum 100.
109  
110  
111  
112 =head2 MultiAZ => Bool
113  
114 A value that indicates whether to show only those reservations that
115 support Multi-AZ.
116  
117  
118  
119 =head2 OfferingType => Str
120  
121 The offering type filter value. Specify this parameter to show only the
122 available offerings matching the specified offering type.
123  
124 Valid Values: C<"Partial Upfront" | "All Upfront" | "No Upfront">
125  
126  
127  
128 =head2 ProductDescription => Str
129  
130 The product description filter value. Specify this parameter to show
131 only those reservations matching the specified product description.
132  
133  
134  
135 =head2 ReservedDBInstanceId => Str
136  
137 The reserved DB instance identifier filter value. Specify this
138 parameter to show only the reservation that matches the specified
139 reservation ID.
140  
141  
142  
143 =head2 ReservedDBInstancesOfferingId => Str
144  
145 The offering identifier filter value. Specify this parameter to show
146 only purchased reservations matching the specified offering identifier.
147  
148  
149  
150  
151 =head1 SEE ALSO
152  
153 This class forms part of L<Paws>, documenting arguments for method DescribeReservedDBInstances in L<Paws::RDS>
154  
155 =head1 BUGS and CONTRIBUTIONS
156  
157 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
158  
159 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
160  
161 =cut
162  
« blib/lib/Paws/RDS/DescribeOptionGroups.pm ↑ Summary blib/lib/Paws/RDS/DescribeReservedDBInstancesOfferings.pm »