chore(ecs-patterns): ScheduledFargateTaskProps is exposing unused props from FargateServiceBaseProps

[lpizzinidev]

ScheduledFargateTaskProps was extending the FargateServiceBaseProps interface.
The only property used from that interface is platformVersion.

This change adds warning messages if the unused properties are specified:

• taskDefinition
• cpu
• memoryLimitMiB
• runtimePlatform

Closes #26702.

---

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

[rix0rrr]

Unfortunately, our dear friend backwards compatibility raises its ugly head again (let me reformat to make this more readable):

API elements with incompatible changes:

err  - IFACE aws-cdk-lib.aws_ecs_patterns.ScheduledFargateTaskProps:
    not assignable to all base types anymore:
        aws-cdk-lib.aws_ecs_patterns.ScheduledFargateTaskProps does not extend aws-cdk-lib.aws_ecs_patterns.FargateServiceBaseProps

err  - PROP aws-cdk-lib.aws_ecs_patterns.ScheduledFargateTaskProps.cpu:
    has been removed

err  - PROP aws-cdk-lib.aws_ecs_patterns.ScheduledFargateTaskProps.memoryLimitMiB:
    has been removed
err  - PROP aws-cdk-lib.aws_ecs_patterns.ScheduledFargateTaskProps.runtimePlatform:
    has been removed
err  - PROP aws-cdk-lib.aws_ecs_patterns.ScheduledFargateTaskProps.taskDefinition:
    has been removed

Once an API has been locked in, the only way to deal with this is by using runtime validation.

And we can't really break any currently succeeding synths either, so we'd have to add a warning.

[lpizzinidev]

@rix0rrr
So we should switch back to ScheduledFargateTaskProps implementing FargateServiceBaseProps and adding annotation warnings for the unused props?

[rix0rrr]

@rix0rrr So we should switch back to ScheduledFargateTaskProps implementing FargateServiceBaseProps and adding annotation warnings for the unused props?

Yep!

Pull request has been modified.

[rix0rrr]

Cheers!

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: 4b61e92
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).