Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(events-targets): allow all ECS TaskOverrides #32344

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

blimmer
Copy link
Contributor

@blimmer blimmer commented Dec 1, 2024

Issue #32217

Closes #32217.

Reason for this change

ECS targets can override any item in the TaskOverride structure via the input parameter, according to the docs.

However, today, only the containerOverrides option is exposed:

const containerOverrides = this.props.containerOverrides && this.props.containerOverrides
.map(({ containerName, ...overrides }) => ({ name: containerName, ...overrides }));
const input = { containerOverrides };

Description of changes

This PR adds all TaskOverride properties to the input parameter.

Description of how you validated changes

I add unit tests. I also updated the existing integration tests to include additional overrides. I validated them in my AWS account.

Checklist


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

@github-actions github-actions bot added effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 labels Dec 1, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team December 1, 2024 17:34
@github-actions github-actions bot added the admired-contributor [Pilot] contributed between 13-24 PRs to the CDK label Dec 1, 2024
*/
export interface EphemeralStorageOverride {
/**
* The total amount, in GiB, of ephemeral storage to set for the task.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I copied these docstrings from the Task Override docs: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskOverride.html

@@ -50,6 +50,54 @@ export interface EcsTaskProps extends TargetBaseProps {
*/
readonly containerOverrides?: ContainerOverride[];

/**
* The CPU override for the task.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

const taskCount = this.taskCount;
const taskDefinitionArn = this.taskDefinition.taskDefinitionArn;
const propagateTags = this.propagateTags;
const tagList = this.tags;
const enableExecuteCommand = this.enableExecuteCommand;
const input = this.createInput();
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this logic is more complex now, I refactored it to a dedicated private method.

Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@blimmer blimmer changed the title feat(events-targets): add all ECS task properties for overrides feat(events-targets): allow all ECS TaskOverrides Dec 1, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review December 1, 2024 17:44

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

Copy link

codecov bot commented Dec 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.45%. Comparing base (24adca3) to head (b65c237).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #32344      +/-   ##
==========================================
- Coverage   78.46%   78.45%   -0.02%     
==========================================
  Files         106      106              
  Lines        7208     7208              
  Branches     1323     1323              
==========================================
- Hits         5656     5655       -1     
- Misses       1364     1365       +1     
  Partials      188      188              
Flag Coverage Δ
suite.unit 78.45% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
packages/aws-cdk 78.45% <ø> (-0.02%) ⬇️

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Dec 1, 2024
@blimmer
Copy link
Contributor Author

blimmer commented Dec 1, 2024

Hmm, I'm not sure why coverage would be decreasing on this PR. Any suggestions on how to improve it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
admired-contributor [Pilot] contributed between 13-24 PRs to the CDK effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(events-targets): Support all input overrides for EcsTask target
2 participants