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