File Coverage

blib/lib/Paws/ElastiCache/CacheNode.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::CacheNode;
2 1     1   332 use Moose;
  1         4  
  1         6  
3             has CacheNodeCreateTime => (is => 'ro', isa => 'Str');
4             has CacheNodeId => (is => 'ro', isa => 'Str');
5             has CacheNodeStatus => (is => 'ro', isa => 'Str');
6             has CustomerAvailabilityZone => (is => 'ro', isa => 'Str');
7             has Endpoint => (is => 'ro', isa => 'Paws::ElastiCache::Endpoint');
8             has ParameterGroupStatus => (is => 'ro', isa => 'Str');
9             has SourceCacheNodeId => (is => 'ro', isa => 'Str');
10             1;
11              
12             ### main pod documentation begin ###
13              
14             =head1 NAME
15              
16             Paws::ElastiCache::CacheNode
17              
18             =head1 USAGE
19              
20             This class represents one of two things:
21              
22             =head3 Arguments in a call to a service
23              
24             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25             Each attribute should be used as a named argument in the calls that expect this type of object.
26              
27             As an example, if Att1 is expected to be a Paws::ElastiCache::CacheNode object:
28              
29             $service_obj->Method(Att1 => { CacheNodeCreateTime => $value, ..., SourceCacheNodeId => $value });
30              
31             =head3 Results returned from an API call
32              
33             Use accessors for each attribute. If Att1 is expected to be an Paws::ElastiCache::CacheNode object:
34              
35             $result = $service_obj->Method(...);
36             $result->Att1->CacheNodeCreateTime
37              
38             =head1 DESCRIPTION
39              
40             Represents an individual cache node within a cache cluster. Each cache
41             node runs its own instance of the cluster's protocol-compliant caching
42             software - either Memcached or Redis.
43              
44             Valid node types are as follows:
45              
46             =over
47              
48             =item *
49              
50             General purpose:
51              
52             =over
53              
54             =item *
55              
56             Current generation: C<cache.t2.micro>, C<cache.t2.small>,
57             C<cache.t2.medium>, C<cache.m3.medium>, C<cache.m3.large>,
58             C<cache.m3.xlarge>, C<cache.m3.2xlarge>, C<cache.m4.large>,
59             C<cache.m4.xlarge>, C<cache.m4.2xlarge>, C<cache.m4.4xlarge>,
60             C<cache.m4.10xlarge>
61              
62             =item *
63              
64             Previous generation: C<cache.t1.micro>, C<cache.m1.small>,
65             C<cache.m1.medium>, C<cache.m1.large>, C<cache.m1.xlarge>
66              
67             =back
68              
69             =item *
70              
71             Compute optimized: C<cache.c1.xlarge>
72              
73             =item *
74              
75             Memory optimized:
76              
77             =over
78              
79             =item *
80              
81             Current generation: C<cache.r3.large>, C<cache.r3.xlarge>,
82             C<cache.r3.2xlarge>, C<cache.r3.4xlarge>, C<cache.r3.8xlarge>
83              
84             =item *
85              
86             Previous generation: C<cache.m2.xlarge>, C<cache.m2.2xlarge>,
87             C<cache.m2.4xlarge>
88              
89             =back
90              
91             =back
92              
93             B<Notes:>
94              
95             =over
96              
97             =item *
98              
99             All T2 instances are created in an Amazon Virtual Private Cloud (Amazon
100             VPC).
101              
102             =item *
103              
104             Redis backup/restore is not supported for Redis (cluster mode disabled)
105             T1 and T2 instances. Backup/restore is supported on Redis (cluster mode
106             enabled) T2 instances.
107              
108             =item *
109              
110             Redis Append-only files (AOF) functionality is not supported for T1 or
111             T2 instances.
112              
113             =back
114              
115             For a complete listing of node types and specifications, see Amazon
116             ElastiCache Product Features and Details and either Cache Node
117             Type-Specific Parameters for Memcached or Cache Node Type-Specific
118             Parameters for Redis.
119              
120             =head1 ATTRIBUTES
121              
122              
123             =head2 CacheNodeCreateTime => Str
124              
125             The date and time when the cache node was created.
126              
127              
128             =head2 CacheNodeId => Str
129              
130             The cache node identifier. A node ID is a numeric identifier (0001,
131             0002, etc.). The combination of cluster ID and node ID uniquely
132             identifies every cache node used in a customer's AWS account.
133              
134              
135             =head2 CacheNodeStatus => Str
136              
137             The current state of this cache node.
138              
139              
140             =head2 CustomerAvailabilityZone => Str
141              
142             The Availability Zone where this node was created and now resides.
143              
144              
145             =head2 Endpoint => L<Paws::ElastiCache::Endpoint>
146              
147             The hostname for connecting to this cache node.
148              
149              
150             =head2 ParameterGroupStatus => Str
151              
152             The status of the parameter group applied to this cache node.
153              
154              
155             =head2 SourceCacheNodeId => Str
156              
157             The ID of the primary node to which this read replica node is
158             synchronized. If this field is empty, this node is not associated with
159             a primary cache cluster.
160              
161              
162              
163             =head1 SEE ALSO
164              
165             This class forms part of L<Paws>, describing an object used in L<Paws::ElastiCache>
166              
167             =head1 BUGS and CONTRIBUTIONS
168              
169             The source code is located here: https://github.com/pplu/aws-sdk-perl
170              
171             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
172              
173             =cut
174