rds: export db snapshot data to S3

[aviau]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

It would be great if the provider allowed for exporting db snapshot data to S3 as documented here:

• https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_ExportSnapshot.html

New or Affected Resource(s)

• aws_rds_*

[abhinaysutrakar]

Hi ,

Do we have any update in which version this enhancement can be available?

[GISTech01]

Any update on the following?

[debu99]

any update

[Felistas]

Any update?

[Kristin0]

any update

[jar-b]

Since this aligns with the ExportTask API's a resource could look something like the following (to be paired with the cluster_snapshot resource):

resource "aws_db_export_task" "example" {
  export_task_identifier = "my_snapshot_export"
  source_arn             = "arn:aws:rds:AWS_Region:123456789012:snapshot:snapshot_name"
  s3_bucket_name         = "my_export_bucket"
  iam_role_arn           = "iam_role" # actually an IAM role name
  kms_key_id             = "my_key"
}

API Docs:

• https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartExportTask.html
• https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeExportTasks.html
• https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CancelExportTask.html

[jar-b]

Edit: After researching the behavior of these API's, this is a borderline terraform resource candidate due to the absence of a traditional CRUD workflow. Once started, export tasks run until completion or failure and cannot be deleted (only cancelled). There are no Update* or Delete* API's, and no single Get* API (though ListExportTasks returns all tasks). If implemented, the alternative behavior for read, update, and delete would need to be carefully considered.

If the decision is made to move forward, a write-up for this proposed resource is documented below.

---

Workflow Behavior

The proposed behavior on read, update, and delete is as follows:

• Read - Use ListExportTasks to page through all tasks until a match is found or the list is exhausted.
  • We have submitted a support case for adding a GetExportTasks API, but have no information on whether this will be added or any potential timing.
• Update - A change to any required or optional attribute will force replacement (destroy + create).
• Delete - Destruction of an "in-progress" task will cancel the task and remove from state. Destruction of a completed or failed task will simply remove the resource from state.

API Implementations

service/rds

Export Task

• StartExportTask
• DescribeExportTasks
• CancelExportTask

Potential Terraform Features

New Resource: aws_rds_export_task

Rationale: Allow practitioners to manage RDS export tasks.

Potential Terraform Configuration:

resource "aws_rds_export_task" "example" {
  # required attributes
  export_task_identifier = "my_snapshot_export"
  iam_role_arn           = "iam_role" # actually an IAM role name
  kms_key_id             = "my_key"
  s3_bucket_name         = "my_export_bucket"
  source_arn             = "arn:aws:rds:AWS_Region:123456789012:snapshot:snapshot_name"

  # optional attributes
  export_only = ["database.table mytable"]
  s3_prefix   = "my_prefix/my-export-name"
}

Arguments:

• export_task_identifier - (Required) Unique identifier for the snapshot export task.

• iam_role_arn - (Required) Amazon Resource Name (ARN) of the IAM role to use for writing to the Amazon S3 bucket.

• kms_key_id - (Required) ID of the Amazon Web Services KMS key to use to encrypt the snapshot.

• s3_bucket_name - (Required) Name of the Amazon S3 bucket to export the snapshot to.

• source_arn - (Required) Amazon Resource Name (ARN) of the snapshot to export.

• export_only - (Optional) Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the AWS StartExportTask API documentation.

• s3_prefix - (Optional) Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

Attributes:

• failure_cause - Reason the export failed, if it failed.
• id - Unique identifier for the snapshot export task (same value as export_task_identifier).
• percent_progress - Progress of the snapshot export task as a percentage.
• snapshot_time - Time that the snapshot was created.
• source_type - Type of source for the export.
• status - Status of the export task.
• task_end_time - Time that the snapshot export task completed.
• task_start_time - Time that the snapshot export task started.
• warning_message - Warning about the snapshot export task, if any.

[github-actions]

This functionality has been released in v4.51.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.