Module Values.CreateReplicationGroupResultSource

Creates a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (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 Valkey or Redis OSS (cluster mode disabled) replication group is a collection of nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas. A Valkey or Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed. The node or shard limit can be increased to a maximum of 500 per cluster if the Valkey or Redis OSS engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster. To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type. When a Valkey or Redis OSS (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 use scaling. For more information, see Scaling self-designed clusters in the ElastiCache User Guide. This operation is valid for Valkey and Redis OSS only.

Sourcetype createReplicationGroupResult = {
  1. replicationGroup : ReplicationGroup.t option;
}
Sourceand responseMetaData = unit
Sourceand t = {
  1. createReplicationGroupResult : createReplicationGroupResult;
  2. responseMetaData : responseMetaData;
}
Sourcetype error = [
  1. | `CacheClusterNotFoundFault of CacheClusterNotFoundFault.t
  2. | `CacheParameterGroupNotFoundFault of CacheParameterGroupNotFoundFault.t
  3. | `CacheSecurityGroupNotFoundFault of CacheSecurityGroupNotFoundFault.t
  4. | `CacheSubnetGroupNotFoundFault of CacheSubnetGroupNotFoundFault.t
  5. | `ClusterQuotaForCustomerExceededFault of ClusterQuotaForCustomerExceededFault.t
  6. | `GlobalReplicationGroupNotFoundFault of GlobalReplicationGroupNotFoundFault.t
  7. | `InsufficientCacheClusterCapacityFault of InsufficientCacheClusterCapacityFault.t
  8. | `InvalidCacheClusterStateFault of InvalidCacheClusterStateFault.t
  9. | `InvalidGlobalReplicationGroupStateFault of InvalidGlobalReplicationGroupStateFault.t
  10. | `InvalidParameterCombinationException of InvalidParameterCombinationException.t
  11. | `InvalidParameterValueException of InvalidParameterValueException.t
  12. | `InvalidUserGroupStateFault of InvalidUserGroupStateFault.t
  13. | `InvalidVPCNetworkStateFault of InvalidVPCNetworkStateFault.t
  14. | `NodeGroupsPerReplicationGroupQuotaExceededFault of NodeGroupsPerReplicationGroupQuotaExceededFault.t
  15. | `NodeQuotaForClusterExceededFault of NodeQuotaForClusterExceededFault.t
  16. | `NodeQuotaForCustomerExceededFault of NodeQuotaForCustomerExceededFault.t
  17. | `ReplicationGroupAlreadyExistsFault of ReplicationGroupAlreadyExistsFault.t
  18. | `TagQuotaPerResourceExceeded of TagQuotaPerResourceExceeded.t
  19. | `UserGroupNotFoundFault of UserGroupNotFoundFault.t
  20. | `Unknown_operation_error of string * string option
]
Sourceval context_ : string
Sourceval make : ?replicationGroup:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `CacheClusterNotFoundFault of unit | `CacheParameterGroupNotFoundFault of unit | `CacheSecurityGroupNotFoundFault of unit | `CacheSubnetGroupNotFoundFault of unit | `ClusterQuotaForCustomerExceededFault of unit | `GlobalReplicationGroupNotFoundFault of unit | `InsufficientCacheClusterCapacityFault of unit | `InvalidCacheClusterStateFault of unit | `InvalidGlobalReplicationGroupStateFault of unit | `InvalidParameterCombinationException of InvalidParameterCombinationException.t | `InvalidParameterValueException of InvalidParameterValueException.t | `InvalidUserGroupStateFault of unit | `InvalidVPCNetworkStateFault of unit | `NodeGroupsPerReplicationGroupQuotaExceededFault of unit | `NodeQuotaForClusterExceededFault of unit | `NodeQuotaForCustomerExceededFault of unit | `ReplicationGroupAlreadyExistsFault of unit | `TagQuotaPerResourceExceeded of unit | `Unknown_operation_error of string * string option | `UserGroupNotFoundFault of unit ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `CacheClusterNotFoundFault of unit | `CacheParameterGroupNotFoundFault of unit | `CacheSecurityGroupNotFoundFault of unit | `CacheSubnetGroupNotFoundFault of unit | `ClusterQuotaForCustomerExceededFault of unit | `GlobalReplicationGroupNotFoundFault of unit | `InsufficientCacheClusterCapacityFault of unit | `InvalidCacheClusterStateFault of unit | `InvalidGlobalReplicationGroupStateFault of unit | `InvalidParameterCombinationException of InvalidParameterCombinationException.t | `InvalidParameterValueException of InvalidParameterValueException.t | `InvalidUserGroupStateFault of unit | `InvalidVPCNetworkStateFault of unit | `NodeGroupsPerReplicationGroupQuotaExceededFault of unit | `NodeQuotaForClusterExceededFault of unit | `NodeQuotaForCustomerExceededFault of unit | `ReplicationGroupAlreadyExistsFault of unit | `TagQuotaPerResourceExceeded of unit | `Unknown_operation_error of string * string option | `UserGroupNotFoundFault of unit ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Structure of (string * [> `Structure of (string * [> `Boolean of BooleanOptional.t | `Enum of string | `Integer of IntegerOptional.t | `List of [> `String of String_.t | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of String_.t | `Structure of (string * [> `Integer of Integer.t | `String of String_.t ]) list ]) list ] list | `String of String_.t | `Structure of (string * [> `Integer of Integer.t | `String of String_.t | `Structure of (string * [> `String of String_.t ]) list ]) list ]) list ] list | `String of String_.t | `Structure of (string * [> `Boolean of BooleanOptional.t | `Enum of string | `Integer of Integer.t | `List of [> `Structure of (string * [> `Enum of string | `Structure of (string * [> `Structure of (string * [> `String of String_.t ]) list ]) list ]) list ] list | `String of String_.t | `Structure of (string * [> `List of [> `String of UserGroupId.t ] list | `Structure of (string * [> `Double of Double.t ]) list ]) list ]) list | `Timestamp of TStamp.t ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t