aws-stepfunctions-tasks: CallApiGatewayRestApiEndpoint assumes StateMachine and the API Gateway are in the same region

[fulcus]

Describe the bug

This code assumes that the API GW is in the same region as the step function, and there is no way to specify any other region.

aws-cdk/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/apigateway/call-rest-api.ts

Line 68 in 060af6c

return `${this.props.api.restApiId}.execute-api.${apiStack.region}.${apiStack.urlSuffix}`;

Regression Issue

• Select this option if this issue appears to be a regression.

Last Known Working CDK Version

No response

Expected Behavior

Be able to specify the region of the API GW.

Current Behavior

Construct assumes that SFn and API GW are in the same region.

Reproduction Steps

Read the code and try to use the CallApiGatewayRestApiEndpoint with an API in another region.

Possible Solution

A good fix would be to add the region as props to RestApi.fromRestApiAttributes, and use that to get the endpoint. Alternatively pass the region as props to CallApiGatewayRestApiEndpoint.

Additional Information/Context

No response

CDK CLI Version

2.162.1

Framework Version

No response

Node.js Version

18

OS

15.1

Language

TypeScript

Language Version

No response

Other information

No response

[khushail]

Hi @fulcus , thanks for reaching out. for cross-region support , we have this- CallAwsServiceCrossRegion and CallAWSServiceCrossRegionProps. Is this what you are looking for ?

[fulcus]

Hi, thanks for the response. That would surely work as a workaround, however it would be nice to have the native task allow the region option. But it seems that it should be rather integrated in all tasks, probably in the base class. Is this something you are planning to do?

[khushail]

@fulcus , I am not really sure about this .
Requesting core team to provide inputs here as this is something being considered to be implemented in future or request to share insights on the issue analysis.

[aaythapa]

Hi there, thanks for opening this issue.

I agree with @khushail that you should use the CallAwsServiceCrossRegion to perform cross-region AWS API calls. CallAwsServiceCrossRegion simplifies the process by automatically creating the necessary custom resource and allowing you to define IAM policies, actions, and other configurations.

don’t believe enabling cross-region API calls is as straightforward as simply adding a region property to the base class (though I could be wrong). CallAwsServiceCrossRegion is the preferred way to handle this use case.

Let me know if you have any questions!

[aaythapa]

Looks like there is already an issue: #26509 and a PR: #33252 related to this problem. Going to close this as its a duplicate and continue discussions in that PR/issue.

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.