Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

(aws-dynamodb): TableV2 should explicitly document that it translate to a CFN AWS::DynamoDB::GlobalTable #32407

Open
naranj4 opened this issue Dec 6, 2024 · 1 comment
Labels
@aws-cdk/aws-dynamodb Related to Amazon DynamoDB documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p3

Comments

@naranj4
Copy link

naranj4 commented Dec 6, 2024

Describe the issue

Most of the external documentation seems to indicate that TableV2 (and AWS::DynamoDB::GlobalTable) should be preferred going forward.

However, AWS::DynamoDB::GlobalTable is different to AWS::DynamoDB::Table and the distinction should be made in the docstring at minimum so that users are aware of the differences.

Related: #28976

Links

The existing CDK documentation does not make a clear distinction between the two constructs:

@naranj4 naranj4 added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Dec 6, 2024
@github-actions github-actions bot added the @aws-cdk/aws-dynamodb Related to Amazon DynamoDB label Dec 6, 2024
@khushail khushail added investigating This issue is being investigated and/or work is in progress to resolve the issue. p2 and removed needs-triage This issue or PR still needs to be triaged. labels Dec 6, 2024
@khushail khushail self-assigned this Dec 6, 2024
@khushail
Copy link
Contributor

khushail commented Dec 7, 2024

Hi @naranj4 , thanks for reaching out. Yes, there has been consistent ask about Table and TableV2 , citing different issues( like this one -#28976), and yes TableV2 translates to CfnGlobalTable and Table does to CfnTable. so it would definitely be helpful to have little bit more documentation around these concepts. So marking it as P3 as it would be good to have and contributions from community are welcome!

@khushail khushail added p3 effort/small Small work item – less than a day of effort and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. p2 labels Dec 7, 2024
@khushail khushail removed their assignment Dec 7, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
@aws-cdk/aws-dynamodb Related to Amazon DynamoDB documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p3
Projects
None yet
Development

No branches or pull requests

2 participants