File Coverage

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