Menu
Amazon Relational Database Service
User Guide (API Version 2014-10-31)

mysql.rds_set_external_master

Configures a MySQL DB instance to be a Read Replica of an instance of MySQL running external to Amazon RDS.

Syntax

CALL mysql.rds_set_external_master (
  host_name
  , host_port
  , replication_user_name
  , replication_user_password
  , mysql_binary_log_file_name
  , mysql_binary_log_file_location
  , ssl_encryption
);

Parameters

host_name

The host name or IP address of the MySQL instance running external to Amazon RDS that will become the replication master.

host_port

The port used by the MySQL instance running external to Amazon RDS to be configured as the replication master. If your network configuration includes SSH port replication that converts the port number, specify the port number that is exposed by SSH.

replication_user_name

The ID of a user with REPLICATION SLAVE permissions in the MySQL DB instance to be configured as the Read Replica.

replication_user_password

The password of the user ID specified in replication_user_name.

mysql_binary_log_file_name

The name of the binary log on the replication master contains the replication information.

mysql_binary_log_file_location

The location in the mysql_binary_log_file_name binary log at which replication will start reading the replication information.

ssl_encryption

This option is not currently implemented. The default is 0.

Usage Notes

The mysql.rds_set_external_master procedure must be run by the master user. It must be run on the MySQL DB instance to be configured as the Read Replica of a MySQL instance running external to Amazon RDS. Before running mysql.rds_set_external_master, you must have configured the instance of MySQL running external to Amazon RDS as a replication master. For more information, see Importing and Exporting Data From a MySQL DB Instance.

Warning

Do not use mysql.rds_set_external_master to manage replication between two Amazon RDS DB instances. Use it only when replicating with an instance of MySQL running external to RDS. For information about managing replication between Amazon RDS DB instances, see Working with PostgreSQL, MySQL, and MariaDB Read Replicas.

After calling mysql.rds_set_external_master to configure an Amazon RDS DB instance as a Read Replica, you can call mysql.rds_start_replication on the replica to start the replication process. You can call mysql.rds_reset_external_master to remove the Read Replica configuration.

When mysql.rds_set_external_master is called, Amazon RDS records the time, user, and an action of "set master" in the mysql.rds_history and mysql.rds_replication_status tables.

The mysql.rds_set_external_master procedure is available in these versions of Amazon RDS MySQL:

  • MySQL 5.5 version 5.5.33 and later

  • MySQL 5.6 version 5.6.13 and later

  • MySQL 5.7 version 5.7.10 and later

Examples

When run on a MySQL DB instance, the following example configures the DB instance to be a Read Replica of an instance of MySQL running external to Amazon RDS.

call mysql.rds_set_external_master('Sourcedb.some.com',3306,'ReplicationUser','SomePassW0rd','mysql-bin-changelog.0777',120,0);