Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages


.ds Aq ’


Paws::ElastiCache::CreateReplicationGroup - Arguments for method CreateReplicationGroup on Paws::ElastiCache



This class represents the parameters used for calling the method CreateReplicationGroup on the Amazon ElastiCache service. Use the attributes of this class as arguments to method CreateReplicationGroup.

You shouln’t make instances of this class. Each attribute should be used as a named argument in the call to CreateReplicationGroup.

As an example:

  $service_obj->CreateReplicationGroup(Att1 => $value1, Att2 => $value2, ...);

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.


    AutomaticFailoverEnabled => Bool

Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.

If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group.

Default: false

ElastiCache Multi-AZ replication groups is not supported on:
o Redis versions earlier than 2.8.6.
o T1 and T2 cache node types.

    AutoMinorVersionUpgrade => Bool

This parameter is currently disabled.

    CacheNodeType => Str

The compute and memory capacity of the nodes in the node group.

Valid node types are as follows:
o General purpose:
o Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
o Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
o Compute optimized: cache.c1.xlarge
o Memory optimized
o Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
o Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
o All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
o Redis backup/restore is not supported for t2 instances.
o Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

    CacheParameterGroupName => Str

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

    CacheSecurityGroupNames => ArrayRef[Str]

A list of cache security group names to associate with this replication group.

    CacheSubnetGroupName => Str

The name of the cache subnet group to be used for the replication group.

    Engine => Str

The name of the cache engine to be used for the cache clusters in this replication group.

Default: redis

    EngineVersion => Str

The version number of the cache engine to be used for the cache clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions action.

    NotificationTopicArn => Str

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.

The Amazon SNS topic owner must be the same as the cache cluster owner.

    NumCacheClusters => Int

The number of cache clusters this replication group will initially have.

If Multi-AZ is enabled, the value of this parameter must be at least 2.

The maximum permitted value for NumCacheClusters is 6 (primary plus 5 replicas). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at

    Port => Int

The port number on which each member of the replication group will accept connections.

    PreferredCacheClusterAZs => ArrayRef[Str]

A list of EC2 availability zones in which the replication group’s cache clusters will be created. The order of the availability zones in the list is not important.

If you are creating your replication group in an Amazon VPC (recommended), you can only locate cache clusters in availability zones associated with the subnets in the selected subnet group.

The number of availability zones listed must equal the value of NumCacheClusters.

Default: system chosen availability zones.

Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-west-2a PreferredAvailabilityZones.member.2=us-west-2c PreferredAvailabilityZones.member.3=us-west-2c

    PreferredMaintenanceWindow => Str

Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:
o sun
o mon
o tue
o wed
o thu
o fri
o sat
Example: sun:05:00-sun:09:00

    PrimaryClusterId => Str

The identifier of the cache cluster that will serve as the primary for this replication group. This cache cluster must already exist and have a status of available.

This parameter is not required if NumCacheClusters is specified.

REQUIRED ReplicationGroupDescription => Str

A user-created description for the replication group.

REQUIRED ReplicationGroupId => Str

The replication group identifier. This parameter is stored as a lowercase string.

o A name must contain from 1 to 20 alphanumeric characters or hyphens.
o The first character must be a letter.
o A name cannot end with a hyphen or contain two consecutive hyphens.

    SecurityGroupIds => ArrayRef[Str]

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (VPC).

    SnapshotArns => ArrayRef[Str]

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.

<B>Note:B> This parameter is only valid if the Engine parameter is redis.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

    SnapshotName => Str

The name of a snapshot from which to restore data into the new node group. The snapshot status changes to restoring while the new node group is being created.

<B>Note:B> This parameter is only valid if the Engine parameter is redis.

    SnapshotRetentionLimit => Int

The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

<B>Note:B> This parameter is only valid if the Engine parameter is redis.

Default: 0 (i.e., automatic backups are disabled for this cache cluster).

    SnapshotWindow => Str

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.

Example: 05:00-09:00

If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

<B>Note:B> This parameter is only valid if the Engine parameter is redis.

    Tags => ArrayRef[Paws::ElastiCache::Tag]

A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.


This class forms part of Paws, documenting arguments for method CreateReplicationGroup in Paws::ElastiCache


The source code is located here:

Please report bugs to:

Search for    or go to Top of page |  Section 3 |  Main Index


Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.