@orcabus/platform-cdk-constructs 0.0.21 → 0.0.23

package/.jsii

@@ -4058,6 +4058,16 @@
       },
       "symbolId": "lambda/index:"
     },
+    "@orcabus/platform-cdk-constructs.monitoredQueue": {
+      "locationInModule": {
+        "filename": "index.ts",
+        "line": 22
+      },
+      "readme": {
+        "markdown": "# MonitoredQueue\n\nA construct creating an SQS queue that has an attached dead-letter queue and an alarm that triggers when a message\narrives in the dead-letter queue. An SNS topic can also be notified when the alarm triggers.\n\nUsage example:\n\n```ts\nnew MonitoredQueue(this, \"MonitoredQueue\", {\n  queueProps: {\n    queueName: \"queue\",\n    removalPolicy: RemovalPolicy.RETAIN,\n  },\n  dlqProps: {\n    queueName: `$queue-dlq`,\n    removalPolicy: RemovalPolicy.RETAIN,\n    retentionPeriod: Duration.days(14),\n  },\n  snsTopicArn: SlackAlerts.formatArn(this),\n});\n```\n"
+      },
+      "symbolId": "monitored-queue/index:"
+    },
     "@orcabus/platform-cdk-constructs.namedLambdaRole": {
       "locationInModule": {
         "filename": "index.ts",
@@ -4137,6 +4147,13 @@
       },
       "symbolId": "shared-config/s3:"
     },
+    "@orcabus/platform-cdk-constructs.sharedConfig.slack": {
+      "locationInModule": {
+        "filename": "shared-config/index.ts",
+        "line": 8
+      },
+      "symbolId": "shared-config/slack:"
+    },
     "@orcabus/platform-cdk-constructs.utils": {
       "locationInModule": {
         "filename": "index.ts",
@@ -5391,7 +5408,7 @@
         },
         "locationInModule": {
           "filename": "ecs/index.ts",
-          "line": 85
+          "line": 88
         },
         "parameters": [
           {
@@ -5417,7 +5434,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "ecs/index.ts",
-        "line": 79
+        "line": 82
       },
       "name": "EcsFargateTaskConstruct",
       "namespace": "ecs",
@@ -5429,7 +5446,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "ecs/index.ts",
-            "line": 80
+            "line": 83
           },
           "name": "cluster",
           "type": {
@@ -5443,7 +5460,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "ecs/index.ts",
-            "line": 83
+            "line": 86
           },
           "name": "containerDefinition",
           "type": {
@@ -5457,7 +5474,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "ecs/index.ts",
-            "line": 82
+            "line": 85
           },
           "name": "securityGroup",
           "type": {
@@ -5471,7 +5488,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "ecs/index.ts",
-            "line": 81
+            "line": 84
           },
           "name": "taskDefinition",
           "type": {
@@ -5491,31 +5508,11 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "ecs/index.ts",
-        "line": 39
+        "line": 42
       },
       "name": "FargateEcsTaskConstructProps",
       "namespace": "ecs",
       "properties": [
-        {
-          "abstract": true,
-          "docs": {
-            "custom": {
-              "DEFAULT_ARCHITECTURE": "."
-            },
-            "remarks": "If not provided, the default is",
-            "stability": "experimental",
-            "summary": "The architecture of the container."
-          },
-          "immutable": true,
-          "locationInModule": {
-            "filename": "ecs/index.ts",
-            "line": 65
-          },
-          "name": "architecture",
-          "type": {
-            "primitive": "string"
-          }
-        },
         {
           "abstract": true,
           "docs": {
@@ -5526,7 +5523,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "ecs/index.ts",
-            "line": 71
+            "line": 74
           },
           "name": "containerName",
           "type": {
@@ -5543,7 +5540,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "ecs/index.ts",
-            "line": 76
+            "line": 79
           },
           "name": "dockerPath",
           "type": {
@@ -5563,7 +5560,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "ecs/index.ts",
-            "line": 60
+            "line": 63
           },
           "name": "memoryLimitGiB",
           "type": {
@@ -5582,13 +5579,34 @@
           "immutable": true,
           "locationInModule": {
             "filename": "ecs/index.ts",
-            "line": 53
+            "line": 56
           },
           "name": "nCpus",
           "type": {
             "primitive": "number"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "custom": {
+              "DEFAULT_ARCHITECTURE": "."
+            },
+            "remarks": "If not provided, the default is",
+            "stability": "experimental",
+            "summary": "The architecture of the container."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "ecs/index.ts",
+            "line": 68
+          },
+          "name": "architecture",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -5602,9 +5620,10 @@
           "immutable": true,
           "locationInModule": {
             "filename": "ecs/index.ts",
-            "line": 48
+            "line": 51
           },
           "name": "runtimePlatform",
+          "optional": true,
           "type": {
             "fqn": "aws-cdk-lib.aws_ecs.CpuArchitecture"
           }
@@ -5622,7 +5641,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "ecs/index.ts",
-            "line": 43
+            "line": 46
           },
           "name": "vpcName",
           "optional": true,
@@ -6002,6 +6021,270 @@
       ],
       "symbolId": "lambda/index:PythonUvFunctionProps"
     },
+    "@orcabus/platform-cdk-constructs.monitoredQueue.MonitoredQueue": {
+      "assembly": "@orcabus/platform-cdk-constructs",
+      "base": "constructs.Construct",
+      "docs": {
+        "stability": "experimental",
+        "summary": "A construct that defines an SQS queue, along with a DLQ and CloudWatch alarms that can notify an SNS topic."
+      },
+      "fqn": "@orcabus/platform-cdk-constructs.monitoredQueue.MonitoredQueue",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "monitored-queue/index.ts",
+          "line": 62
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@orcabus/platform-cdk-constructs.monitoredQueue.MonitoredQueueProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "monitored-queue/index.ts",
+        "line": 57
+      },
+      "name": "MonitoredQueue",
+      "namespace": "monitoredQueue",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "monitored-queue/index.ts",
+            "line": 60
+          },
+          "name": "alarm",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_cloudwatch.Alarm"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "monitored-queue/index.ts",
+            "line": 59
+          },
+          "name": "deadLetterQueue",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_sqs.Queue"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "monitored-queue/index.ts",
+            "line": 58
+          },
+          "name": "queue",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_sqs.Queue"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Get the SQS queue ARN."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "monitored-queue/index.ts",
+            "line": 98
+          },
+          "name": "queueArn",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "monitored-queue/index:MonitoredQueue"
+    },
+    "@orcabus/platform-cdk-constructs.monitoredQueue.MonitoredQueueProps": {
+      "assembly": "@orcabus/platform-cdk-constructs",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Properties for the monitored queue."
+      },
+      "fqn": "@orcabus/platform-cdk-constructs.monitoredQueue.MonitoredQueueProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "monitored-queue/index.ts",
+        "line": 15
+      },
+      "name": "MonitoredQueueProps",
+      "namespace": "monitoredQueue",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The props for the dead-letter SQS queue when a message fails."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "monitored-queue/index.ts",
+            "line": 23
+          },
+          "name": "dlqProps",
+          "optional": true,
+          "type": {
+            "fqn": "@orcabus/platform-cdk-constructs.monitoredQueue.QueueProps"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Defaults to 3.",
+            "stability": "experimental",
+            "summary": "The maximum number of times a message can be unsuccessfully received before pushing it to the DLQ."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "monitored-queue/index.ts",
+            "line": 28
+          },
+          "name": "maxReceiveCount",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The props for the main SQS queue."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "monitored-queue/index.ts",
+            "line": 19
+          },
+          "name": "queueProps",
+          "optional": true,
+          "type": {
+            "fqn": "@orcabus/platform-cdk-constructs.monitoredQueue.QueueProps"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Send the alarm notification to the SNS topic with the ARN."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "monitored-queue/index.ts",
+            "line": 32
+          },
+          "name": "snsTopicArn",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "monitored-queue/index:MonitoredQueueProps"
+    },
+    "@orcabus/platform-cdk-constructs.monitoredQueue.QueueProps": {
+      "assembly": "@orcabus/platform-cdk-constructs",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Properties for an SQS queue."
+      },
+      "fqn": "@orcabus/platform-cdk-constructs.monitoredQueue.QueueProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "monitored-queue/index.ts",
+        "line": 38
+      },
+      "name": "QueueProps",
+      "namespace": "monitoredQueue",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Defaults to the automatically generated name.",
+            "stability": "experimental",
+            "summary": "The name of the queue to construct."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "monitored-queue/index.ts",
+            "line": 42
+          },
+          "name": "queueName",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The removal policy of the queue."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "monitored-queue/index.ts",
+            "line": 50
+          },
+          "name": "removalPolicy",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.RemovalPolicy"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "How long messages stay in the queue."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "monitored-queue/index.ts",
+            "line": 46
+          },
+          "name": "retentionPeriod",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.Duration"
+          }
+        }
+      ],
+      "symbolId": "monitored-queue/index:QueueProps"
+    },
     "@orcabus/platform-cdk-constructs.namedLambdaRole.NamedLambdaRole": {
       "assembly": "@orcabus/platform-cdk-constructs",
       "base": "aws-cdk-lib.aws_iam.Role",
@@ -6392,8 +6675,57 @@
       "name": "OrcaBusVpc",
       "namespace": "sharedConfig.networking",
       "symbolId": "shared-config/networking:OrcaBusVpc"
+    },
+    "@orcabus/platform-cdk-constructs.sharedConfig.slack.SlackAlerts": {
+      "assembly": "@orcabus/platform-cdk-constructs",
+      "docs": {
+        "stability": "experimental",
+        "summary": "A helper class to construct the arn for the slack SNS topic."
+      },
+      "fqn": "@orcabus/platform-cdk-constructs.sharedConfig.slack.SlackAlerts",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        }
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "shared-config/slack.ts",
+        "line": 11
+      },
+      "methods": [
+        {
+          "docs": {
+            "returns": "Arn",
+            "stability": "experimental",
+            "summary": "Format the ARN for the slack alerts SNS topic for the current stack."
+          },
+          "locationInModule": {
+            "filename": "shared-config/slack.ts",
+            "line": 17
+          },
+          "name": "formatArn",
+          "parameters": [
+            {
+              "name": "stack",
+              "type": {
+                "fqn": "aws-cdk-lib.Stack"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "aws-cdk-lib.Arn"
+            }
+          },
+          "static": true
+        }
+      ],
+      "name": "SlackAlerts",
+      "namespace": "sharedConfig.slack",
+      "symbolId": "shared-config/slack:SlackAlerts"
     }
   },
-  "version": "0.0.21",
-  "fingerprint": "ocycWmN0R4P5pAdGWJpdZGN2fHXJ4zpntMivR0rW1dM="
+  "version": "0.0.23",
+  "fingerprint": "4fn0wk+RzW3pVAC/lPFdr13Rjdu16ovw3uLpa6XVCSM="
 }

package/api-gateway/api-gateway.js

@@ -15,7 +15,7 @@ const aws_lambda_1 = require("aws-cdk-lib/aws-lambda");
 const aws_route53_targets_1 = require("aws-cdk-lib/aws-route53-targets");
 const config_1 = require("./config");
 class OrcaBusApiGateway extends constructs_1.Construct {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@orcabus/platform-cdk-constructs.apigateway.OrcaBusApiGateway", version: "0.0.21" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@orcabus/platform-cdk-constructs.apigateway.OrcaBusApiGateway", version: "0.0.23" };
     /**
      * The AWS region where the API Gateway is deployed.
      */

package/deployment-stack-pipeline/artifact-bucket.js

@@ -13,7 +13,7 @@ exports.CROSS_DEPLOYMENT_ARTIFACT_BUCKET_NAME = "orcabus-cross-deployment-codepi
 exports.CROSS_DEPLOYMENT_ARTIFACT_KMS_ALIAS = "orcabus-cross-deployment-codepipeline-artifact";
 exports.CROSS_DEPLOYMENT_ARTIFACT_KMS_ARN_SSM_PARAMETER_NAME = "/orcabus/deployment-stack-pipeline/artifact-bucket/kms-key-arn";
 class CrossDeploymentArtifactBucket extends constructs_1.Construct {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@orcabus/platform-cdk-constructs.deploymentPipeline.CrossDeploymentArtifactBucket", version: "0.0.21" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@orcabus/platform-cdk-constructs.deploymentPipeline.CrossDeploymentArtifactBucket", version: "0.0.23" };
     /**
      * The S3 bucket used to store artifacts for cross-deployment pipelines.
      */

package/deployment-stack-pipeline/pipeline.js

@@ -31,7 +31,7 @@ exports.DEFAULT_SYNTH_STEP_PARTIAL_BUILD_SPEC = {
  * before using this construct.
  */
 class DeploymentStackPipeline extends constructs_1.Construct {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@orcabus/platform-cdk-constructs.deploymentPipeline.DeploymentStackPipeline", version: "0.0.21" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@orcabus/platform-cdk-constructs.deploymentPipeline.DeploymentStackPipeline", version: "0.0.23" };
     /**
      * The code pipeline construct that is created.
      */

package/dynamodb/index.js

@@ -40,7 +40,7 @@ const dynamodb = __importStar(require("aws-cdk-lib/aws-dynamodb"));
 const aws_cdk_lib_1 = require("aws-cdk-lib");
 const config_1 = require("./config");
 class DynamoDbPartitionedConstruct extends constructs_1.Construct {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@orcabus/platform-cdk-constructs.dynamodb.DynamoDbPartitionedConstruct", version: "0.0.21" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@orcabus/platform-cdk-constructs.dynamodb.DynamoDbPartitionedConstruct", version: "0.0.23" };
     table;
     constructor(scope, id, props) {
         super(scope, id);
@@ -75,7 +75,7 @@ class DynamoDbPartitionedConstruct extends constructs_1.Construct {
 }
 exports.DynamoDbPartitionedConstruct = DynamoDbPartitionedConstruct;
 class DynamoDbNonPartitionedConstruct extends constructs_1.Construct {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@orcabus/platform-cdk-constructs.dynamodb.DynamoDbNonPartitionedConstruct", version: "0.0.21" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@orcabus/platform-cdk-constructs.dynamodb.DynamoDbNonPartitionedConstruct", version: "0.0.23" };
     table;
     constructor(scope, id, props) {
         super(scope, id);

package/ecs/config.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @deprecated, use VPC_NAME from shared-config instead
+ */
 export declare const DEFAULT_MAIN_VPC_NAME = "main-vpc";
 export declare const DEFAULT_MEMORY_GB = 1;
 export declare const DEFAULT_VCPUS = 2;

package/ecs/config.js

@@ -1,8 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DEFAULT_ARCHITECTURE = exports.DEFAULT_VCPUS = exports.DEFAULT_MEMORY_GB = exports.DEFAULT_MAIN_VPC_NAME = void 0;
+/**
+ * @deprecated, use VPC_NAME from shared-config instead
+ */
 exports.DEFAULT_MAIN_VPC_NAME = 'main-vpc';
 exports.DEFAULT_MEMORY_GB = 1;
 exports.DEFAULT_VCPUS = 2;
 exports.DEFAULT_ARCHITECTURE = 'ARM64';
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiY29uZmlnLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFhLFFBQUEscUJBQXFCLEdBQUcsVUFBVSxDQUFBO0FBRWxDLFFBQUEsaUJBQWlCLEdBQUcsQ0FBQyxDQUFBO0FBQ3JCLFFBQUEsYUFBYSxHQUFHLENBQUMsQ0FBQTtBQUVqQixRQUFBLG9CQUFvQixHQUFHLE9BQU8sQ0FBQSIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCBjb25zdCBERUZBVUxUX01BSU5fVlBDX05BTUUgPSAnbWFpbi12cGMnXG5cbmV4cG9ydCBjb25zdCBERUZBVUxUX01FTU9SWV9HQiA9IDFcbmV4cG9ydCBjb25zdCBERUZBVUxUX1ZDUFVTID0gMlxuXG5leHBvcnQgY29uc3QgREVGQVVMVF9BUkNISVRFQ1RVUkUgPSAnQVJNNjQnXG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiY29uZmlnLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBOztHQUVHO0FBQ1UsUUFBQSxxQkFBcUIsR0FBRyxVQUFVLENBQUE7QUFFbEMsUUFBQSxpQkFBaUIsR0FBRyxDQUFDLENBQUE7QUFDckIsUUFBQSxhQUFhLEdBQUcsQ0FBQyxDQUFBO0FBR2pCLFFBQUEsb0JBQW9CLEdBQUcsT0FBTyxDQUFBIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAZGVwcmVjYXRlZCwgdXNlIFZQQ19OQU1FIGZyb20gc2hhcmVkLWNvbmZpZyBpbnN0ZWFkXG4gKi9cbmV4cG9ydCBjb25zdCBERUZBVUxUX01BSU5fVlBDX05BTUUgPSAnbWFpbi12cGMnXG5cbmV4cG9ydCBjb25zdCBERUZBVUxUX01FTU9SWV9HQiA9IDFcbmV4cG9ydCBjb25zdCBERUZBVUxUX1ZDUFVTID0gMlxuXG5cbmV4cG9ydCBjb25zdCBERUZBVUxUX0FSQ0hJVEVDVFVSRSA9ICdBUk02NCdcbiJdfQ==

package/ecs/index.d.ts

@@ -13,7 +13,7 @@ export interface FargateEcsTaskConstructProps {
     /**
      * The runtime CPU architecture, either X86_64 or ARM64. If not provided, the default is @DEFAULT_ARCHITECTURE.
      */
-    readonly runtimePlatform: ecs.CpuArchitecture;
+    readonly runtimePlatform?: ecs.CpuArchitecture;
     /**
      * The number of CPUs to use, between 0.25 and 16. If not provided, the default is @DEFAULT_VCPUS.
      */
@@ -27,7 +27,7 @@ export interface FargateEcsTaskConstructProps {
     /**
      * The architecture of the container. If not provided, the default is @DEFAULT_ARCHITECTURE.
      */
-    readonly architecture: Architecture;
+    readonly architecture?: Architecture;
     /**
      * The name of the container. This is a required property
      */