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_gamelift_fleet - Incorrect docs #1417

Open
novekm opened this issue Jan 29, 2024 · 2 comments
Open

awscc_gamelift_fleet - Incorrect docs #1417

novekm opened this issue Jan 29, 2024 · 2 comments
Labels
documentation service/gamelift upstream-aws Unable to proceed due to missing or broken functionality from an AWS dependency.

Comments

@novekm
Copy link
Contributor

novekm commented Jan 29, 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.

Affected Resource(s)

Important Factoids

The docs for the awscc_gamelift_fleet are currently incorrect for the apply_capcity attribute. Current docs list the description as:

(String) ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer.

However, the correct description (from the AWS::GameLift::Fleet resource in the CloudFormation Registry) is:

Current resource capacity settings in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region.

References

@wellsiau-aws wellsiau-aws added documentation upstream-aws Unable to proceed due to missing or broken functionality from an AWS dependency. service/gamelift and removed needs-triage labels Feb 26, 2024
@wellsiau-aws
Copy link
Collaborator

We use auto-generate the attribute description in Terraform registry from the underlying schema, the right place to update this description will be upstream on the GameLift resource schema at Cfn registry.

@quixoticmonk
Copy link
Collaborator

@novekm Does the current update look right ? I didn't want to close the issue without asking if this was a better explanation of the field input or needed to be updated.

(String) Determines whether to apply fleet or location capacities on fleet creation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation service/gamelift upstream-aws Unable to proceed due to missing or broken functionality from an AWS dependency.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants