revert: "feat(s3): allow user to set Log Group on S3 Bucket autoDelet…

…eObjects provider lambda" (aws#30590) Reverts aws#30394
mazyu36 · Jun 22, 2024 · 0d6f897 · 0d6f897
1 parent 78f17bd
commit 0d6f897
Show file tree

Hide file tree

Showing 14 changed files with 17 additions and 358 deletions.
diff --git a/...eg.bucket-auto-delete-objects.js.snapshot/cdk-s3-bucket-auto-delete-objects.template.json b/...eg.bucket-auto-delete-objects.js.snapshot/cdk-s3-bucket-auto-delete-objects.template.json
@@ -144,11 +144,6 @@
        " S3 bucket."
       ]
      ]
-    },
-    "LoggingConfig": {
-     "LogGroup": {
-      "Ref": "MyLogGroup5C0DAD85"
-     }
     }
    },
    "DependsOn": [
@@ -452,15 +447,6 @@
    "DependsOn": [
     "AWS679f53fac002430cb0da5b7982bd2287ServiceRoleC1EA0FF2"
    ]
-  },
-  "MyLogGroup5C0DAD85": {
-   "Type": "AWS::Logs::LogGroup",
-   "Properties": {
-    "LogGroupName": "MyLogGroup",
-    "RetentionInDays": 731
-   },
-   "UpdateReplacePolicy": "Retain",
-   "DeletionPolicy": "Retain"
   }
  },
  "Mappings": {

diff --git a/...amework-integ/test/aws-s3/test/integ.bucket-auto-delete-objects.js.snapshot/manifest.json b/...amework-integ/test/aws-s3/test/integ.bucket-auto-delete-objects.js.snapshot/manifest.json
diff --git a/...g/framework-integ/test/aws-s3/test/integ.bucket-auto-delete-objects.js.snapshot/tree.json b/...g/framework-integ/test/aws-s3/test/integ.bucket-auto-delete-objects.js.snapshot/tree.json
diff --git a/...ges/@aws-cdk-testing/framework-integ/test/aws-s3/test/integ.bucket-auto-delete-objects.ts b/...ges/@aws-cdk-testing/framework-integ/test/aws-s3/test/integ.bucket-auto-delete-objects.ts
@@ -3,7 +3,6 @@ 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';
 
@@ -56,10 +55,6 @@ class TestStack extends Stack {
         resources: [bucketThatWillBeRemoved.bucketArn],
       }),
     });
-
-    s3.Bucket.setAutoDeleteObjectsLogGroup(this, new logs.LogGroup(this, 'MyLogGroup', {
-      logGroupName: 'MyLogGroup',
-    }));
   }
 }
 

diff --git a/packages/@aws-cdk/custom-resource-handlers/lib/custom-resources-framework/classes.ts b/packages/@aws-cdk/custom-resource-handlers/lib/custom-resources-framework/classes.ts
@@ -274,59 +274,6 @@ 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',
-          },
-        });
-        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,
@@ -335,7 +282,7 @@ export abstract class HandlerFrameworkClass extends ClassType {
             summary: 'Returns a stack-level singleton for the custom resource provider.',
           },
         });
-        getOrCreateProviderMethod.addParameter({
+        const _scope = getOrCreateProviderMethod.addParameter({
           name: 'scope',
           type: CONSTRUCTS_MODULE.Construct,
         });
@@ -349,15 +296,10 @@ export abstract class HandlerFrameworkClass extends ClassType {
           optional: true,
         });
         getOrCreateProviderMethod.addBody(
-          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')),
+          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)`)),
         );
 
         const superProps = new ObjectLiteral([

diff --git a/...rs/test/custom-resources-framework/expected/node-runtime/custom-resource-provider-core.ts b/...rs/test/custom-resources-framework/expected/node-runtime/custom-resource-provider-core.ts
@@ -12,37 +12,14 @@ 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 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;
+    const existing = stack.node.tryFindChild(id) as TestProvider;
+    return existing ?? new TestProvider(stack, id, props);
   }
 
   public constructor(scope: Construct, id: string, props?: CustomResourceProviderOptions) {

diff --git a/...andlers/test/custom-resources-framework/expected/node-runtime/custom-resource-provider.ts b/...andlers/test/custom-resources-framework/expected/node-runtime/custom-resource-provider.ts
@@ -11,37 +11,14 @@ 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 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;
+    const existing = stack.node.tryFindChild(id) as TestProvider;
+    return existing ?? new TestProvider(stack, id, props);
   }
 
   public constructor(scope: Construct, id: string, props?: CustomResourceProviderOptions) {

diff --git a/.../test/custom-resources-framework/expected/python-runtime/custom-resource-provider-core.ts b/.../test/custom-resources-framework/expected/python-runtime/custom-resource-provider-core.ts
@@ -12,37 +12,14 @@ 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 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;
+    const existing = stack.node.tryFindChild(id) as TestProvider;
+    return existing ?? new TestProvider(stack, id, props);
   }
 
   public constructor(scope: Construct, id: string, props?: CustomResourceProviderOptions) {

diff --git a/...dlers/test/custom-resources-framework/expected/python-runtime/custom-resource-provider.ts b/...dlers/test/custom-resources-framework/expected/python-runtime/custom-resource-provider.ts
@@ -11,37 +11,14 @@ 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 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;
+    const existing = stack.node.tryFindChild(id) as TestProvider;
+    return existing ?? new TestProvider(stack, id, props);
   }
 
   public constructor(scope: Construct, id: string, props?: CustomResourceProviderOptions) {

diff --git a/packages/aws-cdk-lib/aws-s3/README.md b/packages/aws-cdk-lib/aws-s3/README.md
@@ -656,23 +656,6 @@ switching this to `false` in a CDK version _before_ `1.126.0` will lead to
 all objects in the bucket being deleted. Be sure to update your bucket resources
 by deploying with CDK version `1.126.0` or later **before** switching this value to `false`.
 
-Enabling `autoDeleteObjects` creates a stack-wide singleton Lambda that is responsible for deleting objects.
-To configure the lambda to use a different log group, use the `Bucket.setAutoDeleteObjectsLogGroup()` method:
-
-```ts
-import * as logs from 'aws-cdk-lib/aws-logs';
-
-const bucket = new s3.Bucket(this, 'MyTempFileBucket', {
-  removalPolicy: cdk.RemovalPolicy.DESTROY,
-  autoDeleteObjects: true,
-});
-
-s3.Bucket.setAutoDeleteObjectsLogGroup(this, new logs.LogGroup(this, 'MyLogGroup', {
-  logGroupName: 'MyLogGroup',
-  retention: logs.RetentionDays.FIVE_YEARS
-}))
-```
-
 ## Transfer Acceleration
 
 [Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/userguide/transfer-acceleration.html) can be configured to enable fast, easy, and secure transfers of files over long distances:

diff --git a/packages/aws-cdk-lib/aws-s3/lib/bucket.ts b/packages/aws-cdk-lib/aws-s3/lib/bucket.ts
@@ -10,7 +10,6 @@ import { parseBucketArn, parseBucketName } from './util';
 import * as events from '../../aws-events';
 import * as iam from '../../aws-iam';
 import * as kms from '../../aws-kms';
-import * as logs from '../../aws-logs';
 import {
   CustomResource,
   Duration,
@@ -1467,9 +1466,6 @@ export interface BucketProps {
    *
    * Requires the `removalPolicy` to be set to `RemovalPolicy.DESTROY`.
    *
-   * A custom resource along with a provider lambda will be created for
-   * emptying the bucket.
-   *
    * **Warning** if you have deployed a bucket with `autoDeleteObjects: true`,
    * switching this to `false` in a CDK version *before* `1.126.0` will lead to
    * all objects in the bucket being deleted. Be sure to update your bucket resources
@@ -1886,16 +1882,6 @@ export class Bucket extends BucketBase {
     }
   }
 
-  /**
-   * Set the log group on the stack wide singleton AutoDeleteObjects provider lambda.
-   *
-   * @param stack the stack with the singleton AutoDeleteObjects provider lambda.
-   * @param logGroup the log group to use on the lambda.
-   */
-  public static setAutoDeleteObjectsLogGroup(stack: Stack, logGroup: logs.ILogGroup): void {
-    AutoDeleteObjectsProvider.useLogGroup(stack, AUTO_DELETE_OBJECTS_RESOURCE_TYPE, logGroup.logGroupName);
-  }
-
   public readonly bucketArn: string;
   public readonly bucketName: string;
   public readonly bucketDomainName: string;