Fix typo in aws_medialive_channel documentation

[justinretzolk]

Description

This PR fixes a typo in the aws_medialive_channel documentation, so that the docs match the underlying schema.

Important

As called out in the comments below, the field in the SDK is actually FailoverConditions, as the docs currently list. If I'm not mistaken, making that change would be considered breaking, so I'm interested in input on which way to go with this.

Relations

Closes #33407
Closes #33550

References

Schema

Output from Acceptance Testing

N/a, docs

[github-actions]

Community Note

Voting for Prioritization

• Please vote on this pull request by adding a 👍 reaction to the original post to help the community and maintainers prioritize this pull request.
• Please see our prioritization guide for information on how we prioritize.
• 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.

For Submitters

• Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
• For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
• Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

[gbw]

Looks like the schema should be updated to match docs. https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/medialive/types#AutomaticInputFailoverSettings

[justinretzolk]

Hey @gbw 👋 Nice catch! I agree with you that updating the schema to more accurately match the SDK is probably the better way to go about this. I think that would be classified as a breaking change, so I'll wait on one of the provider team folks to chime in as well to see how they'd like to go about it.

[gbw]

Sounds good to me. Just for reference the flatten/expand for this type was only just added in 5.16.0.

[jar-b]

LGTM 👍

For arguments which are arrays in the AWS API, but represented as blocks in the AWS Provider, we often adopt singular versions of the attribute name for improved readability. In this instance,

resource "aws_medialive_channel" "example" {
  # this would be nested in a real configuration, but for simplicity is represented as a root argument here
  failover_condition {
    # condition 1
  }
  failover_condition {
    # condition 2  
  }
}

Reads slightly better than having multiple blocks titled failure_conditions

resource "aws_medialive_channel" "example" {
  failover_conditions {
    # condition 1
  }
  failover_conditions {
    # condition 2  
  }
}

In this case my personal opinion is that the documentation update is sufficient.

[gbw]

Please update the other failure_conditions references in support of this change.

[gbw]

Thanks for the context @jar-b. I think this case is a little odd since within a failure conditions block multiple conditions can be set (i.e. audio, input, and/or video).

[evelynhathaway]

I don't think this is a typo in the documentation, or at least not only the documentation. The field doesn't work because half of the code uses the the old value and half uses the new value.

We've the opportunity to pick the pluralization that we want here since I don't think this field ever worked, so would not be a breaking change in my book.

See my comment on a related issue #33550 (comment)

[gbw]

@justinretzolk could you add this change or would you prefer a separate pull request to fix?

[github-actions]

Thank you for your contribution! 🚀

A new usage of AWS SDK for Go V1 was detected. Please prefer AWS SDK for Go V2 for all net-new services. If this is an enhancement or bug fix to an existing AWS SDK Go V1 based resource, this comment can be safely ignored.

For additional information refer to the AWS SDK for Go Versions page in the contributor guide.

[justinretzolk]

Hey @gbw @evelynhathaway 👋 Thank you for the additional input here! I've pushed additional changes to address those points as well.

[github-actions]

This functionality has been released in v5.31.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]

I'm going to lock this pull request 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 related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.