@rio-cloud/cdk-v2-constructs 6.13.4 → 6.15.0-alpha.0

package/.jsii

@@ -4405,7 +4405,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-        "line": 133
+        "line": 148
       },
       "name": "AppStackProps",
       "properties": [
@@ -4417,7 +4417,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 134
+            "line": 149
           },
           "name": "serviceName",
           "type": {
@@ -4432,7 +4432,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 135
+            "line": 150
           },
           "name": "version",
           "type": {
@@ -4989,7 +4989,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-        "line": 208
+        "line": 262
       },
       "name": "CodeBuildOptions",
       "properties": [
@@ -5001,7 +5001,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 210
+            "line": 264
           },
           "name": "buildEnvironment",
           "optional": true,
@@ -5017,7 +5017,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 209
+            "line": 263
           },
           "name": "partialBuildSpecPath",
           "optional": true,
@@ -7452,7 +7452,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-        "line": 123
+        "line": 138
       },
       "methods": [
         {
@@ -7463,7 +7463,7 @@
           },
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 130
+            "line": 145
           },
           "name": "create",
           "parameters": [
@@ -9195,6 +9195,154 @@
       ],
       "symbolId": "src/watchful/watchful:OverrideAlarmThresholdProps"
     },
+    "@rio-cloud/cdk-v2-constructs.PipelineFeatures": {
+      "assembly": "@rio-cloud/cdk-v2-constructs",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "@rio-cloud/cdk-v2-constructs.PipelineFeatures",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
+        "line": 176
+      },
+      "name": "PipelineFeatures",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Will be added after all build & test commands, before the infrastructure build.",
+            "stability": "stable",
+            "summary": "Additional build commands for main and branch pipeline."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
+            "line": 212
+          },
+          "name": "additionalBuildCommands",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Defaults to `true`.",
+            "stability": "stable",
+            "summary": "Create a branch pipeline used by renovate."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
+            "line": 180
+          },
+          "name": "branchPipeline",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Requires `npmBuild` to be set to `true`. If set, the output of the npm build is deployed to the provided bucket.",
+            "stability": "stable",
+            "summary": "S3 Bucket to deploy frontend to."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
+            "line": 208
+          },
+          "name": "frontendBucketName",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Defaults to `false`:\n- build and test of the artifact via command \"./gradlew clean build\"\n- license-check and upload of license-check-file via command \"./gradlew checkLicenses\"\n- create a self-signed certificate to make TLS communication possible, e.g. with a loadbalancer\n- build the container image via command \"./gradlew jibBuildTar\"",
+            "stability": "stable",
+            "summary": "Run a standard gradle build in the repository root."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
+            "line": 192
+          },
+          "name": "gradleBuild",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Currently, this requires `gradleBuild` to be set to `true`. Defaults to `false`.",
+            "stability": "stable",
+            "summary": "Add required steps and permissions to support Kafka."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
+            "line": 204
+          },
+          "name": "kafkaIntegration",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Defaults to `false`:\n- run linter via command \"npm run lint\"\n- run tests via command \"npm run test:ci\"\n- run a license check by calling the script \"check-oss-licenses.sh\" (from the RIO frontend template)\n- build the artifact via command \"npm run build\"",
+            "stability": "stable",
+            "summary": "Run a standard npm build in the repository root."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
+            "line": 200
+          },
+          "name": "npmBuild",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Defaults to `true`.",
+            "stability": "stable",
+            "summary": "Create a vulnerability pipeline to scan dependencies for vulnerabilities."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
+            "line": 184
+          },
+          "name": "vulnerabilityPipeline",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        }
+      ],
+      "symbolId": "src/contributions/team-transport-two/pipeline/pipeline-stack:PipelineFeatures"
+    },
     "@rio-cloud/cdk-v2-constructs.PipelineSchedulesProps": {
       "assembly": "@rio-cloud/cdk-v2-constructs",
       "datatype": true,
@@ -9205,7 +9353,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-        "line": 30
+        "line": 33
       },
       "name": "PipelineSchedulesProps",
       "properties": [
@@ -9217,7 +9365,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 31
+            "line": 34
           },
           "name": "mainPipeline",
           "optional": true,
@@ -9233,7 +9381,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 32
+            "line": 35
           },
           "name": "vulnerabilityPipeline",
           "optional": true,
@@ -9257,7 +9405,7 @@
         },
         "locationInModule": {
           "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-          "line": 227
+          "line": 283
         },
         "parameters": [
           {
@@ -9283,7 +9431,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-        "line": 213
+        "line": 267
       },
       "name": "PipelineStack",
       "properties": [
@@ -9294,7 +9442,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 280
+            "line": 342
           },
           "name": "branchCodeBuildProject",
           "type": {
@@ -9308,7 +9456,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 276
+            "line": 338
           },
           "name": "mainCodebuildProject",
           "type": {
@@ -9331,7 +9479,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-        "line": 38
+        "line": 41
       },
       "name": "PipelineStackProps",
       "properties": [
@@ -9345,7 +9493,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 55
+            "line": 58
           },
           "name": "appStackFactory",
           "type": {
@@ -9355,51 +9503,53 @@
         {
           "abstract": true,
           "docs": {
+            "remarks": "I.e. the stack is named after the service\n- The serviceName is handed over to all Datadog monitors\n- RIO convention is that uploaded license-check-files are named after the service, i.e. serviceName.txt",
             "stability": "stable",
-            "summary": "Defines which kind of pipeline is deployed."
+            "summary": "The name of the service - This has to be the same name as the repository as the s3 trigger file created by the bitbucket-integration uses this as a prefix - The serviceName is available as an environment variable SERVICE_NAME in the CodeBuildStep - The serviceName is available in the AppStackProps in the appStackFactory - The serviceName is available as stackName property in the AppStackProps in the appStackFactory."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 60
+            "line": 51
           },
-          "name": "pipelineType",
+          "name": "serviceName",
           "type": {
-            "fqn": "@rio-cloud/cdk-v2-constructs.PipelineType"
+            "primitive": "string"
           }
         },
         {
           "abstract": true,
           "docs": {
-            "remarks": "I.e. the stack is named after the service\n- The serviceName is handed over to all Datadog monitors\n- RIO convention is that uploaded license-check-files are named after the service, i.e. serviceName.txt",
             "stability": "stable",
-            "summary": "The name of the service - This has to be the same name as the repository as the s3 trigger file created by the bitbucket-integration uses this as a prefix - The serviceName is available as an environment variable SERVICE_NAME in the CodeBuildStep - The serviceName is available in the AppStackProps in the appStackFactory - The serviceName is available as stackName property in the AppStackProps in the appStackFactory."
+            "summary": "CodeBuild options overriding the rio-specific defaults."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 48
+            "line": 97
           },
-          "name": "serviceName",
+          "name": "codeBuildOptions",
+          "optional": true,
           "type": {
-            "primitive": "string"
+            "fqn": "@rio-cloud/cdk-v2-constructs.CodeBuildOptions"
           }
         },
         {
           "abstract": true,
           "docs": {
+            "remarks": "Defaults to V1.",
             "stability": "stable",
-            "summary": "CodeBuild options overriding the rio-specific defaults."
+            "summary": "CodePipeline PipelineType (V1 or V2)."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 86
+            "line": 114
           },
-          "name": "codeBuildOptions",
+          "name": "codePipelineType",
           "optional": true,
           "type": {
-            "fqn": "@rio-cloud/cdk-v2-constructs.CodeBuildOptions"
+            "fqn": "aws-cdk-lib.aws_codepipeline.PipelineType"
           }
         },
         {
@@ -9411,7 +9561,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 95
+            "line": 106
           },
           "name": "datadogAlertType",
           "optional": true,
@@ -9419,6 +9569,24 @@
             "primitive": "string"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Use the features to combine different opinionated, RIO-specific pipeline features such as adding a branch pipeline or supporting Kafka.",
+            "stability": "stable",
+            "summary": "Defines which kind of pipeline is deployed."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
+            "line": 65
+          },
+          "name": "features",
+          "optional": true,
+          "type": {
+            "fqn": "@rio-cloud/cdk-v2-constructs.PipelineFeatures"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -9428,7 +9596,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 90
+            "line": 101
           },
           "name": "monitoringDeployStepProps",
           "optional": true,
@@ -9446,7 +9614,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 71
+            "line": 82
           },
           "name": "pipelineSchedules",
           "optional": true,
@@ -9454,6 +9622,23 @@
             "fqn": "@rio-cloud/cdk-v2-constructs.PipelineSchedulesProps"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "deprecated": "Use the `features` property instead. For now, the pipeline types are mapped to the features.\nDefines which kind of pipeline is deployed.",
+            "stability": "deprecated"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
+            "line": 71
+          },
+          "name": "pipelineType",
+          "optional": true,
+          "type": {
+            "fqn": "@rio-cloud/cdk-v2-constructs.PipelineType"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -9464,7 +9649,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 81
+            "line": 92
           },
           "name": "secretsDeployStepProps",
           "optional": true,
@@ -9482,7 +9667,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 99
+            "line": 110
           },
           "name": "vulnerabilityNotification",
           "optional": true,
@@ -9503,7 +9688,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-        "line": 148
+        "line": 163
       },
       "name": "PipelineStackRioMonitoringDeployStepProps",
       "properties": [
@@ -9516,7 +9701,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 158
+            "line": 173
           },
           "name": "monitoringArtifacts",
           "type": {
@@ -9548,7 +9733,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-        "line": 144
+        "line": 159
       },
       "name": "PipelineStackRioSecretsDeployStepProps",
       "properties": [
@@ -9560,7 +9745,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-            "line": 145
+            "line": 160
           },
           "name": "secretsFilePath",
           "type": {
@@ -9579,7 +9764,7 @@
       "kind": "enum",
       "locationInModule": {
         "filename": "src/contributions/team-transport-two/pipeline/pipeline-stack.ts",
-        "line": 161
+        "line": 215
       },
       "members": [
         {
@@ -20008,5 +20193,5 @@
     }
   },
   "version": "0.0.0",
-  "fingerprint": "1UGpC0zOwU89d9XQm47ceUHXUM984ifARhR3PaEtvfM="
+  "fingerprint": "t7w3ZyjWh1gi1QPVRSnjeE7Boro6mSTMUeL6Cty5aDg="
 }