How to rename an AWS S3 bucket in Terraform - step by step

How to rename an AWS S3 bucket in Terraform – step by step

How to rename an AWS S3 bucket in Terraform – step by step

Occasionally you might want to rename an AWS S3 bucket you are managing with Terraform. However names of S3 buckets are immutable, so you can’t directly change them. If you tried, Terraform would destroy the old one and then create a new one, resulting in data loss.

To avoid this you need to create a new bucket with the desired name, move the data over to it, make the relevant terraform state replacements, and finally delete the old bucket. Let’s say you have a bucket definition in your Terraform code:

resource “aws_s3_bucket” “my_bucket” {
    bucket = “old-name”
}

and you want to change the name of the bucket to new-name.

Step 1 - Create the new bucket

First of all, we’ll have to create a new bucket. You can do this using the AWS CLI or the AWS console. Just make sure to properly replicate the old settings, especially the ACL (so your data won’t accidentally be made public).

Now we can copy all the files from the old to the new bucket:

aws s3 sync s3://old-name s3://new-name

Step 2 - Modify the state

Now that we have our new bucket, we need to remove the old one from our Terraform state and import the new one in its place:

terraform state rm aws_s3_bucket.my_bucket
terraform import aws_s3_bucket.my_bucket new-name

If you tried to run terraform now, it would show you that there’s drift – and yes, there is! We’ve just imported a bucket into a resource which still has old-name in the config.

Step 3 - Change the code

That’s why we now have to finally change the name of the bucket in our Terraform config:

resource “aws_s3_bucket” “my_bucket” {
    bucket = “new-name”
}

If you run terraform now, you’ll see that there are no changes to be made.

Step 4 - Cleanup

If you want to, you can now delete your old bucket using:

aws s3 rm s3://old-name --recursive
aws s3 rb s3://old-name

Just make sure all the data has successfully been copied over to the new bucket.

If you’re using Spacelift

If you’re using Spacelift then you can use tasks to run the above arbitrary AWS CLI commands. The default runner image already contains the AWS CLI, so no changes necessary there.

One additional thing you can do is lock the Stack while you’re running the migration, this way nobody will accidentally run Terraform or make any other changes while you’re moving the data.

Share this post

twitter logo

Comments