Skip to content

fix(kinesisfirehose): can't call grantPrincipal multiple times #34682

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Jul 15, 2025
Merged

fix(kinesisfirehose): can't call grantPrincipal multiple times #34682

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3976788
fix(aws-kinesisfirehose): prevent creation of multiple service roles …
Jun 10, 2025
08cc1d2
test: check grantPrincipal not throw
WinterYukky Jun 11, 2025
eb295ad
Merge branch 'main' into fix/kinesisfirehose-grant-principal-role-cre…
WinterYukky Jul 15, 2025
3675508
Merge branch 'main' into fix/kinesisfirehose-grant-principal-role-cre…
mergify[bot] Jul 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions packages/aws-cdk-lib/aws-kinesisfirehose/lib/delivery-stream.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,13 +311,11 @@ export class DeliveryStream extends DeliveryStreamBase {
private _role?: iam.IRole;

public get grantPrincipal(): iam.IPrincipal {
if (this._role) {
return this._role;
}
// backwards compatibility
return new iam.Role(this, 'Service Role', {
// backwards compatibility - create role only once
Copy link
Member

Choose a reason for hiding this comment

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

The comment backwards compatibility doesn't fully explain the purpose of this change. It's not just for backwards compatibility but also to fix a bug where multiple calls to grantPrincipal would create multiple roles with the same name. Improve the comment to better explain the purpose. Maybe something like:
Create the role only once to ensure multiple calls to grantPrincipal return the same role instance, while maintaining backwards compatibility

this._role = this._role ?? new iam.Role(this, 'Service Role', {
assumedBy: new iam.ServicePrincipal('firehose.amazonaws.com'),
});
return this._role;
}

constructor(scope: Construct, id: string, props: DeliveryStreamProps) {
Expand Down
9 changes: 9 additions & 0 deletions packages/aws-cdk-lib/aws-kinesisfirehose/test/delivery-stream.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,15 @@ describe('delivery stream', () => {
expect(deliveryStream.grantPrincipal).toBeInstanceOf(iam.Role);
});

test('multiple calls to grantPrincipal should return the same instance of IAM role', () => {
const deliveryStream = new firehose.DeliveryStream(stack, 'Delivery Stream Multiple', {
destination: mockS3Destination,
});
const principal = deliveryStream.grantPrincipal;
expect(() => deliveryStream.grantPrincipal).not.toThrow();
expect(deliveryStream.grantPrincipal).toBe(principal);
});

describe('metric methods provide a Metric with configured and attached properties', () => {
let deliveryStream: firehose.DeliveryStream;

Expand Down
Loading