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

Update documentation for type_name attribute on aws_kinesis_firehose_delivery_stream resource #15036

Closed
clebio opened this issue Sep 4, 2020 · 4 comments · Fixed by #15326
Closed
Labels
documentation Introduces or discusses updates to documentation. good first issue Call to action for new contributors looking for a place to start. Smaller or straightforward issues. service/firehose Issues and PRs that pertain to the firehose service.
Milestone

Comments

@clebio
Copy link

clebio commented Sep 4, 2020

The documentation for kinesis_firehose_delivery_stream states that type_name is required:

type_name - (Required) The Elasticsearch type name with maximum length of 100 characters.

This is no longer accurate.

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 v0.12.28
+ provider.aws v3.5.0

Affected Resource(s)

  • kinesis_firehose_delivery_stream

Terraform Configuration Files

resource "aws_kinesis_firehose_delivery_stream" "waf" {
  name        = "aws-waf-logs-es"
  destination = "elasticsearch"
  # ...

  elasticsearch_configuration {
     # ...
   type_name  = "waf" 
  }
}

Debug Output

n/a

Panic Output

n/a

Expected Behavior

plan/apply doesn't fail

Actual Behavior

Error: error creating Kinesis Firehose Delivery Stream: InvalidArgumentException: Types are deprecated in Elasticsearch version 7.7. TypeName must be empty.

Steps to Reproduce

  1. terraform apply -auto-approve

Important Factoids

n/a

References

@ghost ghost added the service/firehose Issues and PRs that pertain to the firehose service. label Sep 4, 2020
@clebio clebio changed the title Update documentation for type_name attribute on aws_kinesis_firehose_delivery_stream resource Update documentation for type_name attribute on aws_kinesis_firehose_delivery_stream resource Sep 4, 2020
@github-actions github-actions bot added the needs-triage Waiting for first response or review from a maintainer. label Sep 4, 2020
@bflad bflad added documentation Introduces or discusses updates to documentation. good first issue Call to action for new contributors looking for a place to start. Smaller or straightforward issues. and removed needs-triage Waiting for first response or review from a maintainer. labels Sep 9, 2020
@bflad
Copy link
Contributor

bflad commented Sep 9, 2020

Hi @clebio 👋 Thank you for reporting this and sorry you ran into trouble here. This does appear to be outdated documentation. The current resource schema does denote this as optional instead of required:

https://github.com/terraform-providers/terraform-provider-aws/blob/374a49a5878e95a70e7c2a4f3cb88a6e68da8df0/aws/resource_aws_kinesis_firehose_delivery_stream.go#L1218-L1222

If you or anyone is interested in updating the documentation for this argument, it can be found in the website/docs/r/kinesis_firehose_delivery_stream.html.markdown file in this repository. 👍

@anGie44
Copy link
Contributor

anGie44 commented Sep 24, 2020

The documentation update has been merged and will be reflected in v3.8.0 of the provider, likely out this Thursday.

@ghost
Copy link

ghost commented Sep 24, 2020

This has been released in version 3.8.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 for triage. Thanks!

@ghost
Copy link

ghost commented Oct 24, 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 feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!

@ghost ghost locked as resolved and limited conversation to collaborators Oct 24, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Introduces or discusses updates to documentation. good first issue Call to action for new contributors looking for a place to start. Smaller or straightforward issues. service/firehose Issues and PRs that pertain to the firehose service.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants