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.

Sign up for GitHub

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

Jump to bottom

(stepfunctions-tasks): documented wrong default value of integrationPattern field for EMR step function tasks #19815

Closed
lafeuil opened this issue Apr 8, 2022 · 2 comments · Fixed by #19936
Closed

(stepfunctions-tasks): documented wrong default value of integrationPattern field for EMR step function tasks #19815

lafeuil opened this issue Apr 8, 2022 · 2 comments · Fixed by #19936
Labels
@aws-cdk/aws-stepfunctions-tasks documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2

Comments

@lafeuil
Copy link

lafeuil commented Apr 8, 2022

Describe the issue

In the documentation of EMR step function tasks, the default value of integrationPattern is IntegrationPattern.REQUEST_RESPONSE. For example with the EmrCreateCluster task.

But, in the code, the integrationPattern field is initialized with IntegrationPattern.RUN_JOB.

Affected EMR step function tasks : EmrCreateCluster, EmrAddStep, EmrTerminateCluster

Links
@lafeuil lafeuil added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Apr 8, 2022
@github-actions github-actions bot added the @aws-cdk/aws-emr Related to Amazon EMR label Apr 8, 2022
@kaizencc kaizencc added @aws-cdk/aws-stepfunctions-tasks and removed @aws-cdk/aws-emr Related to Amazon EMR labels Apr 15, 2022
@kaizencc kaizencc changed the title Mismatch with the default value of integrationPattern field for EMR step function tasks (stepfunctions-tasks): documented wrong default value of integrationPattern field for EMR step function tasks Apr 15, 2022
@kaizencc kaizencc added p2 effort/small Small work item – less than a day of effort and removed needs-triage This issue or PR still needs to be triaged. labels Apr 15, 2022
@kaizencc kaizencc removed their assignment Apr 15, 2022
@kaizencc
Copy link
Contributor

Thanks for the report @lafeuil! PR incoming.

@kaizencc kaizencc mentioned this issue Apr 15, 2022
Merged
4 tasks
@mergify mergify bot closed this as completed in #19936 Apr 15, 2022
mergify bot pushed a commit that referenced this issue Apr 15, 2022
@kaizencc
fix(stepfunctions): incorrect default documentation for integrationPa…
4cb3b2b 
…ttern (#19936)

Fixes #19815

----

### All Submissions:

* [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md)

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/master/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

StevePotter pushed a commit to StevePotter/aws-cdk that referenced this issue Apr 27, 2022
@kaizencc
fix(stepfunctions): incorrect default documentation for integrationPa…
ccbeb84 
…ttern (aws#19936)

Fixes aws#19815

----

### All Submissions:

* [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md)

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/master/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
@aws-cdk/aws-stepfunctions-tasks documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(stepfunctions): incorrect default documentation for integrationPattern aws/aws-cdk
2 participants
@lafeuil @kaizencc