PromoteReadReplicaDBCluster
Promotes a read replica DB cluster to a standalone DB cluster.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- DBClusterIdentifier
-
The identifier of the DB cluster read replica to promote. This parameter isn't case-sensitive.
Constraints:
-
Must match the identifier of an existing DB cluster read replica.
Example:
my-cluster-replica1
Type: String
Required: Yes
-
Response Elements
The following element is returned by the service.
- DBCluster
-
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,PromoteReadReplicaDBCluster
,RestoreDBClusterFromS3
,RestoreDBClusterFromSnapshot
,RestoreDBClusterToPointInTime
,StartDBCluster
, andStopDBCluster
.For a Multi-AZ DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,RebootDBCluster
,RestoreDBClusterFromSnapshot
, andRestoreDBClusterToPointInTime
.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
Type: DBCluster object
Errors
For information about the errors that are common to all actions, see Common Errors.
- DBClusterNotFoundFault
-
DBClusterIdentifier
doesn't refer to an existing DB cluster.HTTP Status Code: 404
- InvalidDBClusterStateFault
-
The requested operation can't be performed while the cluster is in this state.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of PromoteReadReplicaDBCluster.
Sample Request
https://rds.us-east-1.amazonaws.com/
?Action=PromoteReadReplicaDBCluster
&DBClusterIdentifier=my-cluster-replica1
&SignatureMethod=HmacSHA256
&SignatureVersion=4
&Version=2014-10-31
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIADQKE4SARGYLE/20160328/us-east-1/rds/aws4_request
&X-Amz-Date=20160328T221226Z
&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
&X-Amz-Signature=e2b2cfc3db7766b6ef86922f664e05ab306754e30e408d9fd3c8e58069a9b386
Sample Response
<PromoteReadReplicaDBClusterResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
<PromoteReadReplicaDBClusterResult>
<DBCluster>
<Port>3306</Port>
<Engine>aurora</Engine>
<Status>creating</Status>
<BackupRetentionPeriod>1</BackupRetentionPeriod>
<VpcSecurityGroups>
<VpcSecurityGroupMembership>
<Status>active</Status>
<VpcSecurityGroupId>sg-2103dc23</VpcSecurityGroupId>
</VpcSecurityGroupMembership>
</VpcSecurityGroups>
<DBSubnetGroup>default</DBSubnetGroup>
<EngineVersion>5.6.10a</EngineVersion>
<Endpoint>sample-cluster.cluster-ctrayan0rynq.us-east-1.rds.amazonaws.com</Endpoint>
<DBClusterParameterGroup>default.aurora5.6</DBClusterParameterGroup>
<AvailabilityZones>
<AvailabilityZone>us-east-1a</AvailabilityZone>
<AvailabilityZone>us-east-1c</AvailabilityZone>
<AvailabilityZone>us-east-1e</AvailabilityZone>
</AvailabilityZones>
<DBClusterIdentifier>my-cluster-replica1</DBClusterIdentifier>
<PreferredBackupWindow>04:22-04:52</PreferredBackupWindow>
<PreferredMaintenanceWindow>fri:06:44-fri:07:14</PreferredMaintenanceWindow>
<DBClusterMembers>
<DBClusterMember>
<IsClusterWriter>true</IsClusterWriter>
<DBInstanceIdentifier>my-cluster1-master</DBInstanceIdentifier>
</DBClusterMember>
<DBClusterMember>
<IsClusterWriter>false</IsClusterWriter>
<DBInstanceIdentifier>my-cluster1-read1</DBInstanceIdentifier>
</DBClusterMember>
</DBClusterMembers>
<AllocatedStorage>1</AllocatedStorage>
<MasterUsername>myawsuser</MasterUsername>
</DBCluster>
</PromoteReadReplicaDBClusterResult>
<ResponseMetadata>
<RequestId>8e8c0d64-be21-11d3-a71c-13dc2f771e41</RequestId>
</ResponseMetadata>
</PromoteReadReplicaDBClusterResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: