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

awscc_lightsail_alarm: Wrong description for the monitored_resource_name argument #1821

Closed
acwwat opened this issue Jun 16, 2024 · 3 comments

Comments

@acwwat
Copy link
Contributor

acwwat commented Jun 16, 2024

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
  • The resources and data sources in this provider are generated from the CloudFormation schema, so they can only support the actions that the underlying schema supports. For this reason submitted bugs should be limited to defects in the generation and runtime code of the provider. Customizing behavior of the resource, or noting a gap in behavior are not valid bugs and should be submitted as enhancements to AWS via the CloudFormation Open Coverage Roadmap.

Terraform CLI and Terraform AWS Cloud Control Provider Version

Affected Resource(s)

  • awscc_lightsail_alarm

Terraform Configuration Files

n/a

Debug Output

n/a

Panic Output

n/a

Expected Behavior

The resource documentation should show a proper description for the monitored_resource_name argument, such as what's in the API reference:

The name of the Lightsail resource that will be monitored.

Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.

Resource Type definition for AWS::Lightsail::Certificate

Actual Behavior

The resource documentation has an unrelated description for the monitored_resource_name:

The validation status of the SSL/TLS certificate.

Steps to Reproduce

  1. Check the description of the monitored_resource_name argument in the resource documentation

Important Factoids

n/a

References

n/a

@quixoticmonk
Copy link
Collaborator

Thank you for opening the issue @acwwat . I have opened a PR on the lightsail providers documentation to fix this.

@godduv-amzn
Copy link

This issue has been fixed and merged in this PR: aws-cloudformation/aws-cloudformation-resource-providers-lightsail#70.

@quixoticmonk
Copy link
Collaborator

Closing this issue based on the documentation update below.
Screenshot 2024-07-26 at 10 24 20

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

No branches or pull requests

3 participants