GET

/#Action=PromoteReadReplica

http://rds.{region}.amazonaws.com/#Action=PromoteReadReplica

Promotes a read replica DB instance to a standalone DB instance. <note> <ul> <li> Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the <code>backing-up</code> status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion. </li> <li> This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom. </li> </ul> </note>

Access Token Required: API Key

Query Params

DBInstanceIdentifierstringrequired

The DB instance identifier. This value is stored as a lowercase string. Constraints: <ul> <li> Must match the identifier of an existing read replica DB instance. </li> </ul> Example: <code>mydbinstance</code>

BackupRetentionPeriodinteger

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Default: 1 Constraints: <ul> <li> Must be a value from 0 to 35. </li> <li> Can't be set to 0 if the DB instance is a source to read replicas. </li> </ul>

PreferredBackupWindowstring

The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html"> Adjusting the Preferred Maintenance Window</a> in the Amazon RDS User Guide. Constraints: <ul> <li> Must be in the format <code>hh24:mi-hh24:mi</code>. </li> <li> Must be in Universal Coordinated Time (UTC). </li> <li> Must not conflict with the preferred maintenance window. </li> <li> Must be at least 30 minutes. </li> </ul>

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://rds.{region}.amazonaws.com/#Action=PromoteReadReplica' \
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}