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.

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

Jump to bottom

feat(s3): allow user to set Log Group on S3 Bucket autoDeleteObjects provider lambda #30394

Merged
merged 13 commits into from
Jun 17, 2024
Merged

feat(s3): allow user to set Log Group on S3 Bucket autoDeleteObjects provider lambda #30394

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
c0b10d7
Create 'configureLambdaLogGroup' method in CustomResourceProviderBase…
samson-keung May 30, 2024
3859bb1
Update provider code gen logic to create pure getProvider() method
samson-keung May 30, 2024
f5dcbe7
Create new static method setAutoDeleteObjectsLogGroup in Bucket const…
samson-keung May 30, 2024
3b2ef56
Update integ.bucket-auto-delete-objects to cover the new setAutoDelet…
samson-keung May 30, 2024
91c4710
Update S3 README
samson-keung May 31, 2024
21c771d
Update provider code gen logic to create useLogGroup() method
samson-keung Jun 10, 2024
fba53e8
allow setAutoDeleteObjectsLogGroup to be called before bucket creation
samson-keung Jun 10, 2024
cebc4f3
update setAutoDeleteObjectsLogGroup to take a Stack instead of a Cons…
samson-keung Jun 10, 2024
90520ad
resolve conflicts
samson-keung Jun 12, 2024
3b7e4de
update unit test with latest changes from main
samson-keung Jun 12, 2024
ca1acbe
revert unintended change in cx-api
samson-keung Jun 13, 2024
5d12bf3
update doc
samson-keung Jun 14, 2024
fbde1ad
Merge branch 'main' into bucket-auto-delete-objects-logging
GavinZZ Jun 17, 2024
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
14 changes: 14 additions & 0 deletions ...eg.bucket-auto-delete-objects.js.snapshot/cdk-s3-bucket-auto-delete-objects.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,11 @@
" S3 bucket."
]
]
},
"LoggingConfig": {
"LogGroup": {
"Ref": "MyLogGroup5C0DAD85"
}
}
},
"DependsOn": [
Expand Down Expand Up @@ -447,6 +452,15 @@
"DependsOn": [
"AWS679f53fac002430cb0da5b7982bd2287ServiceRoleC1EA0FF2"
]
},
"MyLogGroup5C0DAD85": {
"Type": "AWS::Logs::LogGroup",
"Properties": {
"LogGroupName": "MyLogGroup",
"RetentionInDays": 731
},
"UpdateReplacePolicy": "Retain",
"DeletionPolicy": "Retain"
}
},
"Mappings": {
Expand Down
6 changes: 6 additions & 0 deletions ...amework-integ/test/aws-s3/test/integ.bucket-auto-delete-objects.js.snapshot/manifest.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 25 additions & 0 deletions ...g/framework-integ/test/aws-s3/test/integ.bucket-auto-delete-objects.js.snapshot/tree.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions ...ges/@aws-cdk-testing/framework-integ/test/aws-s3/test/integ.bucket-auto-delete-objects.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { App, CustomResource, CustomResourceProvider, RemovalPolicy, Stack, Stac
import { IntegTest } from '@aws-cdk/integ-tests-alpha';
import { Construct } from 'constructs';
import * as s3 from 'aws-cdk-lib/aws-s3';
import * as logs from 'aws-cdk-lib/aws-logs';
import { AwsCustomResource, AwsCustomResourcePolicy, PhysicalResourceId } from 'aws-cdk-lib/custom-resources';
import { STANDARD_CUSTOM_RESOURCE_PROVIDER_RUNTIME } from '../../config';

Expand Down Expand Up @@ -55,6 +56,10 @@ class TestStack extends Stack {
resources: [bucketThatWillBeRemoved.bucketArn],
}),
});

s3.Bucket.setAutoDeleteObjectsLogGroup(this, new logs.LogGroup(this, 'MyLogGroup', {
logGroupName: 'MyLogGroup',
}));
}
}

Expand Down
68 changes: 63 additions & 5 deletions packages/@aws-cdk/custom-resource-handlers/lib/custom-resources-framework/classes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,59 @@ export abstract class HandlerFrameworkClass extends ClassType {
stmt.ret(expr.directCode('this.getOrCreateProvider(scope, uniqueid, props).serviceToken')),
);

const idStatement = stmt.constVar(expr.ident('id'), expr.directCode('`${uniqueid}CustomResourceProvider`'));
const stackFromScopeStatement = stmt.constVar(expr.ident('stack'), expr.directCode('Stack.of(scope)'));
const logContextKeyStatement = stmt.constVar(expr.ident('key'), expr.directCode('`${uniqueid}CustomResourceLogGroup`'));
const getProviderMethod = this.addMethod({
name: 'getProvider',
static: true,
returnType: this.type,
docs: {
summary: 'Returns the stack-level singleton provider or undefined',
},
});
getProviderMethod.addParameter({
name: 'scope',
type: CONSTRUCTS_MODULE.Construct,
});
getProviderMethod.addParameter({
name: 'uniqueid',
type: Type.STRING,
});
getProviderMethod.addBody(
idStatement,
stackFromScopeStatement,
stmt.ret(expr.directCode(`stack.node.tryFindChild(id) as ${this.type}`)),
);

const useLogGroupMethod = this.addMethod({
name: 'useLogGroup',
static: true,
docs: {
summary: 'Set the log group to be used by the singleton provider',
},
});
Comment on lines +302 to +308
Copy link
Contributor

Choose a reason for hiding this comment

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

Technically you're adding useLogGroup functionality to all custom resource handlers not only the s3 ones right? But the functionality is only exposed to the s3 auto delete handler. It would be nice to expose useLogGroup to other handlers as I believe this issue doesn't only happen on s3 auto delete but also on all custom resource handlers.

useLogGroupMethod.addParameter({
name: 'scope',
type: CONSTRUCTS_MODULE.Construct,
});
useLogGroupMethod.addParameter({
name: 'uniqueid',
type: Type.STRING,
});
useLogGroupMethod.addParameter({
name: 'logGroupName',
type: Type.STRING,
});
useLogGroupMethod.addBody(
stackFromScopeStatement,
logContextKeyStatement,
expr.directCode('stack.node.addMetadata(key, logGroupName)'),
stmt.constVar(expr.ident('existing'), expr.directCode('this.getProvider(scope, uniqueid)')),
stmt.if_(expr.directCode('existing'))
.then(expr.directCode('existing.configureLambdaLogGroup(logGroupName)')),
);

const getOrCreateProviderMethod = this.addMethod({
name: 'getOrCreateProvider',
static: true,
Expand All @@ -282,7 +335,7 @@ export abstract class HandlerFrameworkClass extends ClassType {
summary: 'Returns a stack-level singleton for the custom resource provider.',
},
});
const _scope = getOrCreateProviderMethod.addParameter({
getOrCreateProviderMethod.addParameter({
name: 'scope',
type: CONSTRUCTS_MODULE.Construct,
});
Expand All @@ -296,10 +349,15 @@ export abstract class HandlerFrameworkClass extends ClassType {
optional: true,
});
getOrCreateProviderMethod.addBody(
stmt.constVar(expr.ident('id'), expr.directCode('`${uniqueid}CustomResourceProvider`')),
stmt.constVar(expr.ident('stack'), $T(CORE_MODULE.Stack).of(expr.directCode(_scope.spec.name))),
stmt.constVar(expr.ident('existing'), expr.directCode(`stack.node.tryFindChild(id) as ${this.type}`)),
stmt.ret(expr.directCode(`existing ?? new ${this.name}(stack, id, props)`)),
idStatement,
stackFromScopeStatement,
stmt.constVar(expr.ident('provider'), expr.directCode(`this.getProvider(scope, uniqueid) ?? new ${this.name}(stack, id, props)`)),
logContextKeyStatement,
stmt.constVar(expr.ident('logGroupMetadata'),
expr.directCode('stack.node.metadata.find(m => m.type === key)')),
stmt.if_(expr.directCode('logGroupMetadata?.data'))
.then(expr.directCode('provider.configureLambdaLogGroup(logGroupMetadata.data)')),
stmt.ret(expr.directCode('provider')),
);

const superProps = new ObjectLiteral([
Expand Down
27 changes: 25 additions & 2 deletions ...rs/test/custom-resources-framework/expected/node-runtime/custom-resource-provider-core.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,37 @@ export class TestProvider extends CustomResourceProviderBase {
return this.getOrCreateProvider(scope, uniqueid, props).serviceToken;
}

/**
* Returns the stack-level singleton provider or undefined
*/
public static getProvider(scope: Construct, uniqueid: string): TestProvider {
const id = `${uniqueid}CustomResourceProvider`;
const stack = Stack.of(scope);
return stack.node.tryFindChild(id) as TestProvider;
}

/**
* Set the log group to be used by the singleton provider
*/
public static useLogGroup(scope: Construct, uniqueid: string, logGroupName: string): void {
const stack = Stack.of(scope);
const key = `${uniqueid}CustomResourceLogGroup`;
stack.node.addMetadata(key, logGroupName);
const existing = this.getProvider(scope, uniqueid);
if (existing) existing.configureLambdaLogGroup(logGroupName);
}

/**
* Returns a stack-level singleton for the custom resource provider.
*/
public static getOrCreateProvider(scope: Construct, uniqueid: string, props?: CustomResourceProviderOptions): TestProvider {
const id = `${uniqueid}CustomResourceProvider`;
const stack = Stack.of(scope);
const existing = stack.node.tryFindChild(id) as TestProvider;
return existing ?? new TestProvider(stack, id, props);
const provider = this.getProvider(scope, uniqueid) ?? new TestProvider(stack, id, props);
const key = `${uniqueid}CustomResourceLogGroup`;
const logGroupMetadata = stack.node.metadata.find(m => m.type === key);
if (logGroupMetadata?.data) provider.configureLambdaLogGroup(logGroupMetadata.data);
return provider;
}

public constructor(scope: Construct, id: string, props?: CustomResourceProviderOptions) {
Expand Down
27 changes: 25 additions & 2 deletions ...andlers/test/custom-resources-framework/expected/node-runtime/custom-resource-provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,37 @@ export class TestProvider extends CustomResourceProviderBase {
return this.getOrCreateProvider(scope, uniqueid, props).serviceToken;
}

/**
* Returns the stack-level singleton provider or undefined
*/
public static getProvider(scope: Construct, uniqueid: string): TestProvider {
const id = `${uniqueid}CustomResourceProvider`;
const stack = Stack.of(scope);
return stack.node.tryFindChild(id) as TestProvider;
}

/**
* Set the log group to be used by the singleton provider
*/
public static useLogGroup(scope: Construct, uniqueid: string, logGroupName: string): void {
const stack = Stack.of(scope);
const key = `${uniqueid}CustomResourceLogGroup`;
stack.node.addMetadata(key, logGroupName);
const existing = this.getProvider(scope, uniqueid);
if (existing) existing.configureLambdaLogGroup(logGroupName);
}

/**
* Returns a stack-level singleton for the custom resource provider.
*/
public static getOrCreateProvider(scope: Construct, uniqueid: string, props?: CustomResourceProviderOptions): TestProvider {
const id = `${uniqueid}CustomResourceProvider`;
const stack = Stack.of(scope);
const existing = stack.node.tryFindChild(id) as TestProvider;
return existing ?? new TestProvider(stack, id, props);
const provider = this.getProvider(scope, uniqueid) ?? new TestProvider(stack, id, props);
const key = `${uniqueid}CustomResourceLogGroup`;
const logGroupMetadata = stack.node.metadata.find(m => m.type === key);
if (logGroupMetadata?.data) provider.configureLambdaLogGroup(logGroupMetadata.data);
return provider;
}

public constructor(scope: Construct, id: string, props?: CustomResourceProviderOptions) {
Expand Down
27 changes: 25 additions & 2 deletions .../test/custom-resources-framework/expected/python-runtime/custom-resource-provider-core.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,37 @@ export class TestProvider extends CustomResourceProviderBase {
return this.getOrCreateProvider(scope, uniqueid, props).serviceToken;
}

/**
* Returns the stack-level singleton provider or undefined
*/
public static getProvider(scope: Construct, uniqueid: string): TestProvider {
const id = `${uniqueid}CustomResourceProvider`;
const stack = Stack.of(scope);
return stack.node.tryFindChild(id) as TestProvider;
}

/**
* Set the log group to be used by the singleton provider
*/
public static useLogGroup(scope: Construct, uniqueid: string, logGroupName: string): void {
const stack = Stack.of(scope);
const key = `${uniqueid}CustomResourceLogGroup`;
stack.node.addMetadata(key, logGroupName);
const existing = this.getProvider(scope, uniqueid);
if (existing) existing.configureLambdaLogGroup(logGroupName);
}

/**
* Returns a stack-level singleton for the custom resource provider.
*/
public static getOrCreateProvider(scope: Construct, uniqueid: string, props?: CustomResourceProviderOptions): TestProvider {
const id = `${uniqueid}CustomResourceProvider`;
const stack = Stack.of(scope);
const existing = stack.node.tryFindChild(id) as TestProvider;
return existing ?? new TestProvider(stack, id, props);
const provider = this.getProvider(scope, uniqueid) ?? new TestProvider(stack, id, props);
const key = `${uniqueid}CustomResourceLogGroup`;
const logGroupMetadata = stack.node.metadata.find(m => m.type === key);
if (logGroupMetadata?.data) provider.configureLambdaLogGroup(logGroupMetadata.data);
return provider;
}

public constructor(scope: Construct, id: string, props?: CustomResourceProviderOptions) {
Expand Down
27 changes: 25 additions & 2 deletions ...dlers/test/custom-resources-framework/expected/python-runtime/custom-resource-provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,37 @@ export class TestProvider extends CustomResourceProviderBase {
return this.getOrCreateProvider(scope, uniqueid, props).serviceToken;
}

/**
* Returns the stack-level singleton provider or undefined
*/
public static getProvider(scope: Construct, uniqueid: string): TestProvider {
const id = `${uniqueid}CustomResourceProvider`;
const stack = Stack.of(scope);
return stack.node.tryFindChild(id) as TestProvider;
}

/**
* Set the log group to be used by the singleton provider
*/
public static useLogGroup(scope: Construct, uniqueid: string, logGroupName: string): void {
const stack = Stack.of(scope);
const key = `${uniqueid}CustomResourceLogGroup`;
stack.node.addMetadata(key, logGroupName);
const existing = this.getProvider(scope, uniqueid);
if (existing) existing.configureLambdaLogGroup(logGroupName);
}

/**
* Returns a stack-level singleton for the custom resource provider.
*/
public static getOrCreateProvider(scope: Construct, uniqueid: string, props?: CustomResourceProviderOptions): TestProvider {
const id = `${uniqueid}CustomResourceProvider`;
const stack = Stack.of(scope);
const existing = stack.node.tryFindChild(id) as TestProvider;
return existing ?? new TestProvider(stack, id, props);
const provider = this.getProvider(scope, uniqueid) ?? new TestProvider(stack, id, props);
const key = `${uniqueid}CustomResourceLogGroup`;
const logGroupMetadata = stack.node.metadata.find(m => m.type === key);
if (logGroupMetadata?.data) provider.configureLambdaLogGroup(logGroupMetadata.data);
return provider;
}

public constructor(scope: Construct, id: string, props?: CustomResourceProviderOptions) {
Expand Down
Loading