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 shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateReplicationGroup.
my $elasticache = Paws->service('ElastiCache'); my $CreateReplicationGroupResult = $elasticache->CreateReplicationGroup( ReplicationGroupDescription => 'MyString', ReplicationGroupId => 'MyString', AtRestEncryptionEnabled => 1, # OPTIONAL AuthToken => 'MyString', # OPTIONAL AutoMinorVersionUpgrade => 1, # OPTIONAL AutomaticFailoverEnabled => 1, # OPTIONAL CacheNodeType => 'MyString', # OPTIONAL CacheParameterGroupName => 'MyString', # OPTIONAL CacheSecurityGroupNames => [ 'MyString', ... ], # OPTIONAL CacheSubnetGroupName => 'MyString', # OPTIONAL Engine => 'MyString', # OPTIONAL EngineVersion => 'MyString', # OPTIONAL NodeGroupConfiguration => [ { NodeGroupId => 'MyAllowedNodeGroupId', # min: 1, max: 4; OPTIONAL PrimaryAvailabilityZone => 'MyString', ReplicaAvailabilityZones => [ 'MyString', ... ], # OPTIONAL ReplicaCount => 1, # OPTIONAL Slots => 'MyString', }, ... ], # OPTIONAL NotificationTopicArn => 'MyString', # OPTIONAL NumCacheClusters => 1, # OPTIONAL NumNodeGroups => 1, # OPTIONAL Port => 1, # OPTIONAL PreferredCacheClusterAZs => [ 'MyString', ... ], # OPTIONAL PreferredMaintenanceWindow => 'MyString', # OPTIONAL PrimaryClusterId => 'MyString', # OPTIONAL ReplicasPerNodeGroup => 1, # OPTIONAL SecurityGroupIds => [ 'MyString', ... ], # OPTIONAL SnapshotArns => [ 'MyString', ... ], # OPTIONAL SnapshotName => 'MyString', # OPTIONAL SnapshotRetentionLimit => 1, # OPTIONAL SnapshotWindow => 'MyString', # OPTIONAL Tags => [ { Key => 'MyString', Value => 'MyString', }, ... ], # OPTIONAL TransitEncryptionEnabled => 1, # OPTIONAL ); # Results: my $ReplicationGroup = $CreateReplicationGroupResult->ReplicationGroup; # Returns a L<Paws::ElastiCache::CreateReplicationGroupResult> object.
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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/elasticache/CreateReplicationGroup
A flag that enables encryption at rest when set to true.
true
You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.
AtRestEncryptionEnabled
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x.
3.2.6
4.x
Default: false
false
Reserved parameter. The password used to access a password protected server.
AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.
AuthToken
TransitEncryptionEnabled
For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.
CacheSubnetGroup
Password constraints:
Must be only printable ASCII characters.
Must be at least 16 characters and no more than 128 characters in length.
Cannot contain any of the following characters: '/', '"', or '@'.
For more information, see AUTH password (http://redis.io/commands/AUTH) at http://redis.io/commands/AUTH.
Specifies whether a read-only replica is 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.
AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.
AutomaticFailoverEnabled
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
This parameter is currently disabled.
The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
cache.t2.micro
cache.t2.small
cache.t2.medium
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
cache.m3.medium
cache.m3.large
cache.m3.xlarge
cache.m3.2xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
cache.m4.large
cache.m4.xlarge
cache.m4.2xlarge
cache.m4.4xlarge
cache.m4.10xlarge
Previous generation: (not recommended)
T1 node types: cache.t1.micro
cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
cache.m1.small
cache.m1.medium
cache.m1.large
cache.m1.xlarge
Compute optimized:
C1 node types: cache.c1.xlarge
cache.c1.xlarge
Memory optimized:
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
cache.r3.large
cache.r3.xlarge
cache.r3.2xlarge
cache.r3.4xlarge
cache.r3.8xlarge
R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
cache.r4.large
cache.r4.xlarge
cache.r4.2xlarge
cache.r4.4xlarge
cache.r4.8xlarge
cache.r4.16xlarge
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
cache.m2.xlarge
cache.m2.2xlarge
cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.
Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
For a complete listing of node types and specifications, see:
Amazon ElastiCache Product Features and Details (http://aws.amazon.com/elasticache/details)
Cache Node Type-Specific Parameters for Memcached (http://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/ParameterGroups.Memcached.html#ParameterGroups.Memcached.NodeSpecific)
Cache Node Type-Specific Parameters for Redis (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific)
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.
If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.
To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.
CacheParameterGroupName=default.redis3.2
To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.
CacheParameterGroupName=default.redis3.2.cluster.on
A list of cache security group names to associate with this replication group.
The name of the cache subnet group to be used for the replication group.
If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html).
The name of the cache engine to be used for the clusters in this replication group.
The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
DescribeCacheEngineVersions
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.
PrimaryAvailabilityZone
ReplicaAvailabilityZones
ReplicaCount
Slots
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file, you must configure each node group (shard) using this parameter because you must specify the slots for each node group.
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
The Amazon SNS topic owner must be the same as the cluster owner.
The number of clusters this replication group initially has.
This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.
ReplicasPerNodeGroup
If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.
The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).
NumCacheClusters
An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.
Default: 1
The port number on which each member of the replication group accepts connections.
A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.
This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.
NodeGroupConfiguration
If you are creating your replication group in an Amazon VPC (recommended), you can only locate 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.
Specifies the weekly time range during which maintenance on the 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:
ddd
Specifies the weekly time range during which maintenance on the 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:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
sun:23:00-mon:01:30
The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.
available
This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.
NumNodeGroups
An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
A user-created description for the replication group.
The replication group identifier. This parameter is stored as a lowercase string.
Constraints:
A name must contain from 1 to 20 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.
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 (Amazon VPC).
A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
arn:aws:s3:::my_bucket/snapshot1.rdb
The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.
restoring
The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
SnapshotRetentionLimit
Default: 0 (i.e., automatic backups are disabled for this cluster).
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
Example: 05:00-09:00
05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
A list of cost allocation tags to be added to this resource. A tag is a key-value pair.
A flag that enables in-transit encryption when set to true.
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6 or 4.x, and the cluster is being created in an Amazon VPC.
Engine
redis
EngineVersion
If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.
This class forms part of Paws, documenting arguments for method CreateReplicationGroup in Paws::ElastiCache
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.