@aws-cdk/aws-apigateway module: Add ability to reference execution log group ARN or Name

[covertbert]

Adding the ability to reference the log group ARN or name that is generated by the RestApi construct.

Use Case

To be able to do anything at all with the log group that gets generated (e.g. add a subscription filter) you need to be able to dynamically reference the name or ARN.

Proposed Solution

Either:

• Create a readonly property on the instantiated RestApi class called logGroupName or logGroupArn that can be referenced by other constructs.

• Or, add the ability to set the execution log group name (like you can with access logs) so that you can have a consistent name to reference the log group by.

• 👋 I may be able to implement this feature request

• ⚠️ This feature might incur a breaking change

---

This is a 🚀 Feature Request

[nija-at]

As far as I am aware, the RestApi construct does not create any log groups.
Which logs are you talking about?

[covertbert]

@nija-at it does create log groups for execution logs. If you want access logs then you create the log group yourself and pass it to RestApi

[nija-at]

@covertbert - unfortunately, the CDK does not create these execution logs. They are created automatically by the API Gateway service.

It seems that the log group is always of the format API-Gateway-Execution-Logs_${RestApiId}/${Stage}.
We could apply a logic similar to what we do in the aws-lambda module using the LogRetention construct to get you the execution logs, applied on the Stage construct -

aws-cdk/packages/@aws-cdk/aws-lambda/lib/function.ts

Lines 850 to 859 in 2023004

	public get logGroup(): logs.ILogGroup {
	if (!this._logGroup) {
	const logRetention = new logs.LogRetention(this, 'LogRetention', {
	logGroupName: `/aws/lambda/${this.functionName}`,
	retention: logs.RetentionDays.INFINITE,
	});
	this._logGroup = logs.LogGroup.fromLogGroupArn(this, `${this.node.id}-LogGroup`, logRetention.logGroupArn);
	}
	return this._logGroup;
	}

.

A workaround is to simply refer the log group by using LogGroup.fromLogGroupId() API in the format presented above.

I am unassigning and marking this issue as p2, which means that we are unable to work on this immediately.

We use +1s to help prioritize our work, and are happy to revaluate this issue based on community feedback. We accept pull requests if you are interested in contributing this feature.

[covertbert]

@nija-at makes sense. The only problem with referencing by a hard-coded ID is that IDs can change when resources are recreated. I was kinda hoping that you'd be able to expose the current ID dynamically. Appreciate this is low priority though, thanks for looking into it.

[nija-at]

You should not hardcode the id. Instead, you use restApi.restApiId

[covertbert]

Ahh that makes sense, thanks!

Edit: But surely the restApiId is not the same as log group id needed in fromLogGroupId?

[shellscape]

Worth noting for anyone stopping by here, that LogGroup.fromLogGroupId is no longer an available static method.

[github-actions]

This issue has not received any attention in 1 year. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.

[shellscape]

yup

[rmontoya12]

It would be nice to specify execution log group.