feat(ecs): Implement method in ECS cluster to retrieve task ARN by badmintoncryer · Pull Request #28381 · aws/aws-cdk

badmintoncryer · 2023-12-15T11:56:10Z

This pull request introduces a new method within the Cluster class, designed to retrieve the Amazon Resource Names (ARNs) of tasks that are part of a given ECS cluster.

Example of how to get task ARN

declare cluster: Cluster;
// arn:aws:ecs:{region}:{regionId}:task/{clusterName}/*
const taskArnPattern = cluster.arnForTasks("*");

Closes #26232

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

aws-cdk-automation

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.

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

kaizencc

Hi @badmintoncryer, a few comments on this PR. 1 is related to how you've implemented the arn, and the second is that the integ tests don't seem related. If you are interested in adding additional ecs integ tests, I would love that, but that should be part of a separate PR.

kaizencc · 2023-12-18T19:24:56Z

packages/aws-cdk-lib/aws-ecs/lib/cluster.ts

+   * @param keyPattern Task id pattern
+   */
+  public arnForTasks(keyPattern: string): string {
+    return `arn:${Stack.of(this).partition}:ecs:${Stack.of(this).region}:${Stack.of(this).account}:task/${this.clusterName}/${keyPattern}`;


We should use our standard way of generating arns here. Something like this:

aws-cdk/packages/@aws-cdk/app-staging-synthesizer-alpha/lib/default-staging-stack.ts

Lines 304 to 311 in 8c44f32

this.fileRoleManifestArn = Stack.of(this).formatArn({

partition: '${AWS::Partition}',

region: '', // iam is global

service: 'iam',

resource: 'role',

resourceName: roleName,

arnFormat: ArnFormat.SLASH_RESOURCE_NAME,

});

This means that many of the options we can just use the default (it automatically assumes that the partition/region/account will come from the stack)

Thank you very much. I have learned a lot.

kaizencc · 2023-12-18T21:22:07Z

packages/@aws-cdk-testing/framework-integ/test/aws-ecs/test/integ.cluster-with-iam-statement.ts

I don't see how this integ test is related to the feature added.

kaizencc · 2023-12-18T21:22:15Z

packages/@aws-cdk-testing/framework-integ/test/aws-ecs/test/integ.cluster.ts

same for this

test: add test

Pull request has been modified.

aws-cdk-automation

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.

badmintoncryer · 2023-12-21T13:47:13Z

Exemption Request

@kaizencc
Thank you for your review.
I switched to using the formatArn() function and removed unnecessary integration tests.

packages/aws-cdk-lib/aws-ecs/README.md

kaizencc

Thanks @badmintoncryer!

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

mergify · 2023-12-22T22:07:50Z

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 · 2023-12-22T22:34:21Z

AWS CodeBuild CI Report

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

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

mergify · 2023-12-22T22:34:45Z

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

…28381) This pull request introduces a new method within the Cluster class, designed to retrieve the Amazon Resource Names (ARNs) of tasks that are part of a given ECS cluster. Example of how to get task ARN ```ts declare cluster: Cluster; // arn:aws:ecs:{region}:{regionId}:task/{clusterName}/* const taskArnPattern = cluster.arnForTasks("*"); ``` Closes aws#26232 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

github-actions bot added beginning-contributor [Pilot] contributed between 0-2 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 labels Dec 15, 2023

aws-cdk-automation requested a review from a team December 15, 2023 11:56

aws-cdk-automation previously requested changes Dec 15, 2023

View reviewed changes

badmintoncryer force-pushed the 26232-arnForTasksMethod branch 2 times, most recently from b714c68 to d8864ff Compare December 15, 2023 13:41

badmintoncryer force-pushed the 26232-arnForTasksMethod branch 2 times, most recently from c2c87dd to ea5d1b8 Compare December 16, 2023 01:43

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 16, 2023

badmintoncryer force-pushed the 26232-arnForTasksMethod branch from ca540a3 to 5b3d2a5 Compare December 16, 2023 03:37

badmintoncryer marked this pull request as draft December 16, 2023 14:24

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Dec 17, 2023

badmintoncryer marked this pull request as ready for review December 17, 2023 11:56

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 17, 2023

kaizencc previously requested changes Dec 18, 2023

View reviewed changes

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Dec 18, 2023

badmintoncryer added 3 commits December 21, 2023 22:23

feat: add arnForTasks method

d170abc

test: add test

docs: update README.md

0db25e2

fix: README

94a6cc5

badmintoncryer force-pushed the 26232-arnForTasksMethod branch from 5b3d2a5 to 94a6cc5 Compare December 21, 2023 13:23

badmintoncryer added 2 commits December 21, 2023 22:41

refactor: use formatArn()

2532b19

remove: test

bc8186d

aws-cdk-automation previously requested changes Dec 21, 2023

View reviewed changes

aws-cdk-automation added pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Dec 21, 2023

kaizencc reviewed Dec 22, 2023

View reviewed changes

packages/aws-cdk-lib/aws-ecs/README.md Outdated Show resolved Hide resolved

Update packages/aws-cdk-lib/aws-ecs/README.md

0c73537

kaizencc added pr-linter/exempt-integ-test The PR linter will not require integ test changes and removed pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. labels Dec 22, 2023

kaizencc approved these changes Dec 22, 2023

View reviewed changes

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Dec 22, 2023

Merge branch 'main' into 26232-arnForTasksMethod

54b7614

mergify bot merged commit 7635bbc into aws:main Dec 22, 2023

badmintoncryer deleted the 26232-arnForTasksMethod branch December 22, 2023 23:14

github-actions bot mentioned this pull request Jan 1, 2024

Monthly PR metrics report - Dec 2023 #28544

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(ecs): Implement method in ECS cluster to retrieve task ARN#28381

feat(ecs): Implement method in ECS cluster to retrieve task ARN#28381
mergify[bot] merged 7 commits intoaws:mainfrom
badmintoncryer:26232-arnForTasksMethod

badmintoncryer commented Dec 15, 2023 •

edited by kaizencc

Loading

Uh oh!

aws-cdk-automation left a comment

Uh oh!

kaizencc left a comment

Uh oh!

kaizencc Dec 18, 2023

Uh oh!

badmintoncryer Dec 21, 2023

Uh oh!

kaizencc Dec 18, 2023

Uh oh!

kaizencc Dec 18, 2023

Uh oh!

aws-cdk-automation left a comment

Uh oh!

badmintoncryer commented Dec 21, 2023

Uh oh!

Uh oh!

kaizencc left a comment

Uh oh!

mergify bot commented Dec 22, 2023

Uh oh!

aws-cdk-automation commented Dec 22, 2023

Uh oh!

mergify bot commented Dec 22, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	this.fileRoleManifestArn = Stack.of(this).formatArn({
	partition: '${AWS::Partition}',
	region: '', // iam is global
	service: 'iam',
	resource: 'role',
	resourceName: roleName,
	arnFormat: ArnFormat.SLASH_RESOURCE_NAME,
	});

Conversation

badmintoncryer commented Dec 15, 2023 • edited by kaizencc Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aws-cdk-automation left a comment

Choose a reason for hiding this comment

Uh oh!

kaizencc left a comment

Choose a reason for hiding this comment

Uh oh!

kaizencc Dec 18, 2023

Choose a reason for hiding this comment

Uh oh!

badmintoncryer Dec 21, 2023

Choose a reason for hiding this comment

Uh oh!

kaizencc Dec 18, 2023

Choose a reason for hiding this comment

Uh oh!

kaizencc Dec 18, 2023

Choose a reason for hiding this comment

Uh oh!

aws-cdk-automation left a comment

Choose a reason for hiding this comment

Uh oh!

badmintoncryer commented Dec 21, 2023

Uh oh!

Uh oh!

kaizencc left a comment

Choose a reason for hiding this comment

Uh oh!

mergify bot commented Dec 22, 2023

Uh oh!

aws-cdk-automation commented Dec 22, 2023

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Dec 22, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

badmintoncryer commented Dec 15, 2023 •

edited by kaizencc

Loading