aws / aws/aws-cdk

aws_ecs_patterns: ScheduledFargateTask (and others)

Open
#27,517 5 comments 0 reactions 0 assignees View on GitHub
@aws-cdk/aws-ecs-patterns documentation effort/small feature-request p2
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
1d 19h
Merged PRs (30d)
71

Description

### Describe the issue

In aws_ecs_pattern.ScheduledFargateTask there are
- scheduled_fargate_task_definition_options
- scheduled_fargate_task_image_options
- task_definition

Difference between the first is clear, but how is the task_definition parameter is related to them?
What is the meaning of "[disable-awslint:ref-via-interface] Default: - none"?

In aws_ecs_patterns.ScheduledFargateTaskDefinitionOptions:
"Image or taskDefinition must be specified, but not both. [disable-awslint:ref-via-interface]" is stated, what makes no sense here.

In aws_ecs_patterns.ScheduledFargateTaskImageOptions:
The parameter
"task_definition (Optional[[FargateTaskDefinition](https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_ecs/FargateTaskDefinition.html#aws_cdk.aws_ecs.FargateTaskDefinition)]) – The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both. [disable-awslint:ref-via-interface] Default: - none"
is not clear to me and how it make sense here.

### Links

https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_ecs_patterns/ScheduledFargateTask.html
https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_ecs_patterns/ScheduledFargateTaskImageOptions.html
https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_ecs_patterns/ScheduledFargateTaskDefinitionOptions.html

Contributor guide

Open the contributing guide

Research direction

Start with the three linked AWS CDK API pages for ScheduledFargateTask, ScheduledFargateTaskImageOptions, and ScheduledFargateTaskDefinitionOptions, then compare the parameter descriptions and their relationships. Done means the documentation clearly explains which alternatives users provide, what task_definition means in each options type, and the meaning of the default and interface-lint notes.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.