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

Open
clebio opened this issue Sep 4, 2020 · 1 comment

Comments

@clebio
Copy link

@clebio 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

@hashibot hashibot bot added the service/firehose label Sep 4, 2020
@clebio clebio changed the title Update documentation for `type_name` attribute on `aws_kinesis_firehose_delivery_stream` resource Sep 4, 2020
@bflad
Copy link
Contributor

@bflad 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:

"type_name": {
Type: schema.TypeString,
Optional: true,
ValidateFunc: validation.StringLenBetween(0, 100),
},

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. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.