aws / aws/aws-cdk

aws-cdk-lib/aws_ecs_patterns: QueueProcessingFargateServiceProps is missing TaskImageOptions property

Open
#23,289 1 comment 0 reactions 0 assignees View on GitHub
@aws-cdk/aws-ecs-patterns bug documentation effort/small p2
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

### Describe the issue

The [*QueueProcessingFargateServiceProps* public documentation](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs_patterns.QueueProcessingFargateServiceProps.html#taskdefinition) allows for a `TaskDefinition` property, but the description is:

> The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.

However, **`TaskImageOptions` does not exist.**

I can see [in sister FargateService patterns](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs_patterns.NetworkLoadBalancedFargateServiceProps.html#taskimageoptions) that `TaskImageOptions` exists, is optional, and replaces the mandatory `Image` property. Can that be ported over to *QueueProcessingFargateServiceProps*?

[sort-of-related-issue](https://github.com/aws/aws-cdk/issues/16297)

### Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs_patterns.QueueProcessingFargateServiceProps.html#taskdefinition

Contributor guide

Open the contributing guide

Research direction

Start by comparing QueueProcessingFargateServiceProps with the NetworkLoadBalancedFargateServiceProps documentation and implementation, then review related issue #16297. Done means QueueProcessingFargateServiceProps supports the documented optional TaskImageOptions alternative to TaskDefinition, with behavior and public documentation kept consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, typescript
Domain
cloud, infrastructure
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.