Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

provider/aws: Update S3 Bucket Object docs for KMS Key #6309

Merged
merged 1 commit into from
Apr 22, 2016

Conversation

catsby
Copy link
Contributor

@catsby catsby commented Apr 22, 2016

Fixes #6172 with the power of documentation!

Currently our docs for S3 Bucket Object KMS support say this:

* `kms_key_id` - (Optional) Specifies the AWS KMS key ID to use for object encryption

In Terraform terms, this is typically the id: ${aws_kms_key.foo.id}.
In AWS terms, this is... really the arn: ${aws_kms_key.foo.arn}

For creating a bucket object AWS will accept both the unique/random bits at the end of the arn, or the full arn itself as the "ID". Unfortunately when we do a READ on the bucket object, the KMS Key ID will be the full ARN. So users that specify the id will get a reoccurring plan after, as it wants to swap out the ARN it read for the ID is has.

This PR updates the documentation to clarify that you need to use the exported ARN attribute of a KMS Key resource.

@radeksimko
Copy link
Member

As discussed via Slack, this LGTM 👍 , although long-term we could do better (i.e. make it work with id)

I reckon someone will come back here to submit another bug arguing they used id and expected it to just work 😃 and honestly I wouldn't blame them for not reading the note in docs as the field is called kms_key_ID

@catsby catsby merged commit 7aa468f into master Apr 22, 2016
@catsby catsby deleted the b-aws-s3-kms-docs branch April 22, 2016 20:12
@ghost
Copy link

ghost commented Apr 26, 2020

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.

@ghost ghost locked and limited conversation to collaborators Apr 26, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

aws_s3_bucket_object uses kms_key_id attribute inconsistently
2 participants