DocsSchema ReferenceAurora Restore Service

Aurora Restore Service

Restore AWS Aurora database snapshots for ephemeral environments

The auroraRestore service type restores AWS Aurora database snapshots for use in ephemeral environments. This allows you to test against production-like data.

⚠️

This documentation is still in progress and will be updated shortly with the latest information.

Required Fields

FieldTypeDescription
commandstringCommand to execute for the restore operation
argumentsstringArguments passed to the command

How It Works

  1. When the environment is deployed, Lifecycle executes the configured command with arguments
  2. The command typically triggers an Aurora snapshot restore process
  3. Once complete, the restored database is available for other services

The auroraRestore service type is a specialized service that runs a command to initiate database restoration. The actual restore logic is implemented in your command/script.

Example

Use Cases

  • Production data testing - Test features against realistic production data
  • Database migrations - Validate migrations against production schema
  • Performance testing - Benchmark against production-scale data
  • Bug reproduction - Reproduce issues with production data state
⚠️

When restoring from production snapshots, ensure sensitive data is properly anonymized or that access is appropriately restricted.

Implementation Notes

The restore command is executed as part of the environment deployment process. Your script should:

  1. Handle authentication with AWS
  2. Initiate the snapshot restore
  3. Wait for the restore to complete
  4. Configure network access to the restored instance
  5. Return the connection information

The restored database endpoint can then be referenced by other services using template variables.