File Coverage

blib/lib/Paws/ElastiCache/DescribeReservedCacheNodes.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::ElastiCache::DescribeReservedCacheNodes;
3 1     1   324 use Moose;
  1         3  
  1         7  
4             has CacheNodeType => (is => 'ro', isa => 'Str');
5             has Duration => (is => 'ro', isa => 'Str');
6             has Marker => (is => 'ro', isa => 'Str');
7             has MaxRecords => (is => 'ro', isa => 'Int');
8             has OfferingType => (is => 'ro', isa => 'Str');
9             has ProductDescription => (is => 'ro', isa => 'Str');
10             has ReservedCacheNodeId => (is => 'ro', isa => 'Str');
11             has ReservedCacheNodesOfferingId => (is => 'ro', isa => 'Str');
12              
13 1     1   5637 use MooseX::ClassAttribute;
  1         3  
  1         9  
14              
15             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeReservedCacheNodes');
16             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElastiCache::ReservedCacheNodeMessage');
17             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeReservedCacheNodesResult');
18             1;
19              
20             ### main pod documentation begin ###
21              
22             =head1 NAME
23              
24             Paws::ElastiCache::DescribeReservedCacheNodes - Arguments for method DescribeReservedCacheNodes on Paws::ElastiCache
25              
26             =head1 DESCRIPTION
27              
28             This class represents the parameters used for calling the method DescribeReservedCacheNodes on the
29             Amazon ElastiCache service. Use the attributes of this class
30             as arguments to method DescribeReservedCacheNodes.
31              
32             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeReservedCacheNodes.
33              
34             As an example:
35              
36             $service_obj->DescribeReservedCacheNodes(Att1 => $value1, Att2 => $value2, ...);
37              
38             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.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 CacheNodeType => Str
44              
45             The cache node type filter value. Use this parameter to show only those
46             reservations matching the specified cache node type.
47              
48             Valid node types are as follows:
49              
50             =over
51              
52             =item *
53              
54             General purpose:
55              
56             =over
57              
58             =item *
59              
60             Current generation: C<cache.t2.micro>, C<cache.t2.small>,
61             C<cache.t2.medium>, C<cache.m3.medium>, C<cache.m3.large>,
62             C<cache.m3.xlarge>, C<cache.m3.2xlarge>, C<cache.m4.large>,
63             C<cache.m4.xlarge>, C<cache.m4.2xlarge>, C<cache.m4.4xlarge>,
64             C<cache.m4.10xlarge>
65              
66             =item *
67              
68             Previous generation: C<cache.t1.micro>, C<cache.m1.small>,
69             C<cache.m1.medium>, C<cache.m1.large>, C<cache.m1.xlarge>
70              
71             =back
72              
73             =item *
74              
75             Compute optimized: C<cache.c1.xlarge>
76              
77             =item *
78              
79             Memory optimized:
80              
81             =over
82              
83             =item *
84              
85             Current generation: C<cache.r3.large>, C<cache.r3.xlarge>,
86             C<cache.r3.2xlarge>, C<cache.r3.4xlarge>, C<cache.r3.8xlarge>
87              
88             =item *
89              
90             Previous generation: C<cache.m2.xlarge>, C<cache.m2.2xlarge>,
91             C<cache.m2.4xlarge>
92              
93             =back
94              
95             =back
96              
97             B<Notes:>
98              
99             =over
100              
101             =item *
102              
103             All T2 instances are created in an Amazon Virtual Private Cloud (Amazon
104             VPC).
105              
106             =item *
107              
108             Redis backup/restore is not supported for Redis (cluster mode disabled)
109             T1 and T2 instances. Backup/restore is supported on Redis (cluster mode
110             enabled) T2 instances.
111              
112             =item *
113              
114             Redis Append-only files (AOF) functionality is not supported for T1 or
115             T2 instances.
116              
117             =back
118              
119             For a complete listing of node types and specifications, see Amazon
120             ElastiCache Product Features and Details and either Cache Node
121             Type-Specific Parameters for Memcached or Cache Node Type-Specific
122             Parameters for Redis.
123              
124              
125              
126             =head2 Duration => Str
127              
128             The duration filter value, specified in years or seconds. Use this
129             parameter to show only reservations for this duration.
130              
131             Valid Values: C<1 | 3 | 31536000 | 94608000>
132              
133              
134              
135             =head2 Marker => Str
136              
137             An optional marker returned from a prior request. Use this marker for
138             pagination of results from this operation. If this parameter is
139             specified, the response includes only records beyond the marker, up to
140             the value specified by C<MaxRecords>.
141              
142              
143              
144             =head2 MaxRecords => Int
145              
146             The maximum number of records to include in the response. If more
147             records exist than the specified C<MaxRecords> value, a marker is
148             included in the response so that the remaining results can be
149             retrieved.
150              
151             Default: 100
152              
153             Constraints: minimum 20; maximum 100.
154              
155              
156              
157             =head2 OfferingType => Str
158              
159             The offering type filter value. Use this parameter to show only the
160             available offerings matching the specified offering type.
161              
162             Valid values: C<"Light Utilization"|"Medium Utilization"|"Heavy
163             Utilization">
164              
165              
166              
167             =head2 ProductDescription => Str
168              
169             The product description filter value. Use this parameter to show only
170             those reservations matching the specified product description.
171              
172              
173              
174             =head2 ReservedCacheNodeId => Str
175              
176             The reserved cache node identifier filter value. Use this parameter to
177             show only the reservation that matches the specified reservation ID.
178              
179              
180              
181             =head2 ReservedCacheNodesOfferingId => Str
182              
183             The offering identifier filter value. Use this parameter to show only
184             purchased reservations matching the specified offering identifier.
185              
186              
187              
188              
189             =head1 SEE ALSO
190              
191             This class forms part of L<Paws>, documenting arguments for method DescribeReservedCacheNodes in L<Paws::ElastiCache>
192              
193             =head1 BUGS and CONTRIBUTIONS
194              
195             The source code is located here: https://github.com/pplu/aws-sdk-perl
196              
197             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
198              
199             =cut
200