« blib/lib/Paws/ElastiCache/NodeGroupConfiguration.pm
↑ Summary
blib/lib/Paws/ElastiCache/NodeGroupMemberUpdateStatus.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ElastiCache::NodeGroupMember; | ||
| 3 | use Moose; | ||
| 4 | has CacheClusterId => (is => 'ro', isa => 'Str'); | ||
| 5 | has CacheNodeId => (is => 'ro', isa => 'Str'); | ||
| 6 | has CurrentRole => (is => 'ro', isa => 'Str'); | ||
| 7 | has PreferredAvailabilityZone => (is => 'ro', isa => 'Str'); | ||
| 8 | has PreferredOutpostArn => (is => 'ro', isa => 'Str'); | ||
| 9 | has ReadEndpoint => (is => 'ro', isa => 'Paws::ElastiCache::Endpoint'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::ElastiCache::NodeGroupMember | ||
| 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::NodeGroupMember object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { CacheClusterId => $value, ..., ReadEndpoint => $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::NodeGroupMember object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->CacheClusterId | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Represents a single node within a node group (shard). | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 CacheClusterId => Str | ||
| 47 | |||
| 48 | The ID of the cluster to which the node belongs. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 CacheNodeId => Str | ||
| 52 | |||
| 53 | The ID of the node within its cluster. A node ID is a numeric | ||
| 54 | identifier (0001, 0002, etc.). | ||
| 55 | |||
| 56 | |||
| 57 | =head2 CurrentRole => Str | ||
| 58 | |||
| 59 | The role that is currently assigned to the node - C<primary> or | ||
| 60 | C<replica>. This member is only applicable for Redis (cluster mode | ||
| 61 | disabled) replication groups. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 PreferredAvailabilityZone => Str | ||
| 65 | |||
| 66 | The name of the Availability Zone in which the node is located. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 PreferredOutpostArn => Str | ||
| 70 | |||
| 71 | The outpost ARN of the node group member. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 ReadEndpoint => L<Paws::ElastiCache::Endpoint> | ||
| 75 | |||
| 76 | The information required for client programs to connect to a node for | ||
| 77 | read operations. The read endpoint is only applicable on Redis (cluster | ||
| 78 | mode disabled) clusters. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head1 SEE ALSO | ||
| 83 | |||
| 84 | This class forms part of L<Paws>, describing an object used in L<Paws::ElastiCache> | ||
| 85 | |||
| 86 | =head1 BUGS and CONTRIBUTIONS | ||
| 87 | |||
| 88 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 89 | |||
| 90 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 91 | |||
| 92 | =cut | ||
| 93 |