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

docs(stepfunctions): integrationPattern update #29015

Merged
merged 2 commits into from
Feb 7, 2024
Merged

docs(stepfunctions): integrationPattern update #29015

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86999f3
adding doc for integrationpattern
Feb 7, 2024
9c5f521
reverting prettier
Feb 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions packages/aws-cdk-lib/aws-stepfunctions/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -708,6 +708,22 @@ const submitJob = new tasks.LambdaInvoke(this, 'Submit Job', {
See [the AWS documentation](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html)
to learn more about AWS Step Functions support for accessing resources in other AWS accounts.

## Service Integration Patterns

AWS Step functions integrate directly with other services, either through an optimised integration pattern, or through the AWS SDK.
Therefore, it is possible to change the `integrationPattern` of services, to enable additional functionality of the said AWS Service:

```ts
import * as glue from "@aws-cdk/aws-glue-alpha";

declare const submitGlue: glue.Job;

const submitJob = new tasks.GlueStartJobRun(this, "Submit Job", {
glueJobName: submitGlue.jobName,
integrationPattern: sfn.IntegrationPattern.RUN_JOB,
});
```

## State Machine Fragments

It is possible to define reusable (or abstracted) mini-state machines by
Expand Down
6 changes: 4 additions & 2 deletions packages/aws-cdk-lib/aws-stepfunctions/lib/states/task-base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,11 @@ export interface TaskStateBaseProps {

/**
* AWS Step Functions integrates with services directly in the Amazon States Language.
* You can control these AWS services using service integration patterns
* You can control these AWS services using service integration patterns.
*
* @see https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
* Depending on the AWS Service, the Service Integration Pattern availability will vary.
*
* @see https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html
*
* @default - `IntegrationPattern.REQUEST_RESPONSE` for most tasks.
* `IntegrationPattern.RUN_JOB` for the following exceptions:
Expand Down
Loading