readme and naming

Signed-off-by: Francis <colifran@amazon.com>

packages/@aws-cdk/custom-resource-handlers/lib/custom-resources-framework/README.md

@@ -1,8 +1,58 @@
 # AWS CDK Custom Resource Framework
 
-The CDK custom resource framework is an internal framework developed to establish best practices, runtime enforcement, and consistency for custom resource providers and their associated handler code. 
+The CDK custom resource framework is an internal framework developed to establish best practices, runtime enforcement, and consistency for custom resource providers and their associated source code. 
 
 # Creating a Custom Resource Provider
 
-Custom resource providers can be created in one of three forms - `CdkFunction`, `CdkSingletonFunction`, or `CdkCustomResourceProvider`. These three custom resource provider formats are a code generated wrapper around the lambda `Function`, lambda `SingletonFunction`, and `CustomResourceProvider` constructs, respectively. These new CDK prefixed constructs will offer the same behavior and construction options as their parent minus the ability to configure the `handler`, `code`, `runtime`, and `runtimeName` properties during construction. Instead, `handler`, `code`, `runtime`, and `runtimeName` will be automatically generated using the properties configured in the [config](./config.ts) file. The [config](./config.ts) file is structured with the top most level mapping to a specific service, i.e., `aws-s3`, `aws-dynamodb`, etc. Each service can contain one or more provider modules which are containers for the custom resource providers being requested. Custom resource providers are defined within a provider module as an array of one or more `ConfigProps`. `ConfigProps` allow you to define a provider with the following properties:
- - type: the 
+Custom resource providers can be created in one of three forms - `CdkFunction`, `CdkSingletonFunction`, or `CdkCustomResourceProvider`. These three custom resource provider formats are a code generated wrapper around the lambda `Function`, lambda `SingletonFunction`, and `CustomResourceProvider` constructs, respectively. These new CDK prefixed constructs will offer the same behavior and initialization options as their parent minus the ability to configure the following properties during construction:
+- `handler` - the name of the method within your code that the provider calls to execute your function
+- `code` - the source code of your provider
+- `codeDirectory` - a local file system directory with the provider's code
+- `runtime` - the runtime environment for the provider that you are uploading
+
+Instead, these properties will be automatically generated using the `ProviderProps` configured in the [config](./config.ts) file:
+- `type`: the custom resource provider type to generate
+- `sourceCode`: the source code that will be executed by the provider
+- `compatibleRuntimes`: runtimes that are compatible with the provider's source code
+- `handler`: the name of the method within your code that the provider calls to execute your function
+
+The [config](./config.ts) file is structured with the top most level mapping to a specific service, i.e., `aws-s3`, `aws-dynamodb`, etc. Each service can contain one or more provider modules. Provider modules are containers for custom resource providers and will be rendered as a code generated file. Each provider module can contain one or more `ProviderProps` objects. Each `ProviderProps` object contains all the necessary information required to generate a single custom resource provider. For more clarity, consider the following example of the [config](./config.ts) file:
+
+```ts
+const config = {
+  'aws-certificatemanager': {
+    'certificate-request-provider': [
+      {
+        type: ComponentType.CDK_FUNCTION,
+        sourceCode: path.resolve(__dirname, '..', 'aws-certificatemanager' 'dns-validated-certificate-handler', 'index.js'),
+        compatibleRuntimes: [Runtime.NODEJS_18_X],
+        handler: 'index.certificateRequestHandler',
+      },
+    ],
+  },
+  'aws-s3': {
+    'replica-provider': [
+      {
+        type: ComponentType.CDK_FUNCTION,
+        sourceCode: path.resolve(__dirname, '..', 'aws-dynamodb', 'replica-handler', 'index.ts'),
+        compatibleRuntimes: [Runtime.NODEJS_18_X],
+        handler: 'index.onEventHandler',
+      },
+      {
+        type: ComponentType.CDK_FUNCTION,
+        sourceCode: path.resolve(__dirname, '..', 'aws-dynamodb', 'replica-handler', 'index.ts'),
+        compatibleRuntimes: [Runtime.NODEJS_18_X],
+        handler: 'index.isCompleteHandler',
+      },
+    ],
+  },
+};
+```
+
+Inspecting the above example gives us the following information:
+- There are two services present: `aws-certificatemanager` and `aws-s3`
+- Both the `aws-certificatemanager` and `aws-dynamodb` services contain a single provider module - `certificate-request-provider` and `replica-provider`, respectively
+- The `certificate-request-provider` contains a single custom resource provider which is a `CdkFunction`
+- The `replica-provider` provider module contains two custom resource providers both of which are `CdkFunction`
+
+

packages/@aws-cdk/custom-resource-handlers/lib/custom-resources-framework/classes.ts

@@ -55,29 +55,28 @@ interface ConstructorBuildProps {
 }
 
 /**
- * Initialization properties used to build a `CdkHandlerFrameworkClass` instance.
+ * Initialization properties used to build a `CdkCustomResourceClass` instance.
  */
 export interface CdkCustomResourceClassProps {
   /**
-   * The name of the component class.
+   * The name of the provider class.
    */
   readonly name: string;
 
   /**
-   * A local file system directory with the provider's code. The code will be
-   * bundled into a zip asset and wired to the provider's AWS Lambda function.
+   * A local file system directory with the provider's code.
    */
   readonly codeDirectory: string;
 
   /**
-   * The runtime environment for the Lambda function.
+   * The runtime environment for the custom resource provider.
    */
   readonly runtime: Runtime;
 
   /**
-   * The name of the method within your code that Lambda calls to execute your function.
+   * The name of the method within your code that provider calls to execute your function.
    */
-  readonly entrypoint: string;
+  readonly handler: string;
 }
 
 export abstract class CdkCustomResourceClass extends ClassType {
@@ -100,7 +99,7 @@ export abstract class CdkCustomResourceClass extends ClassType {
         const superProps = new ObjectLiteral([
           new Splat(expr.ident('props')),
           ['code', expr.directCode(`lambda.Code.fromAsset(path.join(__dirname, '${props.codeDirectory}'))`)],
-          ['handler', expr.lit(props.entrypoint)],
+          ['handler', expr.lit(props.handler)],
           ['runtime', expr.directCode(props.runtime.toLambdaRuntime())],
         ]);
         this.buildConstructor({
@@ -162,7 +161,7 @@ export abstract class CdkCustomResourceClass extends ClassType {
         const superProps = new ObjectLiteral([
           new Splat(expr.ident('props')),
           ['code', expr.directCode(`lambda.Code.fromAsset(path.join(__dirname, '${props.codeDirectory}'))`)],
-          ['handler', expr.lit(props.entrypoint)],
+          ['handler', expr.lit(props.handler)],
           ['runtime', expr.directCode(props.runtime.toLambdaRuntime())],
         ]);
         this.buildConstructor({