quidproquo-deploy-awscdk 0.0.201 → 0.0.202

package/README.md

@@ -1,61 +1,61 @@
-# quidproquo-deploy-awscdk
-
-The `quidproquo-deploy-awscdk` library is a key component of the quidproquo framework, providing a set of constructs and utilities for deploying quidproquo-based applications on the AWS Cloud using the AWS CDK (Cloud Development Kit).
-
-## WARNING: NOT FOR PRODUCTION
-
-**This project is currently under active development and should not be used in production environments. The APIs and functionality are subject to change without notice.**
-
-## Key Features
-
-1. **Construct-based Deployment**: The `quidproquo-deploy-awscdk` library provides a set of custom constructs that encapsulate the deployment of various quidproquo components, such as APIs, queues, storage drives, and more, on the AWS platform.
-
-2. **Seamless Integration**: The constructs in this library are designed to work seamlessly with the core quidproquo functionality, ensuring a consistent and cohesive development experience.
-
-3. **Extensibility**: The library is designed to be highly extensible, allowing developers to create custom constructs or modify existing ones to meet their specific requirements.
-
-4. **Automated Provisioning**: The library handles the provisioning of various AWS resources, such as Lambda functions, API Gateways, DynamoDB tables, and more, based on the quidproquo configuration.
-
-5. **Dependency Management**: The library manages the dependencies between various quidproquo components, ensuring that the deployment process is efficient and reliable.
-
-6. **Logging and Observability**: The library integrates with the quidproquo logging and observability features, ensuring that deployment-related logs and metrics are captured and made available for monitoring and troubleshooting.
-
-7. **Reusable Constructs**: The library provides a set of reusable constructs that can be used across multiple quidproquo-based applications, promoting code reuse and consistency.
-
-## Key Concepts
-
-1. **Constructs**: Constructs are the fundamental building blocks of the `quidproquo-deploy-awscdk` library. They represent the various AWS resources and configurations required to deploy a quidproquo-based application.
-
-2. **Stacks**: Stacks are higher-level constructs that group related resources and configurations together, ensuring a cohesive and organized deployment process.
-
-3. **Dependency Management**: The library manages the dependencies between various quidproquo components, ensuring that the deployment process is efficient and reliable.
-
-4. **Naming Conventions**: The library follows a consistent naming convention for the provisioned AWS resources, ensuring that they are easily identifiable and traceable.
-
-5. **Extensibility**: The library is designed to be highly extensible, allowing developers to create custom constructs or modify existing ones to meet their specific requirements.
-
-6. **Logging and Observability**: The library integrates with the quidproquo logging and observability features, ensuring that deployment-related logs and metrics are captured and made available for monitoring and troubleshooting.
-
-7. **Reusable Constructs**: The library provides a set of reusable constructs that can be used across multiple quidproquo-based applications, promoting code reuse and consistency.
-
-## Getting Started
-
-To use the `quidproquo-deploy-awscdk` library, you'll need to install the package and its dependencies. You can do this using your preferred package manager, such as npm or yarn:
-
-```
-npm install quidproquo-deploy-awscdk
-```
-
-Once you have the package installed, you can start building your quidproquo-based applications on the AWS platform, leveraging the constructs and utilities provided by this library.
-
-## Documentation
-
-For more detailed information on using the `quidproquo-deploy-awscdk` library, please refer to the [quidproquo-deploy-awscdk documentation](https://github.com/joe-coady/quidproquo/tree/main/packages/quidproquo-deploy-awscdk).
-
-## Contributing
-
-If you'd like to contribute to the development of `quidproquo-deploy-awscdk`, please refer to the [contributing guidelines](https://github.com/joe-coady/quidproquo/blob/main/CONTRIBUTING.md) for more information.
-
-## License
-
+# quidproquo-deploy-awscdk
+
+The `quidproquo-deploy-awscdk` library is a key component of the quidproquo framework, providing a set of constructs and utilities for deploying quidproquo-based applications on the AWS Cloud using the AWS CDK (Cloud Development Kit).
+
+## WARNING: NOT FOR PRODUCTION
+
+**This project is currently under active development and should not be used in production environments. The APIs and functionality are subject to change without notice.**
+
+## Key Features
+
+1. **Construct-based Deployment**: The `quidproquo-deploy-awscdk` library provides a set of custom constructs that encapsulate the deployment of various quidproquo components, such as APIs, queues, storage drives, and more, on the AWS platform.
+
+2. **Seamless Integration**: The constructs in this library are designed to work seamlessly with the core quidproquo functionality, ensuring a consistent and cohesive development experience.
+
+3. **Extensibility**: The library is designed to be highly extensible, allowing developers to create custom constructs or modify existing ones to meet their specific requirements.
+
+4. **Automated Provisioning**: The library handles the provisioning of various AWS resources, such as Lambda functions, API Gateways, DynamoDB tables, and more, based on the quidproquo configuration.
+
+5. **Dependency Management**: The library manages the dependencies between various quidproquo components, ensuring that the deployment process is efficient and reliable.
+
+6. **Logging and Observability**: The library integrates with the quidproquo logging and observability features, ensuring that deployment-related logs and metrics are captured and made available for monitoring and troubleshooting.
+
+7. **Reusable Constructs**: The library provides a set of reusable constructs that can be used across multiple quidproquo-based applications, promoting code reuse and consistency.
+
+## Key Concepts
+
+1. **Constructs**: Constructs are the fundamental building blocks of the `quidproquo-deploy-awscdk` library. They represent the various AWS resources and configurations required to deploy a quidproquo-based application.
+
+2. **Stacks**: Stacks are higher-level constructs that group related resources and configurations together, ensuring a cohesive and organized deployment process.
+
+3. **Dependency Management**: The library manages the dependencies between various quidproquo components, ensuring that the deployment process is efficient and reliable.
+
+4. **Naming Conventions**: The library follows a consistent naming convention for the provisioned AWS resources, ensuring that they are easily identifiable and traceable.
+
+5. **Extensibility**: The library is designed to be highly extensible, allowing developers to create custom constructs or modify existing ones to meet their specific requirements.
+
+6. **Logging and Observability**: The library integrates with the quidproquo logging and observability features, ensuring that deployment-related logs and metrics are captured and made available for monitoring and troubleshooting.
+
+7. **Reusable Constructs**: The library provides a set of reusable constructs that can be used across multiple quidproquo-based applications, promoting code reuse and consistency.
+
+## Getting Started
+
+To use the `quidproquo-deploy-awscdk` library, you'll need to install the package and its dependencies. You can do this using your preferred package manager, such as npm or yarn:
+
+```
+npm install quidproquo-deploy-awscdk
+```
+
+Once you have the package installed, you can start building your quidproquo-based applications on the AWS platform, leveraging the constructs and utilities provided by this library.
+
+## Documentation
+
+For more detailed information on using the `quidproquo-deploy-awscdk` library, please refer to the [quidproquo-deploy-awscdk documentation](https://github.com/joe-coady/quidproquo/tree/main/packages/quidproquo-deploy-awscdk).
+
+## Contributing
+
+If you'd like to contribute to the development of `quidproquo-deploy-awscdk`, please refer to the [contributing guidelines](https://github.com/joe-coady/quidproquo/blob/main/CONTRIBUTING.md) for more information.
+
+## License
+
 `quidproquo-deploy-awscdk` is licensed under the [MIT License](https://github.com/joe-coady/quidproquo/blob/main/LICENSE).

package/lib/commonjs/constructs/feature/core/auth/QpqCoreUserDirectoryConstruct.d.ts

@@ -16,5 +16,5 @@ export declare class QpqCoreUserDirectoryConstruct extends QpqCoreUserDirectoryC
     userPool: aws_cognito.IUserPool;
     static fromOtherStack(scope: Construct, id: string, qpqConfig: QPQConfig, awsAccountId: string, userDirectoryName: string): QpqResource;
     constructor(scope: Construct, id: string, props: QpqCoreUserDirectoryConstructProps);
-    static authorizeActionsForRole(role: aws_iam.IRole, userDirectorieConfigs: UserDirectoryQPQConfigSetting[], qpqConfig: QPQConfig): void;
+    static authorizeActionsForRole(role: aws_iam.IRole, userDirectoryConfigs: UserDirectoryQPQConfigSetting[], userDirectoryConstructs: QpqCoreUserDirectoryConstruct[], qpqConfig: QPQConfig): void;
 }

package/lib/commonjs/constructs/feature/core/auth/QpqCoreUserDirectoryConstruct.js

@@ -107,8 +107,8 @@ class QpqCoreUserDirectoryConstruct extends QpqCoreUserDirectoryConstructBase {
         });
         qpqDeployAwsCdkUtils.exportStackValue(this, quidproquo_actionprocessor_awslambda_1.awsNamingUtils.getCFExportNameUserPoolClientIdFromConfig(props.userDirectoryConfig.name, props.qpqConfig), userPoolClient.userPoolClientId);
     }
-    static authorizeActionsForRole(role, userDirectorieConfigs, qpqConfig) {
-        if (userDirectorieConfigs.length > 0) {
+    static authorizeActionsForRole(role, userDirectoryConfigs, userDirectoryConstructs, qpqConfig) {
+        if (userDirectoryConstructs.length > 0) {
             role.addToPrincipalPolicy(new aws_cdk_lib_1.aws_iam.PolicyStatement({
                 effect: aws_cdk_lib_1.aws_iam.Effect.ALLOW,
                 actions: [
@@ -130,9 +130,9 @@ class QpqCoreUserDirectoryConstruct extends QpqCoreUserDirectoryConstructBase {
                     'cognito-idp:DescribeUserPool',
                     'cognito-idp:DescribeUserPoolClient',
                 ],
-                resources: userDirectorieConfigs.map((userDirectoryConfig) => {
+                resources: userDirectoryConfigs.map((userDirectoryConfig, index) => {
                     const { awsRegion, awsAccountId } = (0, quidproquo_config_aws_1.resolveAwsServiceAccountInfo)(qpqConfig, userDirectoryConfig.owner);
-                    const userpoolId = qpqDeployAwsCdkUtils.importStackValue(quidproquo_actionprocessor_awslambda_1.awsNamingUtils.getCFExportNameUserPoolIdFromConfig(userDirectoryConfig.name, qpqConfig));
+                    const userpoolId = userDirectoryConstructs[index].userPool.userPoolId;
                     return `arn:aws:cognito-idp:${awsRegion}:${awsAccountId}:userpool/${userpoolId}`;
                 }),
             }));

package/lib/commonjs/stacks/InfQpqServiceStack.js

@@ -53,12 +53,13 @@ class InfQpqServiceStack extends QpqServiceStack_1.QpqServiceStack {
         constructs_1.QpqCoreQueueConstruct.authorizeActionsForRole(webserverRole, queues);
         // end queues
         // User Directories
-        const userDirectories = quidproquo_core_1.qpqCoreUtils.getOwnedUserDirectories(props.qpqConfig).map((setting) => new constructs_1.QpqCoreUserDirectoryConstruct(this, quidproquo_core_1.qpqCoreUtils.getUniqueKeyForSetting(setting), {
+        const ownedUserDirectoriesConfigs = quidproquo_core_1.qpqCoreUtils.getOwnedUserDirectories(props.qpqConfig);
+        const userDirectories = ownedUserDirectoriesConfigs.map((setting) => new constructs_1.QpqCoreUserDirectoryConstruct(this, quidproquo_core_1.qpqCoreUtils.getUniqueKeyForSetting(setting), {
             awsAccountId: props.awsAccountId,
             qpqConfig: props.qpqConfig,
             userDirectoryConfig: setting,
         }));
-        constructs_1.QpqCoreUserDirectoryConstruct.authorizeActionsForRole(webserverRole, quidproquo_core_1.qpqCoreUtils.getOwnedUserDirectories(props.qpqConfig), props.qpqConfig);
+        constructs_1.QpqCoreUserDirectoryConstruct.authorizeActionsForRole(webserverRole, ownedUserDirectoriesConfigs, userDirectories, props.qpqConfig);
         // Api Keys
         const apiKeys = quidproquo_webserver_1.qpqWebServerUtils.getAllApiKeyConfigs(props.qpqConfig).map((setting) => new constructs_1.QpqWebserverApiKeyConstruct(this, quidproquo_core_1.qpqCoreUtils.getUniqueKeyForSetting(setting), {
             awsAccountId: props.awsAccountId,

package/lib/esm/constructs/feature/core/auth/QpqCoreUserDirectoryConstruct.d.ts

@@ -16,5 +16,5 @@ export declare class QpqCoreUserDirectoryConstruct extends QpqCoreUserDirectoryC
     userPool: aws_cognito.IUserPool;
     static fromOtherStack(scope: Construct, id: string, qpqConfig: QPQConfig, awsAccountId: string, userDirectoryName: string): QpqResource;
     constructor(scope: Construct, id: string, props: QpqCoreUserDirectoryConstructProps);
-    static authorizeActionsForRole(role: aws_iam.IRole, userDirectorieConfigs: UserDirectoryQPQConfigSetting[], qpqConfig: QPQConfig): void;
+    static authorizeActionsForRole(role: aws_iam.IRole, userDirectoryConfigs: UserDirectoryQPQConfigSetting[], userDirectoryConstructs: QpqCoreUserDirectoryConstruct[], qpqConfig: QPQConfig): void;
 }

package/lib/esm/constructs/feature/core/auth/QpqCoreUserDirectoryConstruct.js

@@ -78,8 +78,8 @@ export class QpqCoreUserDirectoryConstruct extends QpqCoreUserDirectoryConstruct
         });
         qpqDeployAwsCdkUtils.exportStackValue(this, awsNamingUtils.getCFExportNameUserPoolClientIdFromConfig(props.userDirectoryConfig.name, props.qpqConfig), userPoolClient.userPoolClientId);
     }
-    static authorizeActionsForRole(role, userDirectorieConfigs, qpqConfig) {
-        if (userDirectorieConfigs.length > 0) {
+    static authorizeActionsForRole(role, userDirectoryConfigs, userDirectoryConstructs, qpqConfig) {
+        if (userDirectoryConstructs.length > 0) {
             role.addToPrincipalPolicy(new aws_iam.PolicyStatement({
                 effect: aws_iam.Effect.ALLOW,
                 actions: [
@@ -101,9 +101,9 @@ export class QpqCoreUserDirectoryConstruct extends QpqCoreUserDirectoryConstruct
                     'cognito-idp:DescribeUserPool',
                     'cognito-idp:DescribeUserPoolClient',
                 ],
-                resources: userDirectorieConfigs.map((userDirectoryConfig) => {
+                resources: userDirectoryConfigs.map((userDirectoryConfig, index) => {
                     const { awsRegion, awsAccountId } = resolveAwsServiceAccountInfo(qpqConfig, userDirectoryConfig.owner);
-                    const userpoolId = qpqDeployAwsCdkUtils.importStackValue(awsNamingUtils.getCFExportNameUserPoolIdFromConfig(userDirectoryConfig.name, qpqConfig));
+                    const userpoolId = userDirectoryConstructs[index].userPool.userPoolId;
                     return `arn:aws:cognito-idp:${awsRegion}:${awsAccountId}:userpool/${userpoolId}`;
                 }),
             }));

package/lib/esm/stacks/InfQpqServiceStack.js

@@ -50,12 +50,13 @@ export class InfQpqServiceStack extends QpqServiceStack {
         QpqCoreQueueConstruct.authorizeActionsForRole(webserverRole, queues);
         // end queues
         // User Directories
-        const userDirectories = qpqCoreUtils.getOwnedUserDirectories(props.qpqConfig).map((setting) => new QpqCoreUserDirectoryConstruct(this, qpqCoreUtils.getUniqueKeyForSetting(setting), {
+        const ownedUserDirectoriesConfigs = qpqCoreUtils.getOwnedUserDirectories(props.qpqConfig);
+        const userDirectories = ownedUserDirectoriesConfigs.map((setting) => new QpqCoreUserDirectoryConstruct(this, qpqCoreUtils.getUniqueKeyForSetting(setting), {
             awsAccountId: props.awsAccountId,
             qpqConfig: props.qpqConfig,
             userDirectoryConfig: setting,
         }));
-        QpqCoreUserDirectoryConstruct.authorizeActionsForRole(webserverRole, qpqCoreUtils.getOwnedUserDirectories(props.qpqConfig), props.qpqConfig);
+        QpqCoreUserDirectoryConstruct.authorizeActionsForRole(webserverRole, ownedUserDirectoriesConfigs, userDirectories, props.qpqConfig);
         // Api Keys
         const apiKeys = qpqWebServerUtils.getAllApiKeyConfigs(props.qpqConfig).map((setting) => new QpqWebserverApiKeyConstruct(this, qpqCoreUtils.getUniqueKeyForSetting(setting), {
             awsAccountId: props.awsAccountId,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quidproquo-deploy-awscdk",
-  "version": "0.0.201",
+  "version": "0.0.202",
   "description": "",
   "main": "./lib/commonjs/index.js",
   "module": "./lib/esm/index.js",
@@ -35,18 +35,18 @@
     "constructs": "^10.1.208",
     "esbuild": "^0.15.16",
     "liquidjs": "^10.7.0",
-    "quidproquo-actionprocessor-awslambda": "0.0.201",
-    "quidproquo-actionprocessor-node": "0.0.201",
-    "quidproquo-config-aws": "0.0.201",
-    "quidproquo-core": "0.0.201",
-    "quidproquo-webserver": "0.0.201"
+    "quidproquo-actionprocessor-awslambda": "0.0.202",
+    "quidproquo-actionprocessor-node": "0.0.202",
+    "quidproquo-config-aws": "0.0.202",
+    "quidproquo-core": "0.0.202",
+    "quidproquo-webserver": "0.0.202"
   },
   "devDependencies": {
     "@types/aws-lambda": "^8.10.109",
     "@types/babel__traverse": "7.18.2",
     "@types/node": "^20.2.1",
     "@types/prettier": "2.6.0",
-    "quidproquo-tsconfig": "0.0.201",
+    "quidproquo-tsconfig": "0.0.202",
     "ts-node": "^10.9.1",
     "typescript": "^4.9.3"
   }

package/src/QPQApp.ts

@@ -1,5 +1,5 @@
-import * as cdk from 'aws-cdk-lib';
-
-export const createQPQApp = (): cdk.App => {
-  return new cdk.App();
-};
+import * as cdk from 'aws-cdk-lib';
+
+export const createQPQApp = (): cdk.App => {
+  return new cdk.App();
+};

package/src/constants/BootstrapResource.ts

@@ -1,3 +1,3 @@
-export enum BootstrapResource {
-  WarmLambdas = 'WarmLambdas',
-}
+export enum BootstrapResource {
+  WarmLambdas = 'WarmLambdas',
+}

package/src/constants/index.ts

@@ -1,3 +1,3 @@
-export * from './logging';
-export * from './warmLambdas';
-export * from './BootstrapResource';
+export * from './logging';
+export * from './warmLambdas';
+export * from './BootstrapResource';

package/src/constants/logging.ts

@@ -1 +1 @@
-export const QPQ_LOG_BUCKET_NAME = 'logs';
+export const QPQ_LOG_BUCKET_NAME = 'logs';

package/src/constants/warmLambdas.ts

@@ -1,3 +1,3 @@
-import { QpqWarmLambdaEvent } from '../types';
-
-export const WARM_LAMBDA_EVENT: QpqWarmLambdaEvent = { qpqWarm: true };
+import { QpqWarmLambdaEvent } from '../types';
+
+export const WARM_LAMBDA_EVENT: QpqWarmLambdaEvent = { qpqWarm: true };

package/src/constructs/base/QpqConstructBlock.ts

@@ -1,69 +1,69 @@
-import { awsNamingUtils } from 'quidproquo-actionprocessor-awslambda';
-import { QPQConfig } from 'quidproquo-core';
-import { Construct } from 'constructs';
-
-import { QpqResource } from './QpqResource';
-import { IGrantable, IRole } from 'aws-cdk-lib/aws-iam';
-import { aws_iam } from 'aws-cdk-lib';
-
-export interface QpqConstructBlockProps {
-  awsAccountId: string;
-  qpqConfig: QPQConfig;
-}
-
-export class QpqConstructBlock extends Construct implements QpqResource {
-  awsAccountId: string;
-  qpqConfig: QPQConfig;
-  serviceRole?: aws_iam.IRole;
-
-  constructor(scope: Construct, id: string, props: QpqConstructBlockProps) {
-    super(scope, id);
-
-    this.awsAccountId = props.awsAccountId;
-    this.qpqConfig = props.qpqConfig;
-  }
-
-  resourceName(name: string) {
-    return awsNamingUtils.getConfigRuntimeResourceNameFromConfig(name, this.qpqConfig);
-  }
-
-  resourceNameWithModuleOveride(name: string, module?: string) {
-    return awsNamingUtils.getConfigRuntimeResourceNameFromConfigWithServiceOverride(
-      name,
-      this.qpqConfig,
-      module,
-    );
-  }
-
-  qpqResourceName(name: string, resourceType: string) {
-    return awsNamingUtils.getQpqRuntimeResourceNameFromConfig(name, this.qpqConfig, resourceType);
-  }
-
-  qpqBootstrapResourceName(name: string) {
-    return awsNamingUtils.getConfigRuntimeBootstrapResourceNameFromConfig(name, this.qpqConfig);
-  }
-
-  grantRead(grantee: IGrantable): void {}
-
-  grantWrite(grantee: IGrantable): void {}
-
-  grantAll(grantee: IGrantable): void {
-    this.grantRead(grantee);
-    this.grantWrite(grantee);
-  }
-
-  getServiceRole(): aws_iam.IRole {
-    if (!this.serviceRole) {
-      this.serviceRole = aws_iam.Role.fromRoleName(
-        this,
-        'service-role',
-        this.resourceName('service-role'),
-        {
-          mutable: true,
-        },
-      );
-    }
-
-    return this.serviceRole;
-  }
-}
+import { awsNamingUtils } from 'quidproquo-actionprocessor-awslambda';
+import { QPQConfig } from 'quidproquo-core';
+import { Construct } from 'constructs';
+
+import { QpqResource } from './QpqResource';
+import { IGrantable, IRole } from 'aws-cdk-lib/aws-iam';
+import { aws_iam } from 'aws-cdk-lib';
+
+export interface QpqConstructBlockProps {
+  awsAccountId: string;
+  qpqConfig: QPQConfig;
+}
+
+export class QpqConstructBlock extends Construct implements QpqResource {
+  awsAccountId: string;
+  qpqConfig: QPQConfig;
+  serviceRole?: aws_iam.IRole;
+
+  constructor(scope: Construct, id: string, props: QpqConstructBlockProps) {
+    super(scope, id);
+
+    this.awsAccountId = props.awsAccountId;
+    this.qpqConfig = props.qpqConfig;
+  }
+
+  resourceName(name: string) {
+    return awsNamingUtils.getConfigRuntimeResourceNameFromConfig(name, this.qpqConfig);
+  }
+
+  resourceNameWithModuleOveride(name: string, module?: string) {
+    return awsNamingUtils.getConfigRuntimeResourceNameFromConfigWithServiceOverride(
+      name,
+      this.qpqConfig,
+      module,
+    );
+  }
+
+  qpqResourceName(name: string, resourceType: string) {
+    return awsNamingUtils.getQpqRuntimeResourceNameFromConfig(name, this.qpqConfig, resourceType);
+  }
+
+  qpqBootstrapResourceName(name: string) {
+    return awsNamingUtils.getConfigRuntimeBootstrapResourceNameFromConfig(name, this.qpqConfig);
+  }
+
+  grantRead(grantee: IGrantable): void {}
+
+  grantWrite(grantee: IGrantable): void {}
+
+  grantAll(grantee: IGrantable): void {
+    this.grantRead(grantee);
+    this.grantWrite(grantee);
+  }
+
+  getServiceRole(): aws_iam.IRole {
+    if (!this.serviceRole) {
+      this.serviceRole = aws_iam.Role.fromRoleName(
+        this,
+        'service-role',
+        this.resourceName('service-role'),
+        {
+          mutable: true,
+        },
+      );
+    }
+
+    return this.serviceRole;
+  }
+}

package/src/constructs/base/QpqResource.ts

@@ -1,24 +1,24 @@
-import { aws_iam } from 'aws-cdk-lib';
-
-export interface QpqResource {
-  /**
-   * Grants read permissions on this resource.
-   *
-   * @param grantee the role to be granted read-only access to the resource.
-   */
-  grantRead(grantee: aws_iam.IGrantable): void;
-
-  /**
-   * Grants write permissions on the resource.
-   *
-   * @param grantee the role to be granted write access to the resource.
-   */
-  grantWrite(grantee: aws_iam.IGrantable): void;
-
-  /**
-   * Grants read/write permissions on the resource.
-   *
-   * @param grantee the role to be granted read/write access to the resource.
-   */
-  grantAll(grantee: aws_iam.IGrantable): void;
-}
+import { aws_iam } from 'aws-cdk-lib';
+
+export interface QpqResource {
+  /**
+   * Grants read permissions on this resource.
+   *
+   * @param grantee the role to be granted read-only access to the resource.
+   */
+  grantRead(grantee: aws_iam.IGrantable): void;
+
+  /**
+   * Grants write permissions on the resource.
+   *
+   * @param grantee the role to be granted write access to the resource.
+   */
+  grantWrite(grantee: aws_iam.IGrantable): void;
+
+  /**
+   * Grants read/write permissions on the resource.
+   *
+   * @param grantee the role to be granted read/write access to the resource.
+   */
+  grantAll(grantee: aws_iam.IGrantable): void;
+}

package/src/constructs/base/index.ts

@@ -1,2 +1,2 @@
-export * from './QpqConstructBlock';
-export * from './QpqResource';
+export * from './QpqConstructBlock';
+export * from './QpqResource';

package/src/constructs/basic/BSQpqLambdaWarmerEventConstruct.ts

@@ -1,33 +1,33 @@
-import { aws_events, aws_sns, aws_events_targets } from 'aws-cdk-lib';
-
-import { QpqConstructBlock, QpqConstructBlockProps } from '../base/QpqConstructBlock';
-import { Construct } from 'constructs';
-
-import { BootstrapResource } from '../../constants';
-
-export interface BSQpqLambdaWarmerEventConstructConstructProps extends QpqConstructBlockProps {}
-
-export class BSQpqLambdaWarmerEventConstructConstruct extends QpqConstructBlock {
-  constructor(scope: Construct, id: string, props: BSQpqLambdaWarmerEventConstructConstructProps) {
-    super(scope, id, props);
-
-    const rule = new aws_events.Rule(this, 'WarmLambdaRule', {
-      ruleName: this.qpqBootstrapResourceName(BootstrapResource.WarmLambdas),
-      // Create an EventBridge rule to trigger the Lambda every X minutes
-      schedule: aws_events.Schedule.expression('rate(5 minutes)'),
-    });
-
-    const topic = new aws_sns.Topic(this, 'MyTopic', {
-      topicName: this.qpqBootstrapResourceName(BootstrapResource.WarmLambdas),
-      displayName: 'Warm Lambdas',
-    });
-
-    rule.addTarget(
-      new aws_events_targets.SnsTopic(topic, {
-        message: aws_events.RuleTargetInput.fromObject({
-          type: 'QpqLambdaWarmerEvent',
-        }),
-      }),
-    );
-  }
-}
+import { aws_events, aws_sns, aws_events_targets } from 'aws-cdk-lib';
+
+import { QpqConstructBlock, QpqConstructBlockProps } from '../base/QpqConstructBlock';
+import { Construct } from 'constructs';
+
+import { BootstrapResource } from '../../constants';
+
+export interface BSQpqLambdaWarmerEventConstructConstructProps extends QpqConstructBlockProps {}
+
+export class BSQpqLambdaWarmerEventConstructConstruct extends QpqConstructBlock {
+  constructor(scope: Construct, id: string, props: BSQpqLambdaWarmerEventConstructConstructProps) {
+    super(scope, id, props);
+
+    const rule = new aws_events.Rule(this, 'WarmLambdaRule', {
+      ruleName: this.qpqBootstrapResourceName(BootstrapResource.WarmLambdas),
+      // Create an EventBridge rule to trigger the Lambda every X minutes
+      schedule: aws_events.Schedule.expression('rate(5 minutes)'),
+    });
+
+    const topic = new aws_sns.Topic(this, 'MyTopic', {
+      topicName: this.qpqBootstrapResourceName(BootstrapResource.WarmLambdas),
+      displayName: 'Warm Lambdas',
+    });
+
+    rule.addTarget(
+      new aws_events_targets.SnsTopic(topic, {
+        message: aws_events.RuleTargetInput.fromObject({
+          type: 'QpqLambdaWarmerEvent',
+        }),
+      }),
+    );
+  }
+}