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

aws_cdk.aws_kinesisfirehose.CfnDeliveryStream: buffering hints size_in_m_bs example incorrect. #29138

Open
Outrun207 opened this issue Feb 16, 2024 · 3 comments · May be fixed by aws/jsii#4644
Labels
@aws-cdk/aws-kinesisfirehose Related to Amazon Kinesis Data Firehose bug This issue is a bug. docs/generated Related to the generated API Reference documentation documentation This is a problem with documentation. effort/medium Medium work item – several days of effort p3

Comments

@Outrun207
Copy link

Describe the issue

The example for the aws_cdk.aws_kinesisfirehose CfnDeliveryStream buffering hints construct/object incorrectly:

buffering_hints_property = kinesisfirehose.CfnDeliveryStream.BufferingHintsProperty(
    interval_in_seconds=123,
    size_in_mBs=123
)

"size_in_mBs" is incorrect.

It needs to be fixed to read:

buffering_hints_property = kinesisfirehose.CfnDeliveryStream.BufferingHintsProperty(
    interval_in_seconds=123,
    size_in_m_bs=123
)

Links

https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_kinesisfirehose/CfnDeliveryStream.html#aws_cdk.aws_kinesisfirehose.CfnDeliveryStream.BufferingHintsProperty

@Outrun207 Outrun207 added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Feb 16, 2024
@github-actions github-actions bot added the @aws-cdk/aws-kinesisfirehose Related to Amazon Kinesis Data Firehose label Feb 16, 2024
@msambol
Copy link
Contributor

msambol commented Feb 16, 2024

Looks like a doc generation issue..

@pahud
Copy link
Contributor

pahud commented Feb 19, 2024

I can't find any example in aws_cdk.aws_kinesisfirehose. Is it correct link?

@pahud pahud added p2 response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. and removed needs-triage This issue or PR still needs to be triaged. labels Feb 19, 2024
@github-actions github-actions bot removed the response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. label Feb 20, 2024
@tim-finnigan tim-finnigan added bug This issue is a bug. docs/generated Related to the generated API Reference documentation effort/medium Medium work item – several days of effort labels Mar 14, 2024
@pahud pahud added p3 and removed p2 labels Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-kinesisfirehose Related to Amazon Kinesis Data Firehose bug This issue is a bug. docs/generated Related to the generated API Reference documentation documentation This is a problem with documentation. effort/medium Medium work item – several days of effort p3
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants