RDS

Guide for understanding and configuring an RDS stack

The RDS stack is an add-on AWS RDS instance or cluster deployed into an existing network.

Variables

Note:

Backend stateful services (like databases) should be isolated from direct internet access on private subnets. Provide the data_subnets variable when creating the stack to specify the subnets to deploy into. See Configuration for details.

Variable Name	Type	Description
`region`	`string`	(Required) The region to deploy the RDS cluster - must match the `data_subnets` region.
`size`	`string`	(Required) Plan size. Must be one of `dev`, `micro`, `mini`, `small`, `medium`, `large`, or `xlarge`.
↳`dev`		20 GiB disk, MySQL
↳`micro`		20 GiB disk, MySQL
↳`mini`		20 GiB disk, MySQL
↳`small`		100 GiB disk, MySQL
↳`medium`		100 GiB disk, aurora-mysql
↳`large`		100 GiB disk, aurora-mysql
↳`xlarge`		100 GiB disk, aurora-mysql
`data_disk_size`	`number`	Optional. The dedicated disk capacity (measured in gibibytes, GiB) provisioned for your database instance. Ignored when using Aurora. This will override the size defaults.
`data_subnets`	`list(string)` or `string`	(Required) Array of subnet IDs [primary, secondary]. May also be a reference to another stack’s output.
`db_username`	`string`	Optional. Database username. Defaults to `magento`
`stacker_variables`	`object`	Optional configurations for MySQL.
↳`mysql.variant`	`string`	Engine variant (e.g., `mysql`, `aurora-mysql`). Default depends on the plan size.
↳`mysql.version`	`string`	`"8.0"` / `"8.0.mysql_aurora.3.06.0"`	Engine version override. Defaults to `"8.0"` for the `mysql` variant and `"8.0.mysql_aurora.3.06.0"` for the `aurora-mysql` variant.
↳`mysql.snapshot_identifier`	`string`	Snapshot identifier to restore the database from.

Example:

{
  "type": "rds",
  "environment": "/v2/environments/tu8aovkn7waj",
  "service": "/v2/services/2tpkjj7e0b28",
  "name": "RDS",
  "variables": {
    "size": "medium",
    "region": "us-east-1",
    "data_subnets": "/v2/stacks/4d4d1d4koe12/outputs/data_subnets"
    "stacker_variables":{
      "mysql": {
        "snapshot_identifier": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:my-snapshot-08242026"
      }
    }
  }
}

Outputs

Output name	Description
`db_endpoint`	The connection endpoint for the RDS database.
`db_password_secret_name`	The name of the Secrets Manager secret containing the RDS password.

Have questions not answered here? Contact Support to get more help.

Last modified on September 9, 2026