CreateGlobalReplicationGroup
Global Datastore offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore with Valkey or Redis OSS, you can create cross-region read replica clusters for ElastiCache to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore.
-
The GlobalReplicationGroupIdSuffix is the name of the Global datastore.
-
The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- GlobalReplicationGroupIdSuffix
-
The suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix to the Global datastore ID when it is created. Each Amazon Region has its own prefix. For instance, a Global datastore ID created in the US-West-1 region will begin with "dsdfu" along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions.
For a full list of Amazon Regions and their respective Global datastore iD prefixes, see Using the Amazon CLI with Global datastores .
Type: String
Required: Yes
- PrimaryReplicationGroupId
-
The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
Type: String
Required: Yes
- GlobalReplicationGroupDescription
-
Provides details of the Global datastore
Type: String
Required: No
Response Elements
The following element is returned by the service.
- GlobalReplicationGroup
-
Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.
-
The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.
Type: GlobalReplicationGroup object
-
Errors
For information about the errors that are common to all actions, see Common Errors.
- GlobalReplicationGroupAlreadyExistsFault
-
The Global datastore name already exists.
HTTP Status Code: 400
- InvalidParameterValue
-
The value for a parameter is invalid.
HTTP Status Code: 400
- InvalidReplicationGroupState
-
The requested replication group is not in the
available
state.HTTP Status Code: 400
- ReplicationGroupNotFoundFault
-
The specified replication group does not exist.
HTTP Status Code: 404
- ServiceLinkedRoleNotFoundFault
-
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: