Creating an Amazon Aurora global database

To create an Aurora global database

1. Sign in to the Amazon Web Services Management Console and open the Amazon RDS console at https://console.amazonaws.cn/rds/.

2. Choose Create database. On the Create database page, do the following:

   • For the database creation method, choose Standard create. (Don't choose Easy create.)

   • For Engine type in the Engine options section, choose the applicable engine type, Aurora (MySQL Compatible) or Aurora (PostgreSQL Compatible).

3. Continue creating your Aurora global database by using the steps from the following procedures.

To create an Aurora global database using Aurora MySQL

Complete the Create database page.

1. For Engine options, choose the following:

   1. For Engine version, choose the version of Aurora MySQL that you want to use for your Aurora global database.

2. For Templates, choose Production. Or you can choose Dev/Test if appropriate for your use case. Don't use Dev/Test in production environments.

3. For Settings, do the following:

   1. Enter a meaningful name for the DB cluster identifier. When you finish creating the Aurora global database, this name identifies the primary DB cluster.

   2. Enter your own password for the admin user account for the DB instance, or have Aurora generate one for you. If you choose to autogenerate a password, you get an option to copy the password.

      

4. For DB instance class, choose db.r5.large or another memory optimized DB instance class. We recommend that you use a db.r5 or higher instance class.

5. For Availability & durability, we recommend that you choose to have Aurora create an Aurora Replica in a different Availability Zone (AZ) for you. If you don't create an Aurora Replica now, you need to do it later.

   

6. For Connectivity, choose the virtual private cloud (VPC) based on Amazon VPC that defines the virtual networking environment for this DB instance. You can choose the defaults to simplify this task.

7. Complete the Database authentication settings. To simplify the process, you can choose Password authentication now and set up Amazon Identity and Access Management (IAM) later.

8. For Additional configuration, do the following:

   1. Enter a name for Initial database name to create the primary Aurora DB instance for this cluster. This is the writer node for the Aurora primary DB cluster.

      Leave the defaults selected for the DB cluster parameter group and DB parameter group, unless you have your own custom parameter groups that you want to use.

   2. Clear the Enable backtrack check box if it's selected. Aurora global databases don't support backtracking. Otherwise, accept the other default settings for Additional configuration.

9. Choose Create database.

   It can take several minutes for Aurora to complete the process of creating the Aurora DB instance, its Aurora Replica, and the Aurora DB cluster. You can tell when the Aurora DB cluster is ready to use as the primary DB cluster in an Aurora global database by its status. When that's so, its status and that of the writer and replica node is Available, as shown following.

   

To create an Aurora global database using Aurora PostgreSQL

Complete the Create database page.

1. For Engine options, choose the following:

   1. For Engine version, choose the version of Aurora PostgreSQL that you want to use for your Aurora global database.

2. For Templates, choose Production. Or you can choose Dev/Test if appropriate. Don't use Dev/Test in production environments.

3. For Settings, do the following:

   1. Enter a meaningful name for the DB cluster identifier. When you finish creating the Aurora global database, this name identifies the primary DB cluster.

   2. Enter your own password for the default admin account for the DB cluster, or have Aurora generate one for you. If you choose Auto generate a password, you get an option to copy the password.

      

4. For DB instance class, choose db.r5.large or another memory optimized DB instance class. We recommend that you use a db.r5 or higher instance class.

5. For Availability & durability, we recommend that you choose to have Aurora create an Aurora Replica in a different AZ for you. If you don't create an Aurora Replica now, you need to do it later.

6. For Connectivity, choose the virtual private cloud (VPC) based on Amazon VPC that defines the virtual networking environment for this DB instance. You can choose the defaults to simplify this task.

7. (Optional) Complete the Database authentication settings. Password authentication is always enabled. To simplify the process, you can skip this section and set up IAM or password and Kerberos authentication later.

8. For Additional configuration, do the following:

   1. Enter a name for Initial database name to create the primary Aurora DB instance for this cluster. This is the writer node for the Aurora primary DB cluster.

      Leave the defaults selected for the DB cluster parameter group and DB parameter group, unless you have your own custom parameter groups that you want to use.

   2. Accept all other default settings for Additional configuration, such as Encryption, Log exports, and so on.

9. Choose Create database.

   It can take several minutes for Aurora to complete the process of creating the Aurora DB instance, its Aurora Replica, and the Aurora DB cluster. When the cluster is ready to use, the Aurora DB cluster and its writer and replica nodes display Available status. This becomes the primary DB cluster of your Aurora global database, after you add a secondary.

   

To create an Aurora global database using Aurora MySQL

1. Use the create-global-cluster CLI command, passing the name of the Amazon Web Services Region, Aurora database engine, and version.

   For Linux, macOS, or Unix:

   aws rds create-global-cluster --region primary_region  \
       --global-cluster-identifier global_database_id \
       --engine aurora-mysql \
       --engine-version version # optional

   For Windows:

   aws rds create-global-cluster ^
       --global-cluster-identifier global_database_id ^
       --engine aurora-mysql ^
       --engine-version version # optional

   This creates an "empty" Aurora global database, with just a name (identifier) and Aurora database engine. It can take a few minutes for the Aurora global database to be available. Before going to the next step, use the describe-global-clusters CLI command to see if it's available.

   aws rds describe-global-clusters --region primary_region --global-cluster-identifier global_database_id

   When the Aurora global database is available, you can create its primary Aurora DB cluster.

2. To create a primary Aurora DB cluster, use the create-db-cluster CLI command. Include the name of your Aurora global database by using the --global-cluster-identifier parameter.

   For Linux, macOS, or Unix:

   aws rds create-db-cluster \
     --region primary_region \
     --db-cluster-identifier primary_db_cluster_id \
     --master-username userid \
     --master-user-password password \
     --engine aurora-mysql \
     --engine-version version \
     --global-cluster-identifier global_database_id

   For Windows:

   aws rds create-db-cluster ^
     --region primary_region ^
     --db-cluster-identifier primary_db_cluster_id ^
     --master-username userid ^
     --master-user-password password ^
     --engine aurora-mysql ^
     --engine-version version ^
     --global-cluster-identifier global_database_id 

   Use the describe-db-clusters Amazon CLI command to confirm that the Aurora DB cluster is ready. To single out a specific Aurora DB cluster, use --db-cluster-identifier parameter. Or you can leave out the Aurora DB cluster name in the command to get details about all your Aurora DB clusters in the given Region.

   aws rds describe-db-clusters --region primary_region --db-cluster-identifier primary_db_cluster_id

   When the response shows "Status": "available" for the cluster, it's ready to use.

3. Create the DB instance for your primary Aurora DB cluster. To do so, use the create-db-instance CLI command. Give the command your Aurora DB cluster's name, and specify the configuration details for the instance. You don't need to pass the --master-username and --master-user-password parameters in the command, because it gets those from the Aurora DB cluster.

   For the --db-instance-class, you can use only those from the memory optimized classes, such as db.r5.large. We recommend that you use a db.r5 or higher instance class. For information about these classes, see DB instance classes.

   For Linux, macOS, or Unix:

   aws rds create-db-instance \
     --db-cluster-identifier primary_db_cluster_id \
     --db-instance-class instance_class \
     --db-instance-identifier db_instance_id \
     --engine aurora-mysql \
     --engine-version version \
     --region primary_region 

   For Windows:

   aws rds create-db-instance ^
     --db-cluster-identifier primary_db_cluster_id ^
     --db-instance-class instance_class ^
     --db-instance-identifier db_instance_id ^
     --engine aurora-mysql ^
     --engine-version version ^
     --region primary_region

   The create-db-instance operation might take some time to complete. Check the status to see if the Aurora DB instance is available before continuing.

   aws rds describe-db-clusters --db-cluster-identifier primary_db_cluster_id

   When the command returns a status of "available," you can create another Aurora DB instance for your primary DB cluster. This is the reader instance (the Aurora Replica) for the Aurora DB cluster.

4. To create another Aurora DB instance for the cluster, use the create-db-instance CLI command.

   For Linux, macOS, or Unix:

   aws rds create-db-instance \
     --db-cluster-identifier primary_db_cluster_id \
     --db-instance-class instance_class \
     --db-instance-identifier replica_db_instance_id \
     --engine aurora-mysql

   For Windows:

   aws rds create-db-instance ^
     --db-cluster-identifier primary_db_cluster_id ^
     --db-instance-class instance_class ^
     --db-instance-identifier replica_db_instance_id ^
     --engine aurora-mysql

To create an Aurora global database using Aurora PostgreSQL

1. Use the create-global-cluster CLI command.

   For Linux, macOS, or Unix:

   aws rds create-global-cluster --region primary_region  \
       --global-cluster-identifier global_database_id \
       --engine aurora-postgresql \
       --engine-version version # optional

   For Windows:

   aws rds create-global-cluster ^
       --global-cluster-identifier global_database_id ^
       --engine aurora-postgresql ^
       --engine-version version # optional

   When the Aurora global database is available, you can create its primary Aurora DB cluster.

2. To create a primary Aurora DB cluster, use the create-db-cluster CLI command. Include the name of your Aurora global database by using the --global-cluster-identifier parameter.

   For Linux, macOS, or Unix:

   aws rds create-db-cluster \
     --region primary_region \
     --db-cluster-identifier primary_db_cluster_id \
     --master-username userid \
     --master-user-password password \
     --engine aurora-postgresql \
     --engine-version version \
     --global-cluster-identifier global_database_id

   For Windows:

   aws rds create-db-cluster ^
     --region primary_region ^
     --db-cluster-identifier primary_db_cluster_id ^
     --master-username userid ^
     --master-user-password password ^
     --engine aurora-postgresql ^
     --engine-version version ^
     --global-cluster-identifier global_database_id 

   Check that the Aurora DB cluster is ready. When the response from the following command shows "Status": "available" for the Aurora DB cluster, you can continue.

   aws rds describe-db-clusters --region primary_region --db-cluster-identifier primary_db_cluster_id

3. Create the DB instance for your primary Aurora DB cluster. To do so, use the create-db-instance CLI command.

   Pass the name of your Aurora DB cluster with the --db-cluster-identifier parameter.

   You don't need to pass the --master-username and --master-user-password parameters in the command, because it gets those from the Aurora DB cluster.

   For the --db-instance-class, you can use only those from the memory optimized classes, such as db.r5.large. We recommend that you use a db.r5 or higher instance class. For information about these classes, see DB instance classes.

   For Linux, macOS, or Unix:

   aws rds create-db-instance \
     --db-cluster-identifier primary_db_cluster_id \
     --db-instance-class instance_class \
     --db-instance-identifier db_instance_id \
     --engine aurora-postgresql \
     --engine-version version \
     --region primary_region 

   For Windows:

   aws rds create-db-instance ^
     --db-cluster-identifier primary_db_cluster_id ^
     --db-instance-class instance_class ^
     --db-instance-identifier db_instance_id ^
     --engine aurora-postgresql ^
     --engine-version version ^
     --region primary_region

4. Check the status of the Aurora DB instance before continuing.

   aws rds describe-db-clusters --db-cluster-identifier primary_db_cluster_id

   If the response shows that Aurora DB instance status is "available," you can create another Aurora DB instance for your primary DB cluster.

5. To create an Aurora Replica for Aurora DB cluster, use the create-db-instance CLI command.

   For Linux, macOS, or Unix:

   aws rds create-db-instance \
     --db-cluster-identifier primary_db_cluster_id \
     --db-instance-class instance_class \
     --db-instance-identifier replica_db_instance_id \
     --engine aurora-postgresql

   For Windows:

   aws rds create-db-instance ^
     --db-cluster-identifier primary_db_cluster_id ^
     --db-instance-class instance_class ^
     --db-instance-identifier replica_db_instance_id ^
     --engine aurora-postgresql