Skip to content

feat(s3-notifications): add option to skip permissions for LambdaDestination #34749

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions packages/aws-cdk-lib/aws-s3-notifications/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,9 @@ const fn = new lambda.Function(this, 'MyFunction', {

bucket.addEventNotification(s3.EventType.OBJECT_CREATED, new s3n.LambdaDestination(fn));
```

You can also skip the creation of arranging permissions:

```ts
new s3n.LambdaDestination(fn, { addPermissions: false });
```
14 changes: 12 additions & 2 deletions packages/aws-cdk-lib/aws-s3-notifications/lib/lambda.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,21 @@ import * as s3 from '../../aws-s3';
import { CfnResource, Names, Stack } from '../../core';
import { ValidationError } from '../../core/lib/errors';

/**
* Options that may be provided to LambdaDestination
*/
export interface LambdaDestinationOptions {
/** Whether or not to add Lambda Permissions.
* @default true
*/
readonly addPermissions?: boolean;
}

/**
* Use a Lambda function as a bucket notification destination
*/
export class LambdaDestination implements s3.IBucketNotificationDestination {
constructor(private readonly fn: lambda.IFunction) {
constructor(private readonly fn: lambda.IFunction, private readonly options: LambdaDestinationOptions = {}) {
}

public bind(scope: Construct, bucket: s3.IBucket): s3.BucketNotificationDestinationConfig {
Expand All @@ -20,7 +30,7 @@ export class LambdaDestination implements s3.IBucketNotificationDestination {
bucket construct (Bucket ${bucket.bucketName})`, scope);
}

if (bucket.node.tryFindChild(permissionId) === undefined) {
if (this.options.addPermissions !== false && bucket.node.tryFindChild(permissionId) === undefined) {
this.fn.addPermission(permissionId, {
sourceAccount: Stack.of(bucket).account,
principal: new iam.ServicePrincipal('s3.amazonaws.com'),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -222,3 +222,20 @@ test('add multiple event notifications using a singleton function', () => {
}),
});
});

test('lambda permissions are not added when addPermissions is false', () => {
const stack = new Stack();
const bucket = new s3.Bucket(stack, 'MyBucket');
const fn = new lambda.Function(stack, 'MyFunction1', {
runtime: lambda.Runtime.NODEJS_LATEST,
handler: 'index.handler',
code: lambda.Code.fromInline('foo'),
});

const lambdaDestination = new s3n.LambdaDestination(fn, { addPermissions: false });

bucket.addEventNotification(s3.EventType.OBJECT_CREATED, lambdaDestination, { prefix: 'v1/' });

// expecting one permission for each function
Template.fromStack(stack).resourceCountIs('AWS::Lambda::Permission', 0);
});
Loading