@orcabus/platform-cdk-constructs 0.0.7-alpha.6 → 0.0.7-beta.10

package/.jsii

@@ -4359,12 +4359,121 @@
       ],
       "symbolId": "api-gateway/api-gateway:OrcaBusApiGatewayProps"
     },
-    "@orcabus/platform-cdk-constructs.deploymentPipeline.DeploymentStackPipeline": {
+    "@orcabus/platform-cdk-constructs.deploymentPipeline.CrossDeploymentArtifactBucket": {
       "assembly": "@orcabus/platform-cdk-constructs",
       "base": "constructs.Construct",
       "docs": {
         "stability": "experimental"
       },
+      "fqn": "@orcabus/platform-cdk-constructs.deploymentPipeline.CrossDeploymentArtifactBucket",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "deployment-stack-pipeline/artifact-bucket.ts",
+          "line": 50
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          }
+        ]
+      },
+      "interfaces": [
+        "@orcabus/platform-cdk-constructs.deploymentPipeline.ICrossDeploymentArtifactBucket"
+      ],
+      "kind": "class",
+      "locationInModule": {
+        "filename": "deployment-stack-pipeline/artifact-bucket.ts",
+        "line": 37
+      },
+      "methods": [
+        {
+          "docs": {
+            "returns": "ICrossDeploymentArtifactBucket",
+            "stability": "experimental",
+            "summary": "Imports an existing cross-deployment artifact bucket and its KMS key using SSM and resource lookups."
+          },
+          "locationInModule": {
+            "filename": "deployment-stack-pipeline/artifact-bucket.ts",
+            "line": 115
+          },
+          "name": "fromLookup",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "The scope in which to look up the artifact bucket."
+              },
+              "name": "scope",
+              "type": {
+                "fqn": "constructs.Construct"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "@orcabus/platform-cdk-constructs.deploymentPipeline.ICrossDeploymentArtifactBucket"
+            }
+          },
+          "static": true
+        }
+      ],
+      "name": "CrossDeploymentArtifactBucket",
+      "namespace": "deploymentPipeline",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "The S3 bucket used to store artifacts for cross-deployment pipelines."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "deployment-stack-pipeline/artifact-bucket.ts",
+            "line": 44
+          },
+          "name": "artifactBucket",
+          "overrides": "@orcabus/platform-cdk-constructs.deploymentPipeline.ICrossDeploymentArtifactBucket",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_s3.IBucket"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "The KMS key used to encrypt artifacts for cross-deployment pipelines."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "deployment-stack-pipeline/artifact-bucket.ts",
+            "line": 48
+          },
+          "name": "artifactKms",
+          "overrides": "@orcabus/platform-cdk-constructs.deploymentPipeline.ICrossDeploymentArtifactBucket",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_kms.IKey"
+          }
+        }
+      ],
+      "symbolId": "deployment-stack-pipeline/artifact-bucket:CrossDeploymentArtifactBucket"
+    },
+    "@orcabus/platform-cdk-constructs.deploymentPipeline.DeploymentStackPipeline": {
+      "assembly": "@orcabus/platform-cdk-constructs",
+      "base": "constructs.Construct",
+      "docs": {
+        "remarks": "Prerequisite: Ensure that the \"CrossDeploymentArtifactBucket\" stack is deployed in the TOOLCHAIN account\nbefore using this construct.",
+        "stability": "experimental",
+        "summary": "A CDK construct that creates a deployment pipeline across environments for the OrcaBus project."
+      },
       "fqn": "@orcabus/platform-cdk-constructs.deploymentPipeline.DeploymentStackPipeline",
       "initializer": {
         "docs": {
@@ -4372,7 +4481,7 @@
         },
         "locationInModule": {
           "filename": "deployment-stack-pipeline/pipeline.ts",
-          "line": 130
+          "line": 164
         },
         "parameters": [
           {
@@ -4398,7 +4507,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "deployment-stack-pipeline/pipeline.ts",
-        "line": 124
+        "line": 158
       },
       "name": "DeploymentStackPipeline",
       "namespace": "deploymentPipeline",
@@ -4411,7 +4520,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "deployment-stack-pipeline/pipeline.ts",
-            "line": 128
+            "line": 162
           },
           "name": "pipeline",
           "type": {
@@ -4431,7 +4540,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "deployment-stack-pipeline/pipeline.ts",
-        "line": 69
+        "line": 73
       },
       "name": "DeploymentStackPipelineProps",
       "namespace": "deploymentPipeline",
@@ -4446,7 +4555,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "deployment-stack-pipeline/pipeline.ts",
-            "line": 105
+            "line": 112
           },
           "name": "cdkSynthCmd",
           "type": {
@@ -4461,13 +4570,17 @@
         {
           "abstract": true,
           "docs": {
+            "custom": {
+              "": "\".\nThis restriction is due to AWS resource tagging requirements."
+            },
+            "remarks": "Avoid using branch names that contain special characters such as parentheses.\nAllowed special characters are: \"+ - = . _ : /",
             "stability": "experimental",
-            "summary": "The github branch name it will listen to."
+            "summary": "The GitHub branch name the pipeline will listen to."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "deployment-stack-pipeline/pipeline.ts",
-            "line": 73
+            "line": 80
           },
           "name": "githubBranch",
           "type": {
@@ -4484,7 +4597,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "deployment-stack-pipeline/pipeline.ts",
-            "line": 77
+            "line": 84
           },
           "name": "githubRepo",
           "type": {
@@ -4500,7 +4613,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "deployment-stack-pipeline/pipeline.ts",
-            "line": 94
+            "line": 101
           },
           "name": "pipelineName",
           "type": {
@@ -4516,7 +4629,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "deployment-stack-pipeline/pipeline.ts",
-            "line": 81
+            "line": 88
           },
           "name": "stack",
           "type": {
@@ -4532,7 +4645,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "deployment-stack-pipeline/pipeline.ts",
-            "line": 90
+            "line": 97
           },
           "name": "stackConfig",
           "type": {
@@ -4549,7 +4662,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "deployment-stack-pipeline/pipeline.ts",
-            "line": 86
+            "line": 93
           },
           "name": "stackName",
           "type": {
@@ -4566,7 +4679,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "deployment-stack-pipeline/pipeline.ts",
-            "line": 111
+            "line": 118
           },
           "name": "cdkOut",
           "optional": true,
@@ -4574,6 +4687,24 @@
             "primitive": "string"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "True",
+            "stability": "experimental",
+            "summary": "Enable notification to the 'alerts-build' slack channel."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "deployment-stack-pipeline/pipeline.ts",
+            "line": 133
+          },
+          "name": "enableSlackNotification",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -4584,7 +4715,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "deployment-stack-pipeline/pipeline.ts",
-            "line": 101
+            "line": 108
           },
           "name": "filePaths",
           "optional": true,
@@ -4597,6 +4728,49 @@
             }
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "[PipelineNotificationEvents.PIPELINE_EXECUTION_FAILED] –\nOnly failed pipeline executions will trigger a notification.",
+            "remarks": "Only applies if `enableSlackNotification` is set to true.",
+            "stability": "experimental",
+            "summary": "The pipeline notification events that will trigger a Slack channel notification."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "deployment-stack-pipeline/pipeline.ts",
+            "line": 141
+          },
+          "name": "notificationEvents",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "aws-cdk-lib.aws_codepipeline.PipelineNotificationEvents"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "True",
+            "remarks": "If set to true, it will look up the existing artifact bucket in the TOOLCHAIN account.",
+            "stability": "experimental",
+            "summary": "Whether to reuse the existing artifact bucket for cross-deployment pipelines."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "deployment-stack-pipeline/pipeline.ts",
+            "line": 149
+          },
+          "name": "reuseExistingArtifactBucket",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -4606,7 +4780,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "deployment-stack-pipeline/pipeline.ts",
-            "line": 121
+            "line": 128
           },
           "name": "stageEnv",
           "optional": true,
@@ -4625,7 +4799,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "deployment-stack-pipeline/pipeline.ts",
-            "line": 117
+            "line": 124
           },
           "name": "synthBuildSpec",
           "optional": true,
@@ -4641,6 +4815,55 @@
       ],
       "symbolId": "deployment-stack-pipeline/pipeline:DeploymentStackPipelineProps"
     },
+    "@orcabus/platform-cdk-constructs.deploymentPipeline.ICrossDeploymentArtifactBucket": {
+      "assembly": "@orcabus/platform-cdk-constructs",
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@orcabus/platform-cdk-constructs.deploymentPipeline.ICrossDeploymentArtifactBucket",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "deployment-stack-pipeline/artifact-bucket.ts",
+        "line": 26
+      },
+      "name": "ICrossDeploymentArtifactBucket",
+      "namespace": "deploymentPipeline",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The S3 bucket used to store artifacts for cross-deployment pipelines."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "deployment-stack-pipeline/artifact-bucket.ts",
+            "line": 30
+          },
+          "name": "artifactBucket",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_s3.IBucket"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The KMS key used to encrypt artifacts for cross-deployment pipelines."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "deployment-stack-pipeline/artifact-bucket.ts",
+            "line": 34
+          },
+          "name": "artifactKms",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_kms.IKey"
+          }
+        }
+      ],
+      "symbolId": "deployment-stack-pipeline/artifact-bucket:ICrossDeploymentArtifactBucket"
+    },
     "@orcabus/platform-cdk-constructs.deploymentPipeline.StackConfigProps": {
       "assembly": "@orcabus/platform-cdk-constructs",
       "datatype": true,
@@ -4651,7 +4874,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "deployment-stack-pipeline/pipeline.ts",
-        "line": 54
+        "line": 58
       },
       "name": "StackConfigProps",
       "namespace": "deploymentPipeline",
@@ -4665,7 +4888,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "deployment-stack-pipeline/pipeline.ts",
-            "line": 58
+            "line": 62
           },
           "name": "beta",
           "type": {
@@ -4686,7 +4909,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "deployment-stack-pipeline/pipeline.ts",
-            "line": 62
+            "line": 66
           },
           "name": "gamma",
           "type": {
@@ -4707,7 +4930,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "deployment-stack-pipeline/pipeline.ts",
-            "line": 66
+            "line": 70
           },
           "name": "prod",
           "type": {
@@ -4732,7 +4955,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "deployment-stack-pipeline/pipeline.ts",
-        "line": 39
+        "line": 43
       },
       "name": "StageEnvProps",
       "namespace": "deploymentPipeline",
@@ -4746,7 +4969,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "deployment-stack-pipeline/pipeline.ts",
-            "line": 43
+            "line": 47
           },
           "name": "beta",
           "type": {
@@ -4762,7 +4985,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "deployment-stack-pipeline/pipeline.ts",
-            "line": 47
+            "line": 51
           },
           "name": "gamma",
           "type": {
@@ -4778,7 +5001,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "deployment-stack-pipeline/pipeline.ts",
-            "line": 51
+            "line": 55
           },
           "name": "prod",
           "type": {
@@ -5258,6 +5481,44 @@
       ],
       "symbolId": "ecs/index:FargateEcsTaskConstructProps"
     },
+    "@orcabus/platform-cdk-constructs.lambda.Icav2ResourcesProps": {
+      "assembly": "@orcabus/platform-cdk-constructs",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@orcabus/platform-cdk-constructs.lambda.Icav2ResourcesProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "lambda/index.ts",
+        "line": 63
+      },
+      "name": "Icav2ResourcesProps",
+      "namespace": "lambda",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "custom": {
+              "DEFAULT_ICAV2_ACCESS_TOKEN_SECRET_ID": "true"
+            },
+            "stability": "experimental",
+            "summary": "The id of the secret that contains the icav2 access token otherwise it will default to."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lambda/index.ts",
+            "line": 68
+          },
+          "name": "icav2AccessTokenSecretId",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "lambda/index:Icav2ResourcesProps"
+    },
     "@orcabus/platform-cdk-constructs.lambda.MartEnvironmentVariables": {
       "assembly": "@orcabus/platform-cdk-constructs",
       "datatype": true,
@@ -5268,7 +5529,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "lambda/index.ts",
-        "line": 43
+        "line": 46
       },
       "name": "MartEnvironmentVariables",
       "namespace": "lambda",
@@ -5285,7 +5546,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lambda/index.ts",
-            "line": 57
+            "line": 60
           },
           "name": "athenaDatabaseName",
           "optional": true,
@@ -5305,7 +5566,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lambda/index.ts",
-            "line": 52
+            "line": 55
           },
           "name": "athenaDatasourceName",
           "optional": true,
@@ -5325,7 +5586,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lambda/index.ts",
-            "line": 47
+            "line": 50
           },
           "name": "athenaWorkgroupName",
           "optional": true,
@@ -5346,7 +5607,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "lambda/index.ts",
-        "line": 31
+        "line": 34
       },
       "name": "OrcabusResourcesProps",
       "namespace": "lambda",
@@ -5363,7 +5624,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lambda/index.ts",
-            "line": 40
+            "line": 43
           },
           "name": "hostnameSsmParameterName",
           "optional": true,
@@ -5383,7 +5644,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lambda/index.ts",
-            "line": 35
+            "line": 38
           },
           "name": "orcabusTokenSecretId",
           "optional": true,
@@ -5407,7 +5668,7 @@
         },
         "locationInModule": {
           "filename": "lambda/index.ts",
-          "line": 96
+          "line": 126
         },
         "parameters": [
           {
@@ -5433,7 +5694,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "lambda/index.ts",
-        "line": 89
+        "line": 117
       },
       "name": "PythonUvFunction",
       "namespace": "lambda",
@@ -5452,11 +5713,65 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "lambda/index.ts",
-        "line": 60
+        "line": 72
       },
       "name": "PythonUvFunctionProps",
       "namespace": "lambda",
       "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "custom": {
+              "DEFAULT_ICAV2_ACCESS_TOKEN_SECRET_ID": "for the secret"
+            },
+            "stability": "experimental",
+            "summary": "Provide the icav2Resources, optional, otherwise it will default to."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lambda/index.ts",
+            "line": 113
+          },
+          "name": "icav2Resources",
+          "optional": true,
+          "type": {
+            "fqn": "@orcabus/platform-cdk-constructs.lambda.Icav2ResourcesProps"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Whether or not to include the fastapi layer in the lambda function build."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lambda/index.ts",
+            "line": 93
+          },
+          "name": "includeFastApiLayer",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Whether or not to include the icav2 layer in the lambda function build."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lambda/index.ts",
+            "line": 88
+          },
+          "name": "includeIcav2Layer",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -5466,7 +5781,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lambda/index.ts",
-            "line": 71
+            "line": 83
           },
           "name": "includeMartLayer",
           "optional": true,
@@ -5483,7 +5798,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lambda/index.ts",
-            "line": 64
+            "line": 76
           },
           "name": "includeOrcabusApiToolsLayer",
           "optional": true,
@@ -5503,7 +5818,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lambda/index.ts",
-            "line": 85
+            "line": 107
           },
           "name": "martEnvironmentVariables",
           "optional": true,
@@ -5524,7 +5839,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lambda/index.ts",
-            "line": 78
+            "line": 100
           },
           "name": "orcabusTokenResources",
           "optional": true,
@@ -5536,6 +5851,6 @@
       "symbolId": "lambda/index:PythonUvFunctionProps"
     }
   },
-  "version": "0.0.7-alpha.6",
-  "fingerprint": "FJto4Pe/9YIwmAx3ap1LeCGjMrIG/N5dHpUjXtdNj3c="
+  "version": "0.0.7-beta.10",
+  "fingerprint": "VBUneoq1FMbsHWvMD7HtsC9oM0SlTuz55+xIn/fdNtw="
 }