File Coverage

blib/lib/Paws/ElastiCache/ModifyReplicationGroup.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::ElastiCache::ModifyReplicationGroup;
3 1     1   409 use Moose;
  1         2  
  1         6  
4             has ApplyImmediately => (is => 'ro', isa => 'Bool');
5             has AutomaticFailoverEnabled => (is => 'ro', isa => 'Bool');
6             has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool');
7             has CacheNodeType => (is => 'ro', isa => 'Str');
8             has CacheParameterGroupName => (is => 'ro', isa => 'Str');
9             has CacheSecurityGroupNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
10             has EngineVersion => (is => 'ro', isa => 'Str');
11             has NodeGroupId => (is => 'ro', isa => 'Str');
12             has NotificationTopicArn => (is => 'ro', isa => 'Str');
13             has NotificationTopicStatus => (is => 'ro', isa => 'Str');
14             has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
15             has PrimaryClusterId => (is => 'ro', isa => 'Str');
16             has ReplicationGroupDescription => (is => 'ro', isa => 'Str');
17             has ReplicationGroupId => (is => 'ro', isa => 'Str', required => 1);
18             has SecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
19             has SnapshotRetentionLimit => (is => 'ro', isa => 'Int');
20             has SnapshottingClusterId => (is => 'ro', isa => 'Str');
21             has SnapshotWindow => (is => 'ro', isa => 'Str');
22              
23 1     1   5660 use MooseX::ClassAttribute;
  1         3  
  1         9  
24              
25             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyReplicationGroup');
26             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElastiCache::ModifyReplicationGroupResult');
27             class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyReplicationGroupResult');
28             1;
29              
30             ### main pod documentation begin ###
31              
32             =head1 NAME
33              
34             Paws::ElastiCache::ModifyReplicationGroup - Arguments for method ModifyReplicationGroup on Paws::ElastiCache
35              
36             =head1 DESCRIPTION
37              
38             This class represents the parameters used for calling the method ModifyReplicationGroup on the
39             Amazon ElastiCache service. Use the attributes of this class
40             as arguments to method ModifyReplicationGroup.
41              
42             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyReplicationGroup.
43              
44             As an example:
45              
46             $service_obj->ModifyReplicationGroup(Att1 => $value1, Att2 => $value2, ...);
47              
48             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
49              
50             =head1 ATTRIBUTES
51              
52              
53             =head2 ApplyImmediately => Bool
54              
55             If C<true>, this parameter causes the modifications in this request and
56             any pending modifications to be applied, asynchronously and as soon as
57             possible, regardless of the C<PreferredMaintenanceWindow> setting for
58             the replication group.
59              
60             If C<false>, changes to the nodes in the replication group are applied
61             on the next maintenance reboot, or the next failure reboot, whichever
62             occurs first.
63              
64             Valid values: C<true> | C<false>
65              
66             Default: C<false>
67              
68              
69              
70             =head2 AutomaticFailoverEnabled => Bool
71              
72             Determines whether a read replica is automatically promoted to
73             read/write primary if the existing primary encounters a failure.
74              
75             Valid values: C<true> | C<false>
76              
77             ElastiCache Multi-AZ replication groups are not supported on:
78              
79             =over
80              
81             =item *
82              
83             Redis versions earlier than 2.8.6.
84              
85             =item *
86              
87             Redis (cluster mode disabled):T1 and T2 cache node types.
88              
89             Redis (cluster mode enabled): T1 node types.
90              
91             =back
92              
93              
94              
95              
96             =head2 AutoMinorVersionUpgrade => Bool
97              
98             This parameter is currently disabled.
99              
100              
101              
102             =head2 CacheNodeType => Str
103              
104             A valid cache node type that you want to scale this replication group
105             to.
106              
107              
108              
109             =head2 CacheParameterGroupName => Str
110              
111             The name of the cache parameter group to apply to all of the clusters
112             in this replication group. This change is asynchronously applied as
113             soon as possible for parameters when the C<ApplyImmediately> parameter
114             is specified as C<true> for this request.
115              
116              
117              
118             =head2 CacheSecurityGroupNames => ArrayRef[Str|Undef]
119              
120             A list of cache security group names to authorize for the clusters in
121             this replication group. This change is asynchronously applied as soon
122             as possible.
123              
124             This parameter can be used only with replication group containing cache
125             clusters running outside of an Amazon Virtual Private Cloud (Amazon
126             VPC).
127              
128             Constraints: Must contain no more than 255 alphanumeric characters.
129             Must not be C<Default>.
130              
131              
132              
133             =head2 EngineVersion => Str
134              
135             The upgraded version of the cache engine to be run on the cache
136             clusters in the replication group.
137              
138             B<Important:> You can upgrade to a newer engine version (see Selecting
139             a Cache Engine and Version), but you cannot downgrade to an earlier
140             engine version. If you want to use an earlier engine version, you must
141             delete the existing replication group and create it anew with the
142             earlier engine version.
143              
144              
145              
146             =head2 NodeGroupId => Str
147              
148             The name of the Node Group (called shard in the console).
149              
150              
151              
152             =head2 NotificationTopicArn => Str
153              
154             The Amazon Resource Name (ARN) of the Amazon SNS topic to which
155             notifications are sent.
156              
157             The Amazon SNS topic owner must be same as the replication group owner.
158              
159              
160              
161             =head2 NotificationTopicStatus => Str
162              
163             The status of the Amazon SNS notification topic for the replication
164             group. Notifications are sent only if the status is C<active>.
165              
166             Valid values: C<active> | C<inactive>
167              
168              
169              
170             =head2 PreferredMaintenanceWindow => Str
171              
172             Specifies the weekly time range during which maintenance on the cluster
173             is performed. It is specified as a range in the format
174             ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window
175             is a 60 minute period.
176              
177             Valid values for C<ddd> are:
178              
179             =over
180              
181             =item *
182              
183             C<sun>
184              
185             =item *
186              
187             C<mon>
188              
189             =item *
190              
191             C<tue>
192              
193             =item *
194              
195             C<wed>
196              
197             =item *
198              
199             C<thu>
200              
201             =item *
202              
203             C<fri>
204              
205             =item *
206              
207             C<sat>
208              
209             =back
210              
211             Example: C<sun:23:00-mon:01:30>
212              
213              
214              
215             =head2 PrimaryClusterId => Str
216              
217             For replication groups with a single primary, if this parameter is
218             specified, ElastiCache promotes the specified cluster in the specified
219             replication group to the primary role. The nodes of all other clusters
220             in the replication group are read replicas.
221              
222              
223              
224             =head2 ReplicationGroupDescription => Str
225              
226             A description for the replication group. Maximum length is 255
227             characters.
228              
229              
230              
231             =head2 B<REQUIRED> ReplicationGroupId => Str
232              
233             The identifier of the replication group to modify.
234              
235              
236              
237             =head2 SecurityGroupIds => ArrayRef[Str|Undef]
238              
239             Specifies the VPC Security Groups associated with the cache clusters in
240             the replication group.
241              
242             This parameter can be used only with replication group containing cache
243             clusters running in an Amazon Virtual Private Cloud (Amazon VPC).
244              
245              
246              
247             =head2 SnapshotRetentionLimit => Int
248              
249             The number of days for which ElastiCache retains automatic node group
250             (shard) snapshots before deleting them. For example, if you set
251             C<SnapshotRetentionLimit> to 5, a snapshot that was taken today is
252             retained for 5 days before being deleted.
253              
254             B<Important> If the value of SnapshotRetentionLimit is set to zero (0),
255             backups are turned off.
256              
257              
258              
259             =head2 SnapshottingClusterId => Str
260              
261             The cache cluster ID that is used as the daily snapshot source for the
262             replication group. This parameter cannot be set for Redis (cluster mode
263             enabled) replication groups.
264              
265              
266              
267             =head2 SnapshotWindow => Str
268              
269             The daily time range (in UTC) during which ElastiCache begins taking a
270             daily snapshot of the node group (shard) specified by
271             C<SnapshottingClusterId>.
272              
273             Example: C<05:00-09:00>
274              
275             If you do not specify this parameter, ElastiCache automatically chooses
276             an appropriate time range.
277              
278              
279              
280              
281             =head1 SEE ALSO
282              
283             This class forms part of L<Paws>, documenting arguments for method ModifyReplicationGroup in L<Paws::ElastiCache>
284              
285             =head1 BUGS and CONTRIBUTIONS
286              
287             The source code is located here: https://github.com/pplu/aws-sdk-perl
288              
289             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
290              
291             =cut
292