File Coverage

blib/lib/Paws/ElastiCache/ReservedCacheNode.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::ElastiCache::ReservedCacheNode;
2 1     1   739 use Moose;
  1         4  
  1         11  
3             has CacheNodeCount => (is => 'ro', isa => 'Int');
4             has CacheNodeType => (is => 'ro', isa => 'Str');
5             has Duration => (is => 'ro', isa => 'Int');
6             has FixedPrice => (is => 'ro', isa => 'Num');
7             has OfferingType => (is => 'ro', isa => 'Str');
8             has ProductDescription => (is => 'ro', isa => 'Str');
9             has RecurringCharges => (is => 'ro', isa => 'ArrayRef[Paws::ElastiCache::RecurringCharge]', request_name => 'RecurringCharge', traits => ['NameInRequest']);
10             has ReservedCacheNodeId => (is => 'ro', isa => 'Str');
11             has ReservedCacheNodesOfferingId => (is => 'ro', isa => 'Str');
12             has StartTime => (is => 'ro', isa => 'Str');
13             has State => (is => 'ro', isa => 'Str');
14             has UsagePrice => (is => 'ro', isa => 'Num');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::ElastiCache::ReservedCacheNode
22              
23             =head1 USAGE
24              
25             This class represents one of two things:
26              
27             =head3 Arguments in a call to a service
28              
29             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
30             Each attribute should be used as a named argument in the calls that expect this type of object.
31              
32             As an example, if Att1 is expected to be a Paws::ElastiCache::ReservedCacheNode object:
33              
34             $service_obj->Method(Att1 => { CacheNodeCount => $value, ..., UsagePrice => $value });
35              
36             =head3 Results returned from an API call
37              
38             Use accessors for each attribute. If Att1 is expected to be an Paws::ElastiCache::ReservedCacheNode object:
39              
40             $result = $service_obj->Method(...);
41             $result->Att1->CacheNodeCount
42              
43             =head1 DESCRIPTION
44              
45             Represents the output of a C<PurchaseReservedCacheNodesOffering>
46             operation.
47              
48             =head1 ATTRIBUTES
49              
50              
51             =head2 CacheNodeCount => Int
52              
53             The number of cache nodes that have been reserved.
54              
55              
56             =head2 CacheNodeType => Str
57              
58             The cache node type for the reserved cache nodes.
59              
60             Valid node types are as follows:
61              
62             =over
63              
64             =item *
65              
66             General purpose:
67              
68             =over
69              
70             =item *
71              
72             Current generation: C<cache.t2.micro>, C<cache.t2.small>,
73             C<cache.t2.medium>, C<cache.m3.medium>, C<cache.m3.large>,
74             C<cache.m3.xlarge>, C<cache.m3.2xlarge>, C<cache.m4.large>,
75             C<cache.m4.xlarge>, C<cache.m4.2xlarge>, C<cache.m4.4xlarge>,
76             C<cache.m4.10xlarge>
77              
78             =item *
79              
80             Previous generation: C<cache.t1.micro>, C<cache.m1.small>,
81             C<cache.m1.medium>, C<cache.m1.large>, C<cache.m1.xlarge>
82              
83             =back
84              
85             =item *
86              
87             Compute optimized: C<cache.c1.xlarge>
88              
89             =item *
90              
91             Memory optimized:
92              
93             =over
94              
95             =item *
96              
97             Current generation: C<cache.r3.large>, C<cache.r3.xlarge>,
98             C<cache.r3.2xlarge>, C<cache.r3.4xlarge>, C<cache.r3.8xlarge>
99              
100             =item *
101              
102             Previous generation: C<cache.m2.xlarge>, C<cache.m2.2xlarge>,
103             C<cache.m2.4xlarge>
104              
105             =back
106              
107             =back
108              
109             B<Notes:>
110              
111             =over
112              
113             =item *
114              
115             All T2 instances are created in an Amazon Virtual Private Cloud (Amazon
116             VPC).
117              
118             =item *
119              
120             Redis backup/restore is not supported for Redis (cluster mode disabled)
121             T1 and T2 instances. Backup/restore is supported on Redis (cluster mode
122             enabled) T2 instances.
123              
124             =item *
125              
126             Redis Append-only files (AOF) functionality is not supported for T1 or
127             T2 instances.
128              
129             =back
130              
131             For a complete listing of node types and specifications, see Amazon
132             ElastiCache Product Features and Details and either Cache Node
133             Type-Specific Parameters for Memcached or Cache Node Type-Specific
134             Parameters for Redis.
135              
136              
137             =head2 Duration => Int
138              
139             The duration of the reservation in seconds.
140              
141              
142             =head2 FixedPrice => Num
143              
144             The fixed price charged for this reserved cache node.
145              
146              
147             =head2 OfferingType => Str
148              
149             The offering type of this reserved cache node.
150              
151              
152             =head2 ProductDescription => Str
153              
154             The description of the reserved cache node.
155              
156              
157             =head2 RecurringCharges => ArrayRef[L<Paws::ElastiCache::RecurringCharge>]
158              
159             The recurring price charged to run this reserved cache node.
160              
161              
162             =head2 ReservedCacheNodeId => Str
163              
164             The unique identifier for the reservation.
165              
166              
167             =head2 ReservedCacheNodesOfferingId => Str
168              
169             The offering identifier.
170              
171              
172             =head2 StartTime => Str
173              
174             The time the reservation started.
175              
176              
177             =head2 State => Str
178              
179             The state of the reserved cache node.
180              
181              
182             =head2 UsagePrice => Num
183              
184             The hourly price charged for this reserved cache node.
185              
186              
187              
188             =head1 SEE ALSO
189              
190             This class forms part of L<Paws>, describing an object used in L<Paws::ElastiCache>
191              
192             =head1 BUGS and CONTRIBUTIONS
193              
194             The source code is located here: https://github.com/pplu/aws-sdk-perl
195              
196             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
197              
198             =cut
199