@beesolve/cdk-constructs 0.1.0

package/README.md

@@ -0,0 +1,9 @@
+# CDK constructs
+
+This repository contains various CDK construct built at BeeSolve.
+
+## Installation
+
+```bash
+npm i @beesolve/cdk-constructs
+```

package/dist/index.d.ts

@@ -0,0 +1,213 @@
+import { DistributionProps } from "aws-cdk-lib/aws-cloudfront";
+import { Construct } from "constructs";
+/**
+* List of all CloudFront access log columns.
+*
+* @link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html#BasicDistributionFileFormat
+*/
+declare const cloudFrontAccessLogColumns: readonly [{
+	readonly name: "date";
+	readonly type: "date";
+}, {
+	readonly name: "time";
+	readonly type: "string";
+}, {
+	readonly name: "x-edge-location";
+	readonly type: "string";
+}, {
+	readonly name: "sc-bytes";
+	readonly type: "string";
+}, {
+	readonly name: "c-ip";
+	readonly type: "string";
+}, {
+	readonly name: "cs-method";
+	readonly type: "string";
+}, {
+	readonly name: "cs(Host)";
+	readonly type: "string";
+}, {
+	readonly name: "cs-uri-stem";
+	readonly type: "string";
+}, {
+	readonly name: "sc-status";
+	readonly type: "string";
+}, {
+	readonly name: "cs(Referer)";
+	readonly type: "string";
+}, {
+	readonly name: "cs(User-Agent)";
+	readonly type: "string";
+}, {
+	readonly name: "cs-uri-query";
+	readonly type: "string";
+}, {
+	readonly name: "cs(Cookie)";
+	readonly type: "string";
+}, {
+	readonly name: "x-edge-result-type";
+	readonly type: "string";
+}, {
+	readonly name: "x-edge-request-id";
+	readonly type: "string";
+}, {
+	readonly name: "x-host-header";
+	readonly type: "string";
+}, {
+	readonly name: "cs-protocol";
+	readonly type: "string";
+}, {
+	readonly name: "cs-bytes";
+	readonly type: "string";
+}, {
+	readonly name: "time-taken";
+	readonly type: "string";
+}, {
+	readonly name: "x-forwarded-for";
+	readonly type: "string";
+}, {
+	readonly name: "ssl-protocol";
+	readonly type: "string";
+}, {
+	readonly name: "ssl-cipher";
+	readonly type: "string";
+}, {
+	readonly name: "x-edge-response-result-type";
+	readonly type: "string";
+}, {
+	readonly name: "cs-protocol-version";
+	readonly type: "string";
+}, {
+	readonly name: "fle-status";
+	readonly type: "string";
+}, {
+	readonly name: "fle-encrypted-fields";
+	readonly type: "string";
+}, {
+	readonly name: "c-port";
+	readonly type: "string";
+}, {
+	readonly name: "time-to-first-byte";
+	readonly type: "string";
+}, {
+	readonly name: "x-edge-detailed-result-type";
+	readonly type: "string";
+}, {
+	readonly name: "sc-content-type";
+	readonly type: "string";
+}, {
+	readonly name: "sc-content-len";
+	readonly type: "string";
+}, {
+	readonly name: "sc-range-start";
+	readonly type: "string";
+}, {
+	readonly name: "sc-range-end";
+	readonly type: "string";
+}];
+type CloudFrontAccessLogColumn = (typeof cloudFrontAccessLogColumns)[number]["name"];
+interface CloudFrontAccessLoggingSettingsProps extends Pick<DistributionProps, "logFilePrefix" | "logIncludesCookies"> {
+	/**
+	* Athena related settings.
+	*
+	* When not defined, no glue nor athena are being deployed.
+	*
+	* @default undefined
+	*/
+	readonly athena?: {
+		/**
+		* Current account number.
+		*/
+		readonly account: string;
+		/**
+		* Provide custom glue database name.
+		*
+		* @default cf_logs_db
+		*/
+		readonly glueDbName?: string;
+		/**
+		* Provide custom glue table name.
+		*
+		* @default cf_logs_table
+		*/
+		readonly glueTableName?: string;
+		/**
+		* Provide custom athena workgroup name.
+		*
+		* @default cf_workgroup
+		*/
+		readonly workGroupName?: string;
+		/**
+		* You can pick individual columns from the access logs which will be stored inside the glue table.
+		*
+		* @default all available columns
+		*/
+		readonly columns?: CloudFrontAccessLogColumn[];
+		/**
+		* When `true` sample query is created within the Athena.
+		*
+		* @default true
+		*/
+		readonly createSampleQuery?: boolean;
+	};
+}
+declare class CloudFrontAccessLoggingSettings extends Construct {
+	readonly cloudFrontLoggingSettings: Pick<DistributionProps, "logBucket" | "logFilePrefix" | "enableLogging" | "logIncludesCookies">;
+	constructor(scope: Construct, id: string, props: CloudFrontAccessLoggingSettingsProps);
+}
+import { Duration } from "aws-cdk-lib";
+import { Function } from "aws-cdk-lib/aws-lambda";
+import { Queue } from "aws-cdk-lib/aws-sqs";
+import { Construct as Construct2 } from "constructs";
+declare class EmailAlarms extends Construct2 {
+	private emailSubscription;
+	constructor(scope: Construct2, id: string, props: {
+		readonly emailAddress: string;
+	});
+	readonly reportLambdaErrors: (handler: Function) => void;
+	readonly reportSqsErrors: (props: {
+		readonly queue: Queue;
+		readonly dlq: Queue;
+		readonly noMessagesPeriod?: Duration;
+		readonly noConsumersPeriod?: Duration;
+	}) => void;
+}
+import { Function as Function2 } from "aws-cdk-lib/aws-lambda";
+import { SqsEventSourceProps } from "aws-cdk-lib/aws-lambda-event-sources";
+import { Queue as Queue2, QueueProps } from "aws-cdk-lib/aws-sqs";
+import { Construct as Construct3 } from "constructs";
+interface SqsWithDlqProps {
+	readonly queue?: QueueProps;
+	readonly dlq?: Partial<Omit<QueueProps, "fifo" | "contentBasedDeduplication" | "deduplicationScope">>;
+}
+declare class SqsWithDlq extends Construct3 {
+	readonly queue: Queue2;
+	readonly dlq: Queue2;
+	constructor(scope: Construct3, id: string, props?: SqsWithDlqProps);
+	/**
+	* Uses the queue as an input for the given lambda function.
+	*
+	* Allows to batch and throttle the lambda invocations.
+	*/
+	static asLambdaInput(props: SqsWithDlqLambdaInputProps): SqsWithDlq;
+}
+interface SqsWithDlqLambdaInputProps extends SqsWithDlqProps {
+	/**
+	* Lambda function used to handle the SQS messages.
+	*/
+	readonly lambda: Function2;
+	/**
+	* SQS message batching configuration.
+	*/
+	readonly batching?: BatchingConfig;
+	/**
+	* Set to true to disable the consumption of messages.
+	*
+	* Useful when the processing needs to be paused during maintenance.
+	*
+	* @default false
+	*/
+	readonly disabled?: boolean;
+}
+type BatchingConfig = Pick<SqsEventSourceProps, "batchSize" | "maxBatchingWindow" | "reportBatchItemFailures" | "maxConcurrency">;
+export { SqsWithDlqProps, SqsWithDlqLambdaInputProps, SqsWithDlq, EmailAlarms, CloudFrontAccessLoggingSettingsProps, CloudFrontAccessLoggingSettings };

package/dist/index.js

@@ -0,0 +1,247 @@
+// packages/cdk-constructs/src/cloudFrontAccessLoggingSettings.ts
+import { isNotNil } from "@beesolve/helpers";
+import { CfnNamedQuery, CfnWorkGroup } from "aws-cdk-lib/aws-athena";
+import { CfnDatabase, CfnTable } from "aws-cdk-lib/aws-glue";
+import { Bucket, ObjectOwnership } from "aws-cdk-lib/aws-s3";
+import { Construct } from "constructs";
+var cloudFrontAccessLogColumns = [
+  { name: "date", type: "date" },
+  { name: "time", type: "string" },
+  { name: "x-edge-location", type: "string" },
+  { name: "sc-bytes", type: "string" },
+  { name: "c-ip", type: "string" },
+  { name: "cs-method", type: "string" },
+  { name: "cs(Host)", type: "string" },
+  { name: "cs-uri-stem", type: "string" },
+  { name: "sc-status", type: "string" },
+  { name: "cs(Referer)", type: "string" },
+  { name: "cs(User-Agent)", type: "string" },
+  { name: "cs-uri-query", type: "string" },
+  { name: "cs(Cookie)", type: "string" },
+  { name: "x-edge-result-type", type: "string" },
+  { name: "x-edge-request-id", type: "string" },
+  { name: "x-host-header", type: "string" },
+  { name: "cs-protocol", type: "string" },
+  { name: "cs-bytes", type: "string" },
+  { name: "time-taken", type: "string" },
+  { name: "x-forwarded-for", type: "string" },
+  { name: "ssl-protocol", type: "string" },
+  { name: "ssl-cipher", type: "string" },
+  { name: "x-edge-response-result-type", type: "string" },
+  { name: "cs-protocol-version", type: "string" },
+  { name: "fle-status", type: "string" },
+  { name: "fle-encrypted-fields", type: "string" },
+  { name: "c-port", type: "string" },
+  { name: "time-to-first-byte", type: "string" },
+  { name: "x-edge-detailed-result-type", type: "string" },
+  { name: "sc-content-type", type: "string" },
+  { name: "sc-content-len", type: "string" },
+  { name: "sc-range-start", type: "string" },
+  { name: "sc-range-end", type: "string" }
+];
+var columnDefinitionByKey = Object.fromEntries(cloudFrontAccessLogColumns.map((value) => [value.name, value]));
+
+class CloudFrontAccessLoggingSettings extends Construct {
+  cloudFrontLoggingSettings;
+  constructor(scope, id, props) {
+    super(scope, id);
+    const logBucket = new Bucket(this, "AccessLogs", {
+      objectOwnership: ObjectOwnership.OBJECT_WRITER
+    });
+    if (props.athena != null) {
+      const databaseName = props.athena.glueDbName ?? "cf_logs_db";
+      const tableName = props.athena.glueTableName ?? "cf_logs_table";
+      const workgroupName = props.athena.workGroupName ?? "cf_workgroup";
+      const glueDatabase = new CfnDatabase(this, "AccessLogsGlueDb", {
+        catalogId: props.athena.account,
+        databaseInput: {
+          description: "Glue DB for CloudFront access logs",
+          name: databaseName
+        }
+      });
+      const glueTable = new CfnTable(this, "AccessLogsGlueTable", {
+        catalogId: props.athena.account,
+        databaseName,
+        tableInput: {
+          name: tableName,
+          description: "Glue table for CloudFront access logs",
+          storageDescriptor: {
+            columns: props.athena.columns == null ? [...cloudFrontAccessLogColumns] : Array.from(new Set(props.athena.columns)).map((column) => columnDefinitionByKey[column]).filter(isNotNil),
+            location: `s3://${logBucket.bucketName}/${props.logFilePrefix ?? ""}`,
+            inputFormat: "org.apache.hadoop.mapred.TextInputFormat",
+            outputFormat: "org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat",
+            serdeInfo: {
+              serializationLibrary: "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe",
+              parameters: {
+                "serialization.format": "\t",
+                "field.delim": "\t"
+              }
+            }
+          },
+          parameters: {
+            "skip.header.line.count": 2
+          },
+          tableType: "EXTERNAL_TABLE"
+        }
+      });
+      glueTable.addDependency(glueDatabase);
+      const athenaBucket = new Bucket(this, "AthenaBucket");
+      const workgroup = new CfnWorkGroup(this, "Workgroup", {
+        name: workgroupName,
+        workGroupConfiguration: {
+          resultConfiguration: {
+            outputLocation: `s3://${athenaBucket.bucketName}/`
+          }
+        }
+      });
+      if (props.athena.createSampleQuery !== false) {
+        const sampleQuery = new CfnNamedQuery(this, "SampleNamedQuery", {
+          name: "sample_query",
+          queryString: `SELECT * FROM "${databaseName}"."${tableName}" limit 25;`,
+          database: databaseName,
+          workGroup: workgroup.name
+        });
+        sampleQuery.addDependency(workgroup);
+      }
+    }
+    this.cloudFrontLoggingSettings = {
+      enableLogging: true,
+      logBucket,
+      logFilePrefix: props.logFilePrefix,
+      logIncludesCookies: props.logIncludesCookies ?? false
+    };
+  }
+}
+// packages/cdk-constructs/src/emailAlarms.ts
+import {
+  Alarm,
+  ComparisonOperator,
+  TreatMissingData
+} from "aws-cdk-lib/aws-cloudwatch";
+import { SnsAction } from "aws-cdk-lib/aws-cloudwatch-actions";
+import { Topic } from "aws-cdk-lib/aws-sns";
+import { EmailSubscription } from "aws-cdk-lib/aws-sns-subscriptions";
+import { Construct as Construct2 } from "constructs";
+
+class EmailAlarms extends Construct2 {
+  emailSubscription;
+  constructor(scope, id, props) {
+    super(scope, id);
+    this.emailSubscription = new EmailSubscription(props.emailAddress);
+  }
+  reportLambdaErrors = (handler) => {
+    const topic = new Topic(handler, "ErrorAlarmTopic");
+    topic.addSubscription(this.emailSubscription);
+    const alarm = new Alarm(handler, `ErrorAlarm`, {
+      metric: handler.metricErrors(),
+      threshold: 1,
+      evaluationPeriods: 1,
+      comparisonOperator: ComparisonOperator.GREATER_THAN_OR_EQUAL_TO_THRESHOLD,
+      treatMissingData: TreatMissingData.IGNORE
+    });
+    alarm.addOkAction(new SnsAction(topic));
+    alarm.addAlarmAction(new SnsAction(topic));
+  };
+  reportSqsErrors = (props) => {
+    const dlqTopic = new Topic(props.dlq, "DlqAlarmTopic");
+    dlqTopic.addSubscription(this.emailSubscription);
+    const dlqAlarm = new Alarm(this, "DlqAlarm", {
+      alarmDescription: `DLQ for ${props.queue.queueName} is not empty.`,
+      metric: props.dlq.metricApproximateNumberOfMessagesVisible(),
+      threshold: 1,
+      evaluationPeriods: 1,
+      comparisonOperator: ComparisonOperator.GREATER_THAN_OR_EQUAL_TO_THRESHOLD,
+      treatMissingData: TreatMissingData.IGNORE
+    });
+    dlqAlarm.addAlarmAction(new SnsAction(dlqTopic));
+    if (props.noMessagesPeriod || props.noConsumersPeriod) {
+      const queueTopic = new Topic(props.queue, "QueueAlarmTopic");
+      queueTopic.addSubscription(this.emailSubscription);
+      if (props.noMessagesPeriod) {
+        const noMessages = new Alarm(this, "NoMessagesAlarm", {
+          alarmDescription: `Queue received no messages for ${props.noMessagesPeriod.toHumanString()}.`,
+          metric: props.queue.metric("NumberOfMessagesSent", {
+            statistic: "Sum",
+            period: props.noMessagesPeriod
+          }),
+          threshold: 0,
+          evaluationPeriods: 1,
+          comparisonOperator: ComparisonOperator.LESS_THAN_OR_EQUAL_TO_THRESHOLD,
+          treatMissingData: TreatMissingData.BREACHING
+        });
+        noMessages.addAlarmAction(new SnsAction(queueTopic));
+      }
+      if (props.noConsumersPeriod) {
+        const noConsumers = new Alarm(this, "NoConsumersAlarm", {
+          alarmDescription: `Queue had no consumers for ${props.noConsumersPeriod.toHumanString()}.`,
+          metric: props.queue.metric("NumberOfMessagesReceived", {
+            statistic: "Sum",
+            period: props.noConsumersPeriod
+          }),
+          threshold: 0,
+          evaluationPeriods: 1,
+          comparisonOperator: ComparisonOperator.LESS_THAN_OR_EQUAL_TO_THRESHOLD,
+          treatMissingData: TreatMissingData.BREACHING
+        });
+        noConsumers.addAlarmAction(new SnsAction(queueTopic));
+      }
+    }
+  };
+}
+// packages/cdk-constructs/src/sqsWithDlq.ts
+import { Duration } from "aws-cdk-lib";
+import {
+  SqsEventSource
+} from "aws-cdk-lib/aws-lambda-event-sources";
+import { Queue, QueueEncryption } from "aws-cdk-lib/aws-sqs";
+import { Construct as Construct3 } from "constructs";
+
+class SqsWithDlq extends Construct3 {
+  queue;
+  dlq;
+  constructor(scope, id, props = {}) {
+    super(scope, id);
+    this.dlq = new Queue(this, "Dlq", {
+      fifo: props.queue?.fifo,
+      contentBasedDeduplication: props.queue?.contentBasedDeduplication,
+      deduplicationScope: props.queue?.deduplicationScope,
+      encryption: QueueEncryption.SQS_MANAGED,
+      enforceSSL: true,
+      retentionPeriod: Duration.days(14),
+      ...props?.dlq
+    });
+    this.queue = new Queue(this, "Queue", {
+      encryption: QueueEncryption.SQS_MANAGED,
+      enforceSSL: true,
+      retentionPeriod: Duration.days(14),
+      ...props.queue,
+      deadLetterQueue: {
+        queue: this.dlq,
+        maxReceiveCount: 5,
+        ...props.queue?.deadLetterQueue
+      }
+    });
+  }
+  static asLambdaInput(props) {
+    const { lambda, batching, ...sqsProps } = props;
+    const handlerTimeout = lambda.timeout ?? Duration.seconds(3);
+    const sqs = new SqsWithDlq(lambda, "Input", {
+      ...sqsProps,
+      queue: {
+        visibilityTimeout: Duration.seconds(Math.min(handlerTimeout.toSeconds() * 6, 43200)),
+        ...sqsProps.queue
+      }
+    });
+    lambda.addEventSource(new SqsEventSource(sqs.queue, {
+      ...batching,
+      reportBatchItemFailures: true,
+      enabled: props.disabled !== true
+    }));
+    return sqs;
+  }
+}
+export {
+  SqsWithDlq,
+  EmailAlarms,
+  CloudFrontAccessLoggingSettings
+};

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@beesolve/cdk-constructs",
+  "version": "0.1.0",
+  "description": "",
+  "homepage": "https://github.com/beesolve/packages/tree/main/packages/cdk-constructs#readme",
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/beesolve/packages.git"
+  },
+  "scripts": {
+    "type-check": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "typescript": "catalog:"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "aws-cdk-lib": "catalog:",
+    "constructs": "catalog:",
+    "@beesolve/helpers": "workspace:*"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts"
+}