RDS Database Stack | Create (For Aurora)

Create an AWS Relational Database Service (RDS) Aurora stack using either multi-availability zone (MultiAZ) or a single instance.

Full classification: Deployment | Advanced stack components | RDS database stack | Create (for Aurora)

Change Type Details

Change type ID	ct-2jvzjwunghrhy
Current version	1.0
Expected execution duration	360 minutes
AWS approval	Required
Customer approval	Not required
Execution mode	Automated

Additional Information

Create DB stack (for Aurora)

Creating an Aurora RDS Stack with the Console

Screenshot of this change type in the AMS console:

How it works:

1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC.

2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view.

   • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create.

     To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button.

   • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page.

3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC.

   In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area.

4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output.

5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page.

Creating an Aurora RDS Stack with the CLI

How it works:

1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here.

2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID.

   Monitor the RFC: aws amscm get-rfc --rfc-id ID command.

To check the change type version, use this command:

aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID

Note

You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients\" : [\"[e-mail]\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference.

INLINE CREATE:

Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this:

aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-2jvzjwunghrhy" --change-type-version "1.0" --title "Test Create (for Aurora)" --execution-parameters "{\"Description\":\"Aurora_RDS_TEST\",\"VpcId\":\"VPC_ID\",\"Name\":\"Aurora-TEST\",\"StackTemplateId\":\"stm-j24cifrdi0untnsn6\",\"TimeoutInMinutes\":60,\"Parameters\":{\"AutoMinorVersionUpgrade\":\"true\",\"BackupRetentionPeriod\":7,\"ClusterName\":\"\",\"DBEngine\":\"aurora\",\"DBName\":\"DB_NAME\",\"DBSubnetGroupName\":\"DB_SUBNET_GROUP_NAME\",\"EngineVersion\":\"\",\"InstanceType\":\"db.r4.large\",\"MasterUsername\":\"DB_USER\",\"MasterUserPassword\":\"DB_PW\",\"MultiAZ\":\"true\",\"PerformanceInsights\":\"true\",\"PerformanceInsightsKMSKey\":\"\",\"PerformanceInsightsRetentionPeriod\":\"7\",\"Port\":\"0\",\"PreferredBackupWindow\":\"22:00-23:00\",\"PreferredMaintenanceWindow\":\"wed:03:32-wed:04:02\",\"StorageEncryptionKey\":\"\"}}"

TEMPLATE CREATE:

1. Output the execution parameters for this change type to a JSON file named CreateRdsArParams.json.

   aws amscm get-change-type-version --change-type-id "ct-2jvzjwunghrhy" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRdsArParams.json

2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this:

   Oracle example:

   {
     "Description": "Aurora_RDS_TEST",
     "VpcId": "VPC_ID",
     "Name": "Aurora-TEST",
     "StackTemplateId": "stm-j24cifrdi0untnsn6",
     "TimeoutInMinutes": 60,
     "Parameters": {
       "AutoMinorVersionUpgrade": "true",
       "BackupRetentionPeriod": 7,
       "ClusterName": "",
       "DBEngine": "aurora",
       "DBName": "DB_NAME",
       "DBSubnetGroupName": "DB_SUBNET_GROUP_NAME",
       "EngineVersion": "",
       "InstanceType": "db.r4.large",
       "MasterUsername": "DB_USER",
       "MasterUserPassword": "DB_PW",
       "MultiAZ": "true",
       "PerformanceInsights": "true",
       "PerformanceInsightsKMSKey": "",
       "PerformanceInsightsRetentionPeriod": "7",
       "Port": "0",
       "PreferredBackupWindow": "22:00-23:00",
       "PreferredMaintenanceWindow": "wed:03:32-wed:04:02",
       "StorageEncryptionKey": ""
     }
   }

3. Output the JSON template to a file in your current folder; this example names it CreateRdsArRfc.json:

   aws amscm create-rfc --generate-cli-skeleton > CreateRdsArRfc.json

4. Modify and save the CreateRdsArRfc.json file. For example, you can replace the contents with something like this:

   {
   "ChangeTypeVersion":    "1.0",
   "ChangeTypeId":         "ct-2jvzjwunghrhy",
   "Title":                "RDS-Create-Aurora-RFC"
   }

5. Create the RFC, specifying the execution parameters file and the CreateRdsArRfc file:

   aws amscm create-rfc --cli-input-json file://CreateRdsArRfc.json --execution-parameters file://CreateRdsArParams.json

   You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start.

6. To view the RDS, look in the execution output: Use the "stack_id" to view the RDS in the Cloud Formation Console. To create a Delete Stack or Update RDS RFC, use the first part of the DatabaseEndpoint (the DB instance ID) to create a Reboot RDS RFC, use the entire DatabaseEndpoint to programmatically access the RDS DB.

7. You are now able to manage the database via a database management tool such as SQL server management studio. You do not have to request access from AMS.

Tips

Note

You can add up to 50 tags, but to do so you must enable the Additional configuration view.

For more information, see Amazon Aurora – Relational Database Built for the Cloud - AWS.

To learn more about Amazon RDS, including size recommendations, see Amazon Relational Database Service Documentation.

To create an Aurora RDS stack from a backup, see Create DB stack from backup (for Aurora).

To create a non-Aurora RDS stack, see Update DB stack.

To create an non-Aurora RDS stack from a snapshot, see Create DB from snapshot.

Execution Input Parameters

For detailed information about the execution input parameters, see Schema for Change Type ct-2jvzjwunghrhy.

Example: Required Parameters

{
  "Description": "Create an RDS stack for an Aurora database (DB) with multiple availability zones (MultiAZ) or as a single instance DB. Also creates an Aurora DB cluster consisting of a DB instance, compatible with either MySQL or PostgreSQL, and a cluster volume that represents the data for the DB cluster, copied across three Availability Zones as a single, virtual volume. The DB cluster contains a primary instance and, optionally, up to 15 Aurora Replicas.",
  "VpcId": "vpc-12345678901234567",
  "StackTemplateId": "stm-j24cifrdi0untnsn6",
  "Name": "Stack Name",
  "Tags": [
    {
      "Key": "foo",
      "Value": "bar"
    },
    {
      "Key": "testkey",
      "Value": "testvalue"
    }
  ],
  "TimeoutInMinutes": 60,
  "Parameters": {
    "DBEngine": "aurora",
    "EngineVersion": "",
    "DBName": "dbname",
    "DBSubnetGroupName": "db-subnet-group",
    "MasterUsername": "dbusername",
    "MasterUserPassword": "dbpassword"
  }
}

Example: All Parameters

{
  "Description": "Create an RDS stack for an Aurora database (DB) with multiple availability zones (MultiAZ) or as a single instance DB. Also creates an Aurora DB cluster consisting of a DB instance, compatible with either MySQL or PostgreSQL, and a cluster volume that represents the data for the DB cluster, copied across three Availability Zones as a single, virtual volume. The DB cluster contains a primary instance and, optionally, up to 15 Aurora Replicas.",
  "VpcId": "vpc-12345678901234567",
  "StackTemplateId": "stm-j24cifrdi0untnsn6",
  "Name": "Stack Name",
  "Tags": [
    {
      "Key": "foo",
      "Value": "bar"
    },
    {
      "Key": "testkey",
      "Value": "testvalue"
    }
  ],
  "TimeoutInMinutes": 60,
  "Parameters": {
    "AutoMinorVersionUpgrade": "true",
    "BackupRetentionPeriod": 7,
    "ClusterName": "dbcluster",
    "DBEngine": "aurora-postgresql",
    "EngineVersion": "10.4",
    "DBName": "dbname",
    "DBSubnetGroupName": "db-subnet-group",
    "InstanceType": "db.r4.large",
    "MasterUsername": "dbusername",
    "MasterUserPassword": "dbpassword",
    "MultiAZ": "true",
    "PerformanceInsights": "true",
    "PerformanceInsightsKMSKey": "default",
    "PerformanceInsightsRetentionPeriod": "7",
    "Port": "1150",
    "PreferredBackupWindow": "22:00-23:00",
    "PreferredMaintenanceWindow": "wed:03:32-wed:04:02",
    "StorageEncryptionKey": "default"
  }
}