File Coverage

blib/lib/Paws/ElastiCache/ReplicationGroup.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::ReplicationGroup;
2 1     1   444 use Moose;
  1         3  
  1         7  
3             has AutomaticFailover => (is => 'ro', isa => 'Str');
4             has CacheNodeType => (is => 'ro', isa => 'Str');
5             has ClusterEnabled => (is => 'ro', isa => 'Bool');
6             has ConfigurationEndpoint => (is => 'ro', isa => 'Paws::ElastiCache::Endpoint');
7             has Description => (is => 'ro', isa => 'Str');
8             has MemberClusters => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'ClusterId', traits => ['NameInRequest']);
9             has NodeGroups => (is => 'ro', isa => 'ArrayRef[Paws::ElastiCache::NodeGroup]', request_name => 'NodeGroup', traits => ['NameInRequest']);
10             has PendingModifiedValues => (is => 'ro', isa => 'Paws::ElastiCache::ReplicationGroupPendingModifiedValues');
11             has ReplicationGroupId => (is => 'ro', isa => 'Str');
12             has SnapshotRetentionLimit => (is => 'ro', isa => 'Int');
13             has SnapshottingClusterId => (is => 'ro', isa => 'Str');
14             has SnapshotWindow => (is => 'ro', isa => 'Str');
15             has Status => (is => 'ro', isa => 'Str');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::ElastiCache::ReplicationGroup
23              
24             =head1 USAGE
25              
26             This class represents one of two things:
27              
28             =head3 Arguments in a call to a service
29              
30             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
31             Each attribute should be used as a named argument in the calls that expect this type of object.
32              
33             As an example, if Att1 is expected to be a Paws::ElastiCache::ReplicationGroup object:
34              
35             $service_obj->Method(Att1 => { AutomaticFailover => $value, ..., Status => $value });
36              
37             =head3 Results returned from an API call
38              
39             Use accessors for each attribute. If Att1 is expected to be an Paws::ElastiCache::ReplicationGroup object:
40              
41             $result = $service_obj->Method(...);
42             $result->Att1->AutomaticFailover
43              
44             =head1 DESCRIPTION
45              
46             Contains all of the attributes of a specific Redis replication group.
47              
48             =head1 ATTRIBUTES
49              
50              
51             =head2 AutomaticFailover => Str
52              
53             Indicates the status of Multi-AZ for this replication group.
54              
55             ElastiCache Multi-AZ replication groups are not supported on:
56              
57             =over
58              
59             =item *
60              
61             Redis versions earlier than 2.8.6.
62              
63             =item *
64              
65             Redis (cluster mode disabled):T1 and T2 cache node types.
66              
67             Redis (cluster mode enabled): T1 node types.
68              
69             =back
70              
71              
72              
73             =head2 CacheNodeType => Str
74              
75             The name of the compute and memory capacity node type for each node in
76             the replication group.
77              
78              
79             =head2 ClusterEnabled => Bool
80              
81             A flag indicating whether or not this replication group is cluster
82             enabled; i.e., whether its data can be partitioned across multiple
83             shards (API/CLI: node groups).
84              
85             Valid values: C<true> | C<false>
86              
87              
88             =head2 ConfigurationEndpoint => L<Paws::ElastiCache::Endpoint>
89              
90             The configuration endpoint for this replicaiton group. Use the
91             configuration endpoint to connect to this replication group.
92              
93              
94             =head2 Description => Str
95              
96             The description of the replication group.
97              
98              
99             =head2 MemberClusters => ArrayRef[Str|Undef]
100              
101             The names of all the cache clusters that are part of this replication
102             group.
103              
104              
105             =head2 NodeGroups => ArrayRef[L<Paws::ElastiCache::NodeGroup>]
106              
107             A single element list with information about the nodes in the
108             replication group.
109              
110              
111             =head2 PendingModifiedValues => L<Paws::ElastiCache::ReplicationGroupPendingModifiedValues>
112              
113             A group of settings to be applied to the replication group, either
114             immediately or during the next maintenance window.
115              
116              
117             =head2 ReplicationGroupId => Str
118              
119             The identifier for the replication group.
120              
121              
122             =head2 SnapshotRetentionLimit => Int
123              
124             The number of days for which ElastiCache retains automatic cache
125             cluster snapshots before deleting them. For example, if you set
126             C<SnapshotRetentionLimit> to 5, a snapshot that was taken today is
127             retained for 5 days before being deleted.
128              
129             If the value of C<SnapshotRetentionLimit> is set to zero (0), backups
130             are turned off.
131              
132              
133             =head2 SnapshottingClusterId => Str
134              
135             The cache cluster ID that is used as the daily snapshot source for the
136             replication group.
137              
138              
139             =head2 SnapshotWindow => Str
140              
141             The daily time range (in UTC) during which ElastiCache begins taking a
142             daily snapshot of your node group (shard).
143              
144             Example: C<05:00-09:00>
145              
146             If you do not specify this parameter, ElastiCache automatically chooses
147             an appropriate time range.
148              
149             B<Note:> This parameter is only valid if the C<Engine> parameter is
150             C<redis>.
151              
152              
153             =head2 Status => Str
154              
155             The current state of this replication group - C<creating>,
156             C<available>, C<modifying>, C<deleting>, C<create-failed>,
157             C<snapshotting>.
158              
159              
160              
161             =head1 SEE ALSO
162              
163             This class forms part of L<Paws>, describing an object used in L<Paws::ElastiCache>
164              
165             =head1 BUGS and CONTRIBUTIONS
166              
167             The source code is located here: https://github.com/pplu/aws-sdk-perl
168              
169             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
170              
171             =cut
172