File Coverage

blib/lib/Paws/ElastiCache/NodeGroup.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::NodeGroup;
2 1     1   421 use Moose;
  1         4  
  1         6  
3             has NodeGroupId => (is => 'ro', isa => 'Str');
4             has NodeGroupMembers => (is => 'ro', isa => 'ArrayRef[Paws::ElastiCache::NodeGroupMember]', request_name => 'NodeGroupMember', traits => ['NameInRequest']);
5             has PrimaryEndpoint => (is => 'ro', isa => 'Paws::ElastiCache::Endpoint');
6             has Slots => (is => 'ro', isa => 'Str');
7             has Status => (is => 'ro', isa => 'Str');
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::ElastiCache::NodeGroup
15              
16             =head1 USAGE
17              
18             This class represents one of two things:
19              
20             =head3 Arguments in a call to a service
21              
22             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23             Each attribute should be used as a named argument in the calls that expect this type of object.
24              
25             As an example, if Att1 is expected to be a Paws::ElastiCache::NodeGroup object:
26              
27             $service_obj->Method(Att1 => { NodeGroupId => $value, ..., Status => $value });
28              
29             =head3 Results returned from an API call
30              
31             Use accessors for each attribute. If Att1 is expected to be an Paws::ElastiCache::NodeGroup object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->NodeGroupId
35              
36             =head1 DESCRIPTION
37              
38             Represents a collection of cache nodes in a replication group. One node
39             in the node group is the read/write primary node. All the other nodes
40             are read-only Replica nodes.
41              
42             =head1 ATTRIBUTES
43              
44              
45             =head2 NodeGroupId => Str
46              
47             The identifier for the node group (shard). A Redis (cluster mode
48             disabled) replication group contains only 1 node group; therefore, the
49             node group ID is 0001. A Redis (cluster mode enabled) replication group
50             contains 1 to 15 node groups numbered 0001 to 0015.
51              
52              
53             =head2 NodeGroupMembers => ArrayRef[L<Paws::ElastiCache::NodeGroupMember>]
54              
55             A list containing information about individual nodes within the node
56             group (shard).
57              
58              
59             =head2 PrimaryEndpoint => L<Paws::ElastiCache::Endpoint>
60              
61             The endpoint of the primary node in this node group (shard).
62              
63              
64             =head2 Slots => Str
65              
66             The keyspace for this node group (shard).
67              
68              
69             =head2 Status => Str
70              
71             The current state of this replication group - C<creating>,
72             C<available>, etc.
73              
74              
75              
76             =head1 SEE ALSO
77              
78             This class forms part of L<Paws>, describing an object used in L<Paws::ElastiCache>
79              
80             =head1 BUGS and CONTRIBUTIONS
81              
82             The source code is located here: https://github.com/pplu/aws-sdk-perl
83              
84             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
85              
86             =cut
87