createReplicationGroup method

Future<CreateReplicationGroupResult> createReplicationGroup({
  1. required String replicationGroupDescription,
  2. required String replicationGroupId,
  3. bool? atRestEncryptionEnabled,
  4. String? authToken,
  5. bool? autoMinorVersionUpgrade,
  6. bool? automaticFailoverEnabled,
  7. String? cacheNodeType,
  8. String? cacheParameterGroupName,
  9. List<String>? cacheSecurityGroupNames,
  10. String? cacheSubnetGroupName,
  11. String? engine,
  12. String? engineVersion,
  13. String? globalReplicationGroupId,
  14. String? kmsKeyId,
  15. bool? multiAZEnabled,
  16. List<NodeGroupConfiguration>? nodeGroupConfiguration,
  17. String? notificationTopicArn,
  18. int? numCacheClusters,
  19. int? numNodeGroups,
  20. int? port,
  21. List<String>? preferredCacheClusterAZs,
  22. String? preferredMaintenanceWindow,
  23. String? primaryClusterId,
  24. int? replicasPerNodeGroup,
  25. List<String>? securityGroupIds,
  26. List<String>? snapshotArns,
  27. String? snapshotName,
  28. int? snapshotRetentionLimit,
  29. String? snapshotWindow,
  30. List<Tag>? tags,
  31. bool? transitEncryptionEnabled,
  32. List<String>? userGroupIds,
})

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.

This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global Datastore.

A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.

A Redis (cluster mode enabled) replication group is a collection of 1 to 90 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).

When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide.

May throw CacheClusterNotFoundFault. May throw InvalidCacheClusterStateFault. May throw ReplicationGroupAlreadyExistsFault. May throw InvalidUserGroupStateFault. May throw UserGroupNotFoundFault. May throw InsufficientCacheClusterCapacityFault. May throw CacheSecurityGroupNotFoundFault. May throw CacheSubnetGroupNotFoundFault. May throw ClusterQuotaForCustomerExceededFault. May throw NodeQuotaForClusterExceededFault. May throw NodeQuotaForCustomerExceededFault. May throw CacheParameterGroupNotFoundFault. May throw InvalidVPCNetworkStateFault. May throw TagQuotaPerResourceExceeded. May throw NodeGroupsPerReplicationGroupQuotaExceededFault. May throw GlobalReplicationGroupNotFoundFault. May throw InvalidGlobalReplicationGroupStateFault. May throw InvalidParameterValueException. May throw InvalidParameterCombinationException.

Parameter replicationGroupDescription : A user-created description for the replication group.

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

Constraints:

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

Parameter atRestEncryptionEnabled : A flag that enables encryption at rest when set to 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.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

Parameter authToken : Reserved parameter. The password used to access a password protected server.

AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true. Password constraints:

  • Must be only printable ASCII characters.
  • Must be at least 16 characters and no more than 128 characters in length.
  • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see AUTH password at http://redis.io/commands/AUTH.

Parameter autoMinorVersionUpgrade : This parameter is currently disabled.

Parameter automaticFailoverEnabled : Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

Default: false

Parameter cacheNodeType : 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:

      M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

      cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:
    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:
    • Current generation:

      R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

      cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info
  • All current generation instance types are created in Amazon VPC by default.
  • Redis append-only files (AOF) are not supported for T1 or T2 instances.
  • Redis Multi-AZ with automatic failover is not supported on T1 instances.
  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Parameter cacheParameterGroupName : 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.
  • To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.

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

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

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

Parameter engineVersion : 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.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) 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.

Parameter globalReplicationGroupId : The name of the Global Datastore

Parameter kmsKeyId : The ID of the KMS key used to encrypt the disk in the cluster.

Parameter multiAZEnabled : A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.

Parameter nodeGroupConfiguration : A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and 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, it is required 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.

Parameter notificationTopicArn : The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

Parameter numCacheClusters : 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.

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).

Parameter numNodeGroups : 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

Parameter port : The port number on which each member of the replication group accepts connections.

Parameter preferredCacheClusterAZs : 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.

The number of Availability Zones listed must equal the value of NumCacheClusters. Default: system chosen Availability Zones.

Parameter preferredMaintenanceWindow : 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:

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

Parameter primaryClusterId : 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.

This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.

Parameter replicasPerNodeGroup : An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.

Parameter securityGroupIds : 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).

Parameter snapshotArns : 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

Parameter snapshotName : 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.

Parameter snapshotRetentionLimit : 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.

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

Parameter snapshotWindow : The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Parameter tags : A list of cost allocation tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

Parameter transitEncryptionEnabled : 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, 4.x or later, and the cluster is being created in an Amazon VPC.

If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

Parameter userGroupIds : The list of user groups to associate with the replication group.

Implementation

Future<CreateReplicationGroupResult> createReplicationGroup({
  required String replicationGroupDescription,
  required String replicationGroupId,
  bool? atRestEncryptionEnabled,
  String? authToken,
  bool? autoMinorVersionUpgrade,
  bool? automaticFailoverEnabled,
  String? cacheNodeType,
  String? cacheParameterGroupName,
  List<String>? cacheSecurityGroupNames,
  String? cacheSubnetGroupName,
  String? engine,
  String? engineVersion,
  String? globalReplicationGroupId,
  String? kmsKeyId,
  bool? multiAZEnabled,
  List<NodeGroupConfiguration>? nodeGroupConfiguration,
  String? notificationTopicArn,
  int? numCacheClusters,
  int? numNodeGroups,
  int? port,
  List<String>? preferredCacheClusterAZs,
  String? preferredMaintenanceWindow,
  String? primaryClusterId,
  int? replicasPerNodeGroup,
  List<String>? securityGroupIds,
  List<String>? snapshotArns,
  String? snapshotName,
  int? snapshotRetentionLimit,
  String? snapshotWindow,
  List<Tag>? tags,
  bool? transitEncryptionEnabled,
  List<String>? userGroupIds,
}) async {
  ArgumentError.checkNotNull(
      replicationGroupDescription, 'replicationGroupDescription');
  ArgumentError.checkNotNull(replicationGroupId, 'replicationGroupId');
  final $request = <String, dynamic>{};
  $request['ReplicationGroupDescription'] = replicationGroupDescription;
  $request['ReplicationGroupId'] = replicationGroupId;
  atRestEncryptionEnabled
      ?.also((arg) => $request['AtRestEncryptionEnabled'] = arg);
  authToken?.also((arg) => $request['AuthToken'] = arg);
  autoMinorVersionUpgrade
      ?.also((arg) => $request['AutoMinorVersionUpgrade'] = arg);
  automaticFailoverEnabled
      ?.also((arg) => $request['AutomaticFailoverEnabled'] = arg);
  cacheNodeType?.also((arg) => $request['CacheNodeType'] = arg);
  cacheParameterGroupName
      ?.also((arg) => $request['CacheParameterGroupName'] = arg);
  cacheSecurityGroupNames
      ?.also((arg) => $request['CacheSecurityGroupNames'] = arg);
  cacheSubnetGroupName?.also((arg) => $request['CacheSubnetGroupName'] = arg);
  engine?.also((arg) => $request['Engine'] = arg);
  engineVersion?.also((arg) => $request['EngineVersion'] = arg);
  globalReplicationGroupId
      ?.also((arg) => $request['GlobalReplicationGroupId'] = arg);
  kmsKeyId?.also((arg) => $request['KmsKeyId'] = arg);
  multiAZEnabled?.also((arg) => $request['MultiAZEnabled'] = arg);
  nodeGroupConfiguration
      ?.also((arg) => $request['NodeGroupConfiguration'] = arg);
  notificationTopicArn?.also((arg) => $request['NotificationTopicArn'] = arg);
  numCacheClusters?.also((arg) => $request['NumCacheClusters'] = arg);
  numNodeGroups?.also((arg) => $request['NumNodeGroups'] = arg);
  port?.also((arg) => $request['Port'] = arg);
  preferredCacheClusterAZs
      ?.also((arg) => $request['PreferredCacheClusterAZs'] = arg);
  preferredMaintenanceWindow
      ?.also((arg) => $request['PreferredMaintenanceWindow'] = arg);
  primaryClusterId?.also((arg) => $request['PrimaryClusterId'] = arg);
  replicasPerNodeGroup?.also((arg) => $request['ReplicasPerNodeGroup'] = arg);
  securityGroupIds?.also((arg) => $request['SecurityGroupIds'] = arg);
  snapshotArns?.also((arg) => $request['SnapshotArns'] = arg);
  snapshotName?.also((arg) => $request['SnapshotName'] = arg);
  snapshotRetentionLimit
      ?.also((arg) => $request['SnapshotRetentionLimit'] = arg);
  snapshotWindow?.also((arg) => $request['SnapshotWindow'] = arg);
  tags?.also((arg) => $request['Tags'] = arg);
  transitEncryptionEnabled
      ?.also((arg) => $request['TransitEncryptionEnabled'] = arg);
  userGroupIds?.also((arg) => $request['UserGroupIds'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'CreateReplicationGroup',
    version: '2015-02-02',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['CreateReplicationGroupMessage'],
    shapes: shapes,
    resultWrapper: 'CreateReplicationGroupResult',
  );
  return CreateReplicationGroupResult.fromXml($result);
}