(ecs-patterns): QueueProcessingFargateService - Allow task role to be specified

[rcollette]

Allow the Role used by the Task created by the service to be specified in configuration

Use Case

Allow for customization of the Role such as setting the role name.

Proposed Solution

I'm torn here. What is really needed is come consistency between the ECS patterns when it comes to configuration. ApplicationLoadBalancedFargateService provides an imageOptions configuration property that contains an optional Role property. QueueProcessingFargateService only has an image property, so it would appear that taskRole would need to be defined on the configuration root.

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

---

This is a 🚀 Feature Request

[madeline-k]

Hello @rcollette, thank you for opening this feature request!

I agree with you that some consistency is needed between the different ECS patterns. Luckily they all have a similar shape except for QueueProcessing<Ec2/Fargate>Service constructs. The change needed here is to deprecate the image property on these two constructs, and add a taskImageOptions property similar to the others. Then you can pass the taskRole property via taskImageOptions.

One other change needed for consistency is that the Scheduled<Ec2/Fargate>Service constructs have a scheduled<Ec2/Fargate>TaskImageOptions construct prop, but both of these are missing a taskRole property. It would be great to add that as well.

If you are up for submitting a PR, we would love to see that! Take a look at the contributing guide if you haven't already.

And you can work around this in the meantime by using an escape hatch. For example:

import constructs;

const queueService = new ecsPatterns.QueueProcessingFargateService(this, 'queueService', {...});
const myRole = constructs.Node.of(queueService.taskDefinition.taskRole).defaultChild as iam.CfnRole;
myRole.roleName = "newName";

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

[rcollette]

first