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

[lucascott]

Describe the feature

For integrated services such as AWS Batch and Amazon ECS, Step Functions can wait for a request to complete before progressing to the next state. To have Step Functions wait, specify the "Resource" field in your task state definition with the .sync suffix appended after the resource URI.

https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync

This feature is not yet available in CDK.

Use Case

Creating synchronized state machines

Proposed Solution

Add syncronized property of type boolean to all optimized integration tasks that support it.
If set, the resource key for the task will concatenate the .sync suffix at the end of the value.

Example:

from "Resource": "arn:aws:states:::batch:submitJob" to (with syncronized: true) "Resource": "arn:aws:states:::batch:submitJob.sync",

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

CDK version used

2.40.0 (build 56ba2ab)

Environment details (OS name and version, etc.)

Ubuntu 20.04.4 LTS

[kaizencc]

As always, we can use customState as a workaround. Would be happy to accept a contribution for this!

[psalvaggio-dl]

+1 on this issue. This would be a big help!

[lucascott]

From further research, the feature is already available yet not well documented. The way to define synchronous optimized integration steps (for those steps that support it) in CDK is by specifying the integration pattern property.

See

aws-cdk/packages/@aws-cdk/aws-stepfunctions/lib/states/task-base.ts

Line 93 in 74318c7

readonly integrationPattern?: IntegrationPattern;

import {IntegrationPattern} from "aws-cdk-lib/aws-stepfunctions";
// ...
{
// ...other params
integrationPattern: IntegrationPattern.RUN_JOB
}

[github-actions]

⚠️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.

[lauragalera]

I've tried IntegrationPattern.RUN_JOB and it seems to be ignored on my GlueStartJobRun() construct. Code example on this other issue