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

docs(stepfunctions): integrationPattern update #29015

Merged
merged 2 commits into from
Feb 7, 2024
Merged

docs(stepfunctions): integrationPattern update #29015

merged 2 commits into from
Feb 7, 2024

Conversation

Rizxcviii
Copy link
Contributor

@Rizxcviii Rizxcviii commented Feb 7, 2024

Issue # (if applicable)

Closes #21915 . (Doesn't close it, but solves a point that was mentioned here)

Reason for this change

The prop is pretty useful, but hasn't received enough documentation from my perspective. This adds documentation to the overview README as well it's own jsdoc.

Description of changes

Added a section for the integrationPattern into the README, and updated the jsdoc to include more detailed information.

Description of how you validated changes

No validation.

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@aws-cdk-automation aws-cdk-automation requested a review from a team February 7, 2024 14:40
@github-actions github-actions bot added valued-contributor [Pilot] contributed between 6-12 PRs to the CDK effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 labels Feb 7, 2024
@Rizxcviii Rizxcviii changed the title doc(step-functions): integrationPattern update docs(step-functions): integrationPattern update Feb 7, 2024
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 9c5f521
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Feb 7, 2024
@kaizencc kaizencc changed the title docs(step-functions): integrationPattern update docs(stepfunctions): integrationPattern update Feb 7, 2024
Copy link
Contributor

@kaizencc kaizencc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Rizxcviii

@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Feb 7, 2024
Copy link
Contributor

mergify bot commented Feb 7, 2024

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit a7c526a into aws:main Feb 7, 2024
35 checks passed
@Rizxcviii Rizxcviii deleted the feature/integration-pattern-doc-update branch February 7, 2024 15:19
TheRealAmazonKendra pushed a commit that referenced this pull request Feb 9, 2024
### Issue # (if applicable)

Closes #21915 . (Doesn't close it, but solves a point that was mentioned here)

### Reason for this change

The prop is pretty useful, but hasn't received enough documentation from my perspective. This adds documentation to the overview `README` as well it's own jsdoc.

### Description of changes

Added a section for the `integrationPattern` into the README, and updated the jsdoc to include more detailed information.

### Description of how you validated changes

No validation.

### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

*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
Labels
effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 valued-contributor [Pilot] contributed between 6-12 PRs to the CDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

aws-stepfunctions-tasks: Enable creation of 'sync' states for AWS optimized integrations
3 participants