GET

/#Action=FailoverGlobalReplicationGroup

http://elasticache.{region}.amazonaws.com/#Action=FailoverGlobalReplicationGroup

Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.

Access Token Required: API Key

Query Params

GlobalReplicationGroupIdstringrequired

The name of the Global datastore

PrimaryRegionstringrequired

The Amazon region of the primary cluster of the Global datastore

PrimaryReplicationGroupIdstringrequired

The name of the primary replication group

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://elasticache.{region}.amazonaws.com/#Action=FailoverGlobalReplicationGroup' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}