feat(event-targets): add role property to sqs event target by atnartur · Pull Request #33701 · aws/aws-cdk

atnartur · 2025-03-06T16:33:06Z

Reason for this change

Add role property to SQS Event Target in EventBridge

Description of changes

Add role attribute to SQS Event Target in EventBridge which is available in AWS CloudFormation template but was not available in AWS CDK.

Describe any new or updated permissions being added

No changes in permissions are made.

Description of how you validated changes

Deploy an EventBridge Rule with SQS Event Target and custom role.

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

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

aws-cdk-automation

(This review is outdated)

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

codecov · 2025-03-07T18:42:21Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.24%. Comparing base (77b6fa9) to head (06acad4).
Report is 5 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #33701   +/-   ##
=======================================
  Coverage   82.24%   82.24%           
=======================================
  Files         119      119           
  Lines        6875     6875           
  Branches     1161     1161           
=======================================
  Hits         5654     5654           
  Misses       1118     1118           
  Partials      103      103

Flag	Coverage Δ
suite.unit	`82.24% <ø> (ø)`

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

Components	Coverage Δ
packages/aws-cdk	`∅ <ø> (∅)`
packages/aws-cdk-lib/core	`82.24% <ø> (ø)`

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

aws-cdk-automation · 2025-04-03T00:11:48Z

This PR has been in the BUILD FAILING state for 3 weeks, and looks abandoned. Note that PRs with failing linting check or builds are not reviewed, please ensure your build is passing

To prevent automatic closure:

Resume work on the PR
OR request an exemption by adding a comment containing 'Exemption Request' with justification e.x "Exemption Request: "
OR request clarification by adding a comment containing 'Clarification Request' with a question e.x "Clarification Request: "

This PR will automatically close in 14 days if no action is taken.

atnartur · 2025-04-03T14:23:08Z

Related to #33827 #33976

aws-cdk-automation · 2025-04-25T00:12:09Z

This PR has been in the BUILD FAILING state for 3 weeks, and looks abandoned. Note that PRs with failing linting check or builds are not reviewed, please ensure your build is passing

To prevent automatic closure:

Resume work on the PR
OR request an exemption by adding a comment containing 'Exemption Request' with justification e.x "Exemption Request: "
OR request clarification by adding a comment containing 'Clarification Request' with a question e.x "Clarification Request: "

This PR will automatically close in 14 days if no action is taken.

atnartur · 2025-04-25T09:26:50Z

Clarification Request: Hi! I'm receiving the message that my PR will be closed soon due to the test failure, but tests are also failing on the main branch.

shikha372 · 2025-05-08T21:40:11Z

packages/aws-cdk-lib/aws-events-targets/lib/sqs.ts

+   *
+   * @default - no role defined
+   */
+  readonly role?: iam.Role;


question for my understanding :
why is this only in SQS queue props, since this is something that is related to EventTargets, isn't it relevant to each type of target that is supported, so should be part of TargetBaseProps.
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-rolearn

@shikha372, I moved the prop to TargetBaseProps and aligned other related interfaces. Tests ran successfully on my machine. Please take a look at this PR once again.

Thank you @atnartur , error you're facing is due to readme related changes

[jsii-rosetta] [INFO] Adding translations to /root/.s3buildcache/rosetta-cache.tabl.json aws-cdk-lib.aws_events_targets-README-L639.ts:23:12 - error TS2304: Cannot find name 'RuleTargetInput'. 23 message: RuleTargetInput.fromObject({ ~~~~~~~~~~~~~~~ [jsii-rosetta] [WARN] 1 diagnostics from assemblies with 'strict' mode on (and 64 more non-strict diagnostics) real 10m11.458s user 127m5.050s sys 9m1.260s

you can try updating readme with events.RuleTargetInput.fromObject

@shikha372 Someone added the same example already in main branch, so I removed my part. I think this check should pass. Please take a look on the PR once again

shikha372 · 2025-05-15T17:32:33Z

packages/aws-cdk-lib/aws-events-targets/lib/batch.ts

    // When scoping resource-level access for job submission, you must provide both job queue and job definition resource types.
    // https://docs.aws.amazon.com/batch/latest/userguide/ExamplePolicies_BATCH.html#iam-example-restrict-job-def
-    const role = singletonEventRole(this.jobDefinitionScope);
+    const role = this.props.eventRole ?? singletonEventRole(this.jobDefinitionScope);


currious why we need this change ?

The role created here extends with an additional policy statement in the lines below, so I repeat the behaviour from bindBaseTargetConfig here to save the same process of role initiation.

aws-cdk-automation · 2025-05-23T16:14:23Z

AWS CodeBuild CI Report

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

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

atnartur · 2025-07-02T19:41:24Z

Hi @shikha372! Could you please take a look at this PR?

pahud · 2025-11-11T19:44:14Z

Hi,

This PR has conflicts that need to be resolved before it can be reviewed.

atnartur · 2025-11-12T21:10:31Z

Hi @pahud,
I fixed the merge conflict. Could you please have a look?

feat(event-targets): add role property to sqs event target

36fe0bf

github-actions bot added p2 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels Mar 6, 2025

aws-cdk-automation requested a review from a team March 6, 2025 16:33

aws-cdk-automation previously requested changes Mar 6, 2025

View reviewed changes

atnartur added 4 commits March 6, 2025 16:42

add unit test

b51a736

Fix lint and tests

39e8b31

Add a readme example

0c97615

Add integration test

5c39932

Merge branch 'main' into feature/add-role-to-eventbridge-sqs-target

06acad4

atnartur marked this pull request as ready for review March 6, 2025 21:49

Merge branch 'main' into feature/add-role-to-eventbridge-sqs-target

0a82ec5

github-actions bot mentioned this pull request Apr 1, 2025

Monthly PR metrics report #33994

Closed

Merge branch 'main' into feature/add-role-to-eventbridge-sqs-target

5be3f1c

Merge branch 'main' into feature/add-role-to-eventbridge-sqs-target

d8b44e4

aws-cdk-automation added the pr/reviewer-clarification-requested The contributor has requested clarification on feedback, a failing build, or a failing PR Linter run label Apr 25, 2025

shikha372 self-assigned this May 6, 2025

shikha372 reviewed May 8, 2025

View reviewed changes

atnartur marked this pull request as draft May 14, 2025 13:44

Move role prop to TargetBaseProps

9dcc5f4

atnartur-emis force-pushed the feature/add-role-to-eventbridge-sqs-target branch from 75d4b53 to 9dcc5f4 Compare May 14, 2025 17:55

Merge branch 'main' into feature/add-role-to-eventbridge-sqs-target

d0e8143

atnartur marked this pull request as ready for review May 14, 2025 18:02

shikha372 reviewed May 15, 2025

View reviewed changes

Merge branch 'main' into feature/add-role-to-eventbridge-sqs-target

8341a95

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label May 23, 2025

atnartur requested a review from shikha372 June 24, 2025 07:34

Abogical unassigned shikha372 Oct 30, 2025

This was referenced Nov 11, 2025

PRs with Conflicts - 13 PR(s) need attention pahud/aws-cdk#12

Closed

PRs with Conflicts - 12 PR(s) pahud/aws-cdk#13

Open

Merge branch 'main' into feature/add-role-to-eventbridge-sqs-target

eee8baf

pahud mentioned this pull request Nov 12, 2025

CI Pending Approval - 42 PR(s) pahud/aws-cdk#11

Open

Conversation

atnartur commented Mar 6, 2025

Reason for this change

Description of changes

Describe any new or updated permissions being added

Description of how you validated changes

Checklist

Uh oh!

aws-cdk-automation left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Mar 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

aws-cdk-automation commented Apr 3, 2025

Uh oh!

atnartur commented Apr 3, 2025

Uh oh!

aws-cdk-automation commented Apr 25, 2025

Uh oh!

atnartur commented Apr 25, 2025

Uh oh!

shikha372 May 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

atnartur May 14, 2025

Choose a reason for hiding this comment

Uh oh!

shikha372 May 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

atnartur May 23, 2025

Choose a reason for hiding this comment

Uh oh!

shikha372 May 15, 2025

Choose a reason for hiding this comment

Uh oh!

atnartur May 23, 2025

Choose a reason for hiding this comment

Uh oh!

aws-cdk-automation commented May 23, 2025

AWS CodeBuild CI Report

Uh oh!

atnartur commented Jul 2, 2025

Uh oh!

pahud commented Nov 11, 2025

Uh oh!

atnartur commented Nov 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

aws-cdk-automation left a comment •

edited

Loading

codecov bot commented Mar 7, 2025 •

edited

Loading

shikha372 May 8, 2025 •

edited

Loading

shikha372 May 15, 2025 •

edited

Loading