Incorrect discription in aws_synthetics_canary document.

[1kazuki1]

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

Terraform CLI and Terraform AWS Provider Version

$ terraform version
Terraform v1.1.9
on linux_amd64
+ provider registry.terraform.io/hashicorp/aws v4.13.0

Affected Resource(s)

• aws_synthetics_canary

Terraform Configuration Files

Please include all Terraform configurations required to reproduce the bug. Bug reports without a functional reproduction may be closed without investigation.

resource "aws_synthetics_canary" "sample_canary" {
  name                 = "sample_canary"
  artifact_s3_location = "s3://sample_canary/"
  execution_role_arn   = "sample_canary"
  handler              = "pageLoadBlueprint.handler"
  zip_file             = "canary/sample.zip"
  runtime_version      = "syn-nodejs-puppeteer-3.5"
  start_canary         = true

  schedule {
    expression = "rate(10 minutes)"
  }
  artifact_config {
    s3_encryption {
      encryption_mode = "SSE-S3"
    }
  }
}

Debug Output

Panic Output

Expected Behavior

I can run terraform plan with no error, beacuse encryption_mode support SSE-S3.

• Resource: aws_synthetics_canary doc https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/synthetics_canary

Which one is the correct SSE-S3 or SSE_S3 ?

Actual Behavior

$ terraform plan
╷
│ Error: expected artifact_config.0.s3_encryption.0.encryption_mode to be one of [SSE_S3 SSE_KMS], got SSE-S3
│ 
│   with aws_synthetics_canary.sample_canary,
│   on canary.tf line 15, in resource "aws_synthetics_canary" "sample_canary":
│   15:       encryption_mode = "SSE-S3"
│ 
╵

Steps to Reproduce

1. terraform plan

Important Factoids

References

• 0000

[github-actions[bot]]

This functionality has been released in v4.14.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[bot]]

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.