Occasionally you might want to rename an AWS S3 bucket you are managing with Terraform. However, the names of S3 buckets are immutable, which means you can’t change them directly. 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 , move the data over to it, make the relevant Terraform state replacements, and finally delete the old bucket. create a new bucket with the desired name In this post, you will learn how to rename an AWS S3 bucket in Terraform. First things first – 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 Firstly, we’ll need You can do this using the AWS CLI or the . Just make sure to properly replicate the old settings, especially the ACL (so that your data doesn’t accidentally become public). to create a new bucket. AWS console 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 the new one in its place: import 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 would be! We’ve just imported a bucket into a resource which still has in the config. old-name 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 - Do a 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 Make sure all the data has successfully been copied over to the new bucket. Step 5 - Run the Above Arbitrary AWS CLI Commands if You’re Using Spacelift If you’re using Spacelift then you can use to run the above arbitrary AWS CLI commands. The default runner image already contains the AWS CLI, so no changes are necessary there. tasks One additional thing you can do is while you’re running the migration, this way nobody will accidentally run Terraform or make any other changes while you’re moving the data. lock the Stack And that’s it! If you have any questions about how to rename an AWS S3 bucket, drop me a line in the comments and I’ll get back to you straight away. First Published here

Amazon

Change the Name of your AWS S3 Bucket in Terraform Without Breaking Things

About Author

Comments

TOPICS

THIS ARTICLE WAS FEATURED IN

Related Stories

Finessing Postgres into an Insane 200x Faster Query Plan

101 Stories To Learn About Cloud Infrastructure

10 Things in Engineering We Don't Spend Enough Time On

10 Things I Did To Increase CloudTrail Logs Security

10 reasons to give cloud computing a go

10 Lessons from 10 Years of AWS (part 1)

Finessing Postgres into an Insane 200x Faster Query Plan

101 Stories To Learn About Cloud Infrastructure

10 Things in Engineering We Don't Spend Enough Time On

10 Things I Did To Increase CloudTrail Logs Security

10 reasons to give cloud computing a go

10 Lessons from 10 Years of AWS (part 1)

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps