[Docs]: EventBridge Scheduler incorrect assign_public_ip documentation

[ghost]

Documentation Link

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/scheduler_schedule

Description

The documentation referring to assign_public_ip which belongs in the network_configuration block, which belongs in the ecs_parameters block, which belongs in the target block, is incorrect.

The documentation says:

assign_public_ip - (Optional) Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when the launch_type is set to FARGATE. One of: ENABLED, DISABLED.

but if you run it using something like assign_public_ip = "DISABLED" you will be greeded with a Terraform validation error that says:

Error: Incorrect attribute value type
on scheduler.tf line 24, in resource "aws_scheduler_schedule" "ecs_task_schedule":
24: assign_public_ip = "DISABLED"
Inappropriate value for attribute "assign_public_ip": a bool is required.

so clearly the correct value (validated by terraform validate) should be assign_public_ip = false

FURTHERMORE. The documentation for this resource type is EXTREMELY lacking. There are absolutely NO examples covering how one might use this to trigger an ECS task.

References

No response

Would you like to implement a fix?

None

[github-actions]

Community Note

Voting for Prioritization

• Please vote on this issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize this 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.

Volunteering to Work on This Issue

• If you are interested in working on this issue, please leave a comment.
• If this would be your first contribution, please review the contribution guide.

[github-actions]

This functionality has been released in v4.59.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 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.