File Coverage

blib/lib/Paws/ElastiCache/CreateReplicationGroup.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::CreateReplicationGroup;
3 1     1   567 use Moose;
  1         3  
  1         8  
4             has AuthToken => (is => 'ro', isa => 'Str');
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 CacheSubnetGroupName => (is => 'ro', isa => 'Str');
11             has Engine => (is => 'ro', isa => 'Str');
12             has EngineVersion => (is => 'ro', isa => 'Str');
13             has NodeGroupConfiguration => (is => 'ro', isa => 'ArrayRef[Paws::ElastiCache::NodeGroupConfiguration]');
14             has NotificationTopicArn => (is => 'ro', isa => 'Str');
15             has NumCacheClusters => (is => 'ro', isa => 'Int');
16             has NumNodeGroups => (is => 'ro', isa => 'Int');
17             has Port => (is => 'ro', isa => 'Int');
18             has PreferredCacheClusterAZs => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
19             has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
20             has PrimaryClusterId => (is => 'ro', isa => 'Str');
21             has ReplicasPerNodeGroup => (is => 'ro', isa => 'Int');
22             has ReplicationGroupDescription => (is => 'ro', isa => 'Str', required => 1);
23             has ReplicationGroupId => (is => 'ro', isa => 'Str', required => 1);
24             has SecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
25             has SnapshotArns => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
26             has SnapshotName => (is => 'ro', isa => 'Str');
27             has SnapshotRetentionLimit => (is => 'ro', isa => 'Int');
28             has SnapshotWindow => (is => 'ro', isa => 'Str');
29             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::ElastiCache::Tag]');
30              
31 1     1   6475 use MooseX::ClassAttribute;
  1         2  
  1         10  
32              
33             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateReplicationGroup');
34             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElastiCache::CreateReplicationGroupResult');
35             class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateReplicationGroupResult');
36             1;
37              
38             ### main pod documentation begin ###
39              
40             =head1 NAME
41              
42             Paws::ElastiCache::CreateReplicationGroup - Arguments for method CreateReplicationGroup on Paws::ElastiCache
43              
44             =head1 DESCRIPTION
45              
46             This class represents the parameters used for calling the method CreateReplicationGroup on the
47             Amazon ElastiCache service. Use the attributes of this class
48             as arguments to method CreateReplicationGroup.
49              
50             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateReplicationGroup.
51              
52             As an example:
53              
54             $service_obj->CreateReplicationGroup(Att1 => $value1, Att2 => $value2, ...);
55              
56             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.
57              
58             =head1 ATTRIBUTES
59              
60              
61             =head2 AuthToken => Str
62              
63             B<Reserved parameter.> The password used to access a password protected
64             server.
65              
66             Password constraints:
67              
68             =over
69              
70             =item *
71              
72             Must be only printable ASCII characters.
73              
74             =item *
75              
76             Must be at least 16 characters and no more than 128 characters in
77             length.
78              
79             =item *
80              
81             Cannot contain any of the following characters: '/', '"', or "@".
82              
83             =back
84              
85             For more information, see AUTH password at Redis.
86              
87              
88              
89             =head2 AutomaticFailoverEnabled => Bool
90              
91             Specifies whether a read-only replica is automatically promoted to
92             read/write primary if the existing primary fails.
93              
94             If C<true>, Multi-AZ is enabled for this replication group. If
95             C<false>, Multi-AZ is disabled for this replication group.
96              
97             C<AutomaticFailoverEnabled> must be enabled for Redis (cluster mode
98             enabled) replication groups.
99              
100             Default: false
101              
102             ElastiCache Multi-AZ replication groups is not supported on:
103              
104             =over
105              
106             =item *
107              
108             Redis versions earlier than 2.8.6.
109              
110             =item *
111              
112             Redis (cluster mode disabled): T1 and T2 node types.
113              
114             Redis (cluster mode enabled): T2 node types.
115              
116             =back
117              
118              
119              
120              
121             =head2 AutoMinorVersionUpgrade => Bool
122              
123             This parameter is currently disabled.
124              
125              
126              
127             =head2 CacheNodeType => Str
128              
129             The compute and memory capacity of the nodes in the node group (shard).
130              
131             Valid node types are as follows:
132              
133             =over
134              
135             =item *
136              
137             General purpose:
138              
139             =over
140              
141             =item *
142              
143             Current generation: C<cache.t2.micro>, C<cache.t2.small>,
144             C<cache.t2.medium>, C<cache.m3.medium>, C<cache.m3.large>,
145             C<cache.m3.xlarge>, C<cache.m3.2xlarge>, C<cache.m4.large>,
146             C<cache.m4.xlarge>, C<cache.m4.2xlarge>, C<cache.m4.4xlarge>,
147             C<cache.m4.10xlarge>
148              
149             =item *
150              
151             Previous generation: C<cache.t1.micro>, C<cache.m1.small>,
152             C<cache.m1.medium>, C<cache.m1.large>, C<cache.m1.xlarge>
153              
154             =back
155              
156             =item *
157              
158             Compute optimized: C<cache.c1.xlarge>
159              
160             =item *
161              
162             Memory optimized:
163              
164             =over
165              
166             =item *
167              
168             Current generation: C<cache.r3.large>, C<cache.r3.xlarge>,
169             C<cache.r3.2xlarge>, C<cache.r3.4xlarge>, C<cache.r3.8xlarge>
170              
171             =item *
172              
173             Previous generation: C<cache.m2.xlarge>, C<cache.m2.2xlarge>,
174             C<cache.m2.4xlarge>
175              
176             =back
177              
178             =back
179              
180             B<Notes:>
181              
182             =over
183              
184             =item *
185              
186             All T2 instances are created in an Amazon Virtual Private Cloud (Amazon
187             VPC).
188              
189             =item *
190              
191             Redis backup/restore is not supported for Redis (cluster mode disabled)
192             T1 and T2 instances. Backup/restore is supported on Redis (cluster mode
193             enabled) T2 instances.
194              
195             =item *
196              
197             Redis Append-only files (AOF) functionality is not supported for T1 or
198             T2 instances.
199              
200             =back
201              
202             For a complete listing of node types and specifications, see Amazon
203             ElastiCache Product Features and Details and either Cache Node
204             Type-Specific Parameters for Memcached or Cache Node Type-Specific
205             Parameters for Redis.
206              
207              
208              
209             =head2 CacheParameterGroupName => Str
210              
211             The name of the parameter group to associate with this replication
212             group. If this argument is omitted, the default cache parameter group
213             for the specified engine is used.
214              
215             If you are running Redis version 3.2.4 or later, only one node group
216             (shard), and want to use a default parameter group, we recommend that
217             you specify the parameter group by name.
218              
219             =over
220              
221             =item *
222              
223             To create a Redis (cluster mode disabled) replication group, use
224             C<CacheParameterGroupName=default.redis3.2>.
225              
226             =item *
227              
228             To create a Redis (cluster mode enabled) replication group, use
229             C<CacheParameterGroupName=default.redis3.2.cluster.on>.
230              
231             =back
232              
233              
234              
235              
236             =head2 CacheSecurityGroupNames => ArrayRef[Str|Undef]
237              
238             A list of cache security group names to associate with this replication
239             group.
240              
241              
242              
243             =head2 CacheSubnetGroupName => Str
244              
245             The name of the cache subnet group to be used for the replication
246             group.
247              
248             If you're going to launch your cluster in an Amazon VPC, you need to
249             create a subnet group before you start creating a cluster. For more
250             information, see Subnets and Subnet Groups.
251              
252              
253              
254             =head2 Engine => Str
255              
256             The name of the cache engine to be used for the cache clusters in this
257             replication group.
258              
259              
260              
261             =head2 EngineVersion => Str
262              
263             The version number of the cache engine to be used for the cache
264             clusters in this replication group. To view the supported cache engine
265             versions, use the C<DescribeCacheEngineVersions> operation.
266              
267             B<Important:> You can upgrade to a newer engine version (see Selecting
268             a Cache Engine and Version) in the I<ElastiCache User Guide>, but you
269             cannot downgrade to an earlier engine version. If you want to use an
270             earlier engine version, you must delete the existing cache cluster or
271             replication group and create it anew with the earlier engine version.
272              
273              
274              
275             =head2 NodeGroupConfiguration => ArrayRef[L<Paws::ElastiCache::NodeGroupConfiguration>]
276              
277             A list of node group (shard) configuration options. Each node group
278             (shard) configuration has the following: Slots,
279             PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.
280              
281             If you're creating a Redis (cluster mode disabled) or a Redis (cluster
282             mode enabled) replication group, you can use this parameter to
283             individually configure each node group (shard), or you can omit this
284             parameter.
285              
286              
287              
288             =head2 NotificationTopicArn => Str
289              
290             The Amazon Resource Name (ARN) of the Amazon Simple Notification
291             Service (SNS) topic to which notifications are sent.
292              
293             The Amazon SNS topic owner must be the same as the cache cluster owner.
294              
295              
296              
297             =head2 NumCacheClusters => Int
298              
299             The number of clusters this replication group initially has.
300              
301             This parameter is not used if there is more than one node group
302             (shard). You should use C<ReplicasPerNodeGroup> instead.
303              
304             If C<AutomaticFailoverEnabled> is C<true>, the value of this parameter
305             must be at least 2. If C<AutomaticFailoverEnabled> is C<false> you can
306             omit this parameter (it will default to 1), or you can explicitly set
307             it to a value between 2 and 6.
308              
309             The maximum permitted value for C<NumCacheClusters> is 6 (primary plus
310             5 replicas).
311              
312              
313              
314             =head2 NumNodeGroups => Int
315              
316             An optional parameter that specifies the number of node groups (shards)
317             for this Redis (cluster mode enabled) replication group. For Redis
318             (cluster mode disabled) either omit this parameter or set it to 1.
319              
320             Default: 1
321              
322              
323              
324             =head2 Port => Int
325              
326             The port number on which each member of the replication group accepts
327             connections.
328              
329              
330              
331             =head2 PreferredCacheClusterAZs => ArrayRef[Str|Undef]
332              
333             A list of EC2 Availability Zones in which the replication group's cache
334             clusters are created. The order of the Availability Zones in the list
335             is the order in which clusters are allocated. The primary cluster is
336             created in the first AZ in the list.
337              
338             This parameter is not used if there is more than one node group
339             (shard). You should use C<NodeGroupConfiguration> instead.
340              
341             If you are creating your replication group in an Amazon VPC
342             (recommended), you can only locate cache clusters in Availability Zones
343             associated with the subnets in the selected subnet group.
344              
345             The number of Availability Zones listed must equal the value of
346             C<NumCacheClusters>.
347              
348             Default: system chosen Availability Zones.
349              
350              
351              
352             =head2 PreferredMaintenanceWindow => Str
353              
354             Specifies the weekly time range during which maintenance on the cache
355             cluster is performed. It is specified as a range in the format
356             ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window
357             is a 60 minute period. Valid values for C<ddd> are:
358              
359             Specifies the weekly time range during which maintenance on the cluster
360             is performed. It is specified as a range in the format
361             ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window
362             is a 60 minute period.
363              
364             Valid values for C<ddd> are:
365              
366             =over
367              
368             =item *
369              
370             C<sun>
371              
372             =item *
373              
374             C<mon>
375              
376             =item *
377              
378             C<tue>
379              
380             =item *
381              
382             C<wed>
383              
384             =item *
385              
386             C<thu>
387              
388             =item *
389              
390             C<fri>
391              
392             =item *
393              
394             C<sat>
395              
396             =back
397              
398             Example: C<sun:23:00-mon:01:30>
399              
400              
401              
402             =head2 PrimaryClusterId => Str
403              
404             The identifier of the cache cluster that serves as the primary for this
405             replication group. This cache cluster must already exist and have a
406             status of C<available>.
407              
408             This parameter is not required if C<NumCacheClusters>,
409             C<NumNodeGroups>, or C<ReplicasPerNodeGroup> is specified.
410              
411              
412              
413             =head2 ReplicasPerNodeGroup => Int
414              
415             An optional parameter that specifies the number of replica nodes in
416             each node group (shard). Valid values are 0 to 5.
417              
418              
419              
420             =head2 B<REQUIRED> ReplicationGroupDescription => Str
421              
422             A user-created description for the replication group.
423              
424              
425              
426             =head2 B<REQUIRED> ReplicationGroupId => Str
427              
428             The replication group identifier. This parameter is stored as a
429             lowercase string.
430              
431             Constraints:
432              
433             =over
434              
435             =item *
436              
437             A name must contain from 1 to 20 alphanumeric characters or hyphens.
438              
439             =item *
440              
441             The first character must be a letter.
442              
443             =item *
444              
445             A name cannot end with a hyphen or contain two consecutive hyphens.
446              
447             =back
448              
449              
450              
451              
452             =head2 SecurityGroupIds => ArrayRef[Str|Undef]
453              
454             One or more Amazon VPC security groups associated with this replication
455             group.
456              
457             Use this parameter only when you are creating a replication group in an
458             Amazon Virtual Private Cloud (Amazon VPC).
459              
460              
461              
462             =head2 SnapshotArns => ArrayRef[Str|Undef]
463              
464             A list of Amazon Resource Names (ARN) that uniquely identify the Redis
465             RDB snapshot files stored in Amazon S3. The snapshot files are used to
466             populate the new replication group. The Amazon S3 object name in the
467             ARN cannot contain any commas. The new replication group will have the
468             number of node groups (console: shards) specified by the parameter
469             I<NumNodeGroups> or the number of node groups configured by
470             I<NodeGroupConfiguration> regardless of the number of ARNs specified
471             here.
472              
473             This parameter is only valid if the C<Engine> parameter is C<redis>.
474              
475             Example of an Amazon S3 ARN: C<arn:aws:s3:::my_bucket/snapshot1.rdb>
476              
477              
478              
479             =head2 SnapshotName => Str
480              
481             The name of a snapshot from which to restore data into the new
482             replication group. The snapshot status changes to C<restoring> while
483             the new replication group is being created.
484              
485             This parameter is only valid if the C<Engine> parameter is C<redis>.
486              
487              
488              
489             =head2 SnapshotRetentionLimit => Int
490              
491             The number of days for which ElastiCache retains automatic snapshots
492             before deleting them. For example, if you set C<SnapshotRetentionLimit>
493             to 5, a snapshot that was taken today is retained for 5 days before
494             being deleted.
495              
496             This parameter is only valid if the C<Engine> parameter is C<redis>.
497              
498             Default: 0 (i.e., automatic backups are disabled for this cache
499             cluster).
500              
501              
502              
503             =head2 SnapshotWindow => Str
504              
505             The daily time range (in UTC) during which ElastiCache begins taking a
506             daily snapshot of your node group (shard).
507              
508             Example: C<05:00-09:00>
509              
510             If you do not specify this parameter, ElastiCache automatically chooses
511             an appropriate time range.
512              
513             This parameter is only valid if the C<Engine> parameter is C<redis>.
514              
515              
516              
517             =head2 Tags => ArrayRef[L<Paws::ElastiCache::Tag>]
518              
519             A list of cost allocation tags to be added to this resource. A tag is a
520             key-value pair. A tag key must be accompanied by a tag value.
521              
522              
523              
524              
525             =head1 SEE ALSO
526              
527             This class forms part of L<Paws>, documenting arguments for method CreateReplicationGroup in L<Paws::ElastiCache>
528              
529             =head1 BUGS and CONTRIBUTIONS
530              
531             The source code is located here: https://github.com/pplu/aws-sdk-perl
532              
533             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
534              
535             =cut
536