apigatewayv2: add arnForExecuteAPI method to HTTP API and WebSocket API construct

[tmokmss]

Describe the feature

RestApi construct has arnForExecuteAPI method to get ARN for its execute-api resource easily.
HttpApi and WebSocketApi should have the same method to be more consistent between apigateway and apigatewayv2 modules.

Use Case

Get ARN for execute-api of v2 API Gateways easily.

Proposed Solution

Since the formats of these ARNs are basically the same, we can copy the API of RestAPI construct. More details are in this document.

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.53.0

Environment details (OS name and version, etc.)

n/a

[peterwoodworth]

I'm not super familiar with apigateway as a service, but it doesn't seem evident to me based on the docs that this feature exists for both HTTP and WebSocket APIs. There's this page for REST APIs. A similar page exists for WebSocket APIs, however it will require additional setup which wouldn't make the same method work. I didn't find a page on invoking HTTP APIs, though I expect this method would work for HTTP APIs.

If we are able to port this to at least one of the API constructs in v2, it should be pretty simple 🙂

aws-cdk/packages/@aws-cdk/aws-apigateway/lib/restapi.ts

Lines 378 to 393 in 9f41881

	public arnForExecuteApi(method: string = '*', path: string = '/*', stage: string = '*') {
	if (!Token.isUnresolved(path) && !path.startsWith('/')) {
	throw new Error(`"path" must begin with a "/": '${path}'`);
	}
	if (method.toUpperCase() === 'ANY') {
	method = '*';
	}
	return Stack.of(this).formatArn({
	service: 'execute-api',
	resource: this.restApiId,
	arnFormat: ArnFormat.SLASH_RESOURCE_NAME,
	resourceName: `${stage}/${method}${path}`,
	});
	}

[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.