@btc-embedded/cdk-extensions 0.9.0 → 0.9.2

package/.jsii

@@ -3946,6 +3946,22 @@
     }
   },
   "types": {
+    "@btc-embedded/cdk-extensions.AnythingButFilterRule": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Rule that allows all values except the given ones."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.AnythingButFilterRule",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/constructs/EventPipe.ts",
+        "line": 109
+      },
+      "name": "AnythingButFilterRule",
+      "symbolId": "src/constructs/EventPipe:AnythingButFilterRule"
+    },
     "@btc-embedded/cdk-extensions.ApiGateway": {
       "assembly": "@btc-embedded/cdk-extensions",
       "base": "constructs.Construct",
@@ -6110,6 +6126,59 @@
       ],
       "symbolId": "src/extensions/ExtraContainerExtension:ContainerProps"
     },
+    "@btc-embedded/cdk-extensions.DeactivatableServiceExtension": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
+      "docs": {
+        "remarks": "Deactivation is implemented by setting the desired count to zero, i.e. the\nconstruct is still present in the stack.",
+        "stability": "experimental",
+        "summary": "Extension that allows the service to be deactivated, if the environment variable contains its ID."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.DeactivatableServiceExtension",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/extensions/DeactivatableServiceExtension.ts",
+          "line": 14
+        }
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/extensions/DeactivatableServiceExtension.ts",
+        "line": 13
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Prior to launching the task definition as a service, this hook is called on each extension to give it a chance to mutate the properties of the service to be created."
+          },
+          "locationInModule": {
+            "filename": "src/extensions/DeactivatableServiceExtension.ts",
+            "line": 18
+          },
+          "name": "modifyServiceProps",
+          "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
+          "parameters": [
+            {
+              "name": "props",
+              "type": {
+                "fqn": "@aws-cdk-containers/ecs-service-extensions.ServiceBuild"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "@aws-cdk-containers/ecs-service-extensions.ServiceBuild"
+            }
+          }
+        }
+      ],
+      "name": "DeactivatableServiceExtension",
+      "symbolId": "src/extensions/DeactivatableServiceExtension:DeactivatableServiceExtension"
+    },
     "@btc-embedded/cdk-extensions.DefaultUserPoolClients": {
       "assembly": "@btc-embedded/cdk-extensions",
       "base": "constructs.Construct",
@@ -6991,6 +7060,146 @@
       ],
       "symbolId": "src/extensions/DomainEventMessagingExtension:EventListenerExtensionProps"
     },
+    "@btc-embedded/cdk-extensions.EventPipe": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "constructs.Construct",
+      "docs": {
+        "stability": "experimental",
+        "summary": "A wrapper for the L1 event pipe with the ability to deactivate it within the stack."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.EventPipe",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/constructs/EventPipe.ts",
+          "line": 141
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.EventPipeProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/constructs/EventPipe.ts",
+        "line": 140
+      },
+      "name": "EventPipe",
+      "symbolId": "src/constructs/EventPipe:EventPipe"
+    },
+    "@btc-embedded/cdk-extensions.EventPipeProps": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Properties for pipe construction."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.EventPipeProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/constructs/EventPipe.ts",
+        "line": 12
+      },
+      "name": "EventPipeProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "No other source types are supported at the moment.",
+            "stability": "experimental",
+            "summary": "The source SQS queue."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/EventPipe.ts",
+            "line": 16
+          },
+          "name": "source",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_sqs.IQueue"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The target SQS queue or target step function."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/EventPipe.ts",
+            "line": 21
+          },
+          "name": "target",
+          "type": {
+            "union": {
+              "types": [
+                {
+                  "fqn": "@btc-embedded/cdk-extensions.TargetQueue"
+                },
+                {
+                  "fqn": "@btc-embedded/cdk-extensions.TargetStepFunction"
+                }
+              ]
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "An optional filter for the pipe."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/EventPipe.ts",
+            "line": 31
+          },
+          "name": "filter",
+          "optional": true,
+          "type": {
+            "fqn": "@btc-embedded/cdk-extensions.PipeFilter"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "If omitted, a new role is created.",
+            "stability": "experimental",
+            "summary": "The role used by the event pipe."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/EventPipe.ts",
+            "line": 26
+          },
+          "name": "role",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_iam.Role"
+          }
+        }
+      ],
+      "symbolId": "src/constructs/EventPipe:EventPipeProps"
+    },
     "@btc-embedded/cdk-extensions.ExtraContainerExtension": {
       "assembly": "@btc-embedded/cdk-extensions",
       "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -7208,6 +7417,22 @@
       ],
       "symbolId": "src/extensions/ExtraContainerExtension:ExtraContainerExtensionProps"
     },
+    "@btc-embedded/cdk-extensions.FilterEqualsIgnoreCase": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Rule that matches a string, ignoring the case."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.FilterEqualsIgnoreCase",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/constructs/EventPipe.ts",
+        "line": 119
+      },
+      "name": "FilterEqualsIgnoreCase",
+      "symbolId": "src/constructs/EventPipe:FilterEqualsIgnoreCase"
+    },
     "@btc-embedded/cdk-extensions.HTTPApiExtension": {
       "assembly": "@btc-embedded/cdk-extensions",
       "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -7405,6 +7630,54 @@
       ],
       "symbolId": "src/extensions/HTTPApiExtension:HTTPApiExtensionProps"
     },
+    "@btc-embedded/cdk-extensions.InputTemplate": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.InputTemplate",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/constructs/EventPipe.ts",
+        "line": 53
+      },
+      "name": "InputTemplate",
+      "symbolId": "src/constructs/EventPipe:InputTemplate"
+    },
+    "@btc-embedded/cdk-extensions.InvocationType": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "docs": {
+        "stability": "experimental",
+        "summary": "The invocation type of the step function."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.InvocationType",
+      "kind": "enum",
+      "locationInModule": {
+        "filename": "src/constructs/EventPipe.ts",
+        "line": 37
+      },
+      "members": [
+        {
+          "docs": {
+            "remarks": "For more information, see\n[StartSyncExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartSyncExecution.html)\nin the *AWS Step Functions API Reference*.\n> `REQUEST_RESPONSE` is not supported for `STANDARD` state machine workflows.",
+            "stability": "experimental",
+            "summary": "(default) - Invoke synchronously."
+          },
+          "name": "REQUEST_RESPONSE"
+        },
+        {
+          "docs": {
+            "remarks": "For more information, see\n[StartExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html)\nin the *AWS Step Functions API Reference*.",
+            "stability": "experimental",
+            "summary": "Invoke asynchronously."
+          },
+          "name": "FIRE_AND_FORGET"
+        }
+      ],
+      "name": "InvocationType",
+      "symbolId": "src/constructs/EventPipe:InvocationType"
+    },
     "@btc-embedded/cdk-extensions.LogExtension": {
       "assembly": "@btc-embedded/cdk-extensions",
       "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -7743,6 +8016,22 @@
       ],
       "symbolId": "src/extensions/OpenTelemetryExtension:OpenTelemetryExtensionProps"
     },
+    "@btc-embedded/cdk-extensions.PipeFilter": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "A filter for messages in the pipe."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.PipeFilter",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/constructs/EventPipe.ts",
+        "line": 129
+      },
+      "name": "PipeFilter",
+      "symbolId": "src/constructs/EventPipe:PipeFilter"
+    },
     "@btc-embedded/cdk-extensions.PostgresDbAccessExtension": {
       "assembly": "@btc-embedded/cdk-extensions",
       "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -8069,6 +8358,48 @@
       ],
       "symbolId": "src/platform/PrivateDnsNamespace:PredefinedPrivateDnsNamespaceProps"
     },
+    "@btc-embedded/cdk-extensions.PrefixFilterRule": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Rule that a property has to start with a prefix."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.PrefixFilterRule",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/constructs/EventPipe.ts",
+        "line": 95
+      },
+      "name": "PrefixFilterRule",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/EventPipe.ts",
+            "line": 96
+          },
+          "name": "prefix",
+          "type": {
+            "union": {
+              "types": [
+                {
+                  "primitive": "string"
+                },
+                {
+                  "fqn": "@btc-embedded/cdk-extensions.FilterEqualsIgnoreCase"
+                }
+              ]
+            }
+          }
+        }
+      ],
+      "symbolId": "src/constructs/EventPipe:PrefixFilterRule"
+    },
     "@btc-embedded/cdk-extensions.PrivateDnsNamespace": {
       "assembly": "@btc-embedded/cdk-extensions",
       "base": "constructs.Construct",
@@ -8349,6 +8680,53 @@
       ],
       "symbolId": "src/platform/ResourceServer:ResourceServerProps"
     },
+    "@btc-embedded/cdk-extensions.S3Bucket": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "aws-cdk-lib.aws_s3.Bucket",
+      "docs": {
+        "remarks": "Will cause files to expire after tree days and allows to delete the\nbucket and all its contents, if the stack is deleted.",
+        "stability": "experimental",
+        "summary": "Wrapper for the {@link Bucket} constructs that adds additional properties, if a developer stack is detected."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.S3Bucket",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/constructs/S3Bucket.ts",
+          "line": 36
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "optional": true,
+            "type": {
+              "fqn": "aws-cdk-lib.aws_s3.BucketProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/constructs/S3Bucket.ts",
+        "line": 35
+      },
+      "name": "S3Bucket",
+      "symbolId": "src/constructs/S3Bucket:S3Bucket"
+    },
     "@btc-embedded/cdk-extensions.SecureRestApi": {
       "assembly": "@btc-embedded/cdk-extensions",
       "base": "constructs.Construct",
@@ -8903,6 +9281,180 @@
       ],
       "symbolId": "src/extensions/SharedVolumeExtension:SharedVolumeExtensionProps"
     },
+    "@btc-embedded/cdk-extensions.SuffixFilterRule": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Rule that a property has to end with a suffix."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.SuffixFilterRule",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/constructs/EventPipe.ts",
+        "line": 102
+      },
+      "name": "SuffixFilterRule",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/EventPipe.ts",
+            "line": 103
+          },
+          "name": "suffix",
+          "type": {
+            "union": {
+              "types": [
+                {
+                  "primitive": "string"
+                },
+                {
+                  "fqn": "@btc-embedded/cdk-extensions.FilterEqualsIgnoreCase"
+                }
+              ]
+            }
+          }
+        }
+      ],
+      "symbolId": "src/constructs/EventPipe:SuffixFilterRule"
+    },
+    "@btc-embedded/cdk-extensions.TargetQueue": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "SQS queue as pipe target."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.TargetQueue",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/constructs/EventPipe.ts",
+        "line": 63
+      },
+      "name": "TargetQueue",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/EventPipe.ts",
+            "line": 64
+          },
+          "name": "queue",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_sqs.IQueue"
+          }
+        }
+      ],
+      "symbolId": "src/constructs/EventPipe:TargetQueue"
+    },
+    "@btc-embedded/cdk-extensions.TargetStepFunction": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "StepFunction as pipe target."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.TargetStepFunction",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/constructs/EventPipe.ts",
+        "line": 70
+      },
+      "name": "TargetStepFunction",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/EventPipe.ts",
+            "line": 71
+          },
+          "name": "stepFunction",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_stepfunctions.IStateMachine"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/EventPipe.ts",
+            "line": 72
+          },
+          "name": "parameters",
+          "optional": true,
+          "type": {
+            "fqn": "@btc-embedded/cdk-extensions.TargetStepFunctionParameters"
+          }
+        }
+      ],
+      "symbolId": "src/constructs/EventPipe:TargetStepFunction"
+    },
+    "@btc-embedded/cdk-extensions.TargetStepFunctionParameters": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Parameters for a step function target."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.TargetStepFunctionParameters",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/constructs/EventPipe.ts",
+        "line": 78
+      },
+      "name": "TargetStepFunctionParameters",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/EventPipe.ts",
+            "line": 79
+          },
+          "name": "inputTemplate",
+          "optional": true,
+          "type": {
+            "fqn": "@btc-embedded/cdk-extensions.InputTemplate"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/EventPipe.ts",
+            "line": 80
+          },
+          "name": "invocationType",
+          "optional": true,
+          "type": {
+            "fqn": "@btc-embedded/cdk-extensions.InvocationType"
+          }
+        }
+      ],
+      "symbolId": "src/constructs/EventPipe:TargetStepFunctionParameters"
+    },
     "@btc-embedded/cdk-extensions.TcpKeepAliveExtension": {
       "assembly": "@btc-embedded/cdk-extensions",
       "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -9192,6 +9744,6 @@
       "symbolId": "src/platform/Vpc:VpcProps"
     }
   },
-  "version": "0.9.0",
-  "fingerprint": "jLRX0G4168AR5fnFHJCzZVyg+OxaXWECi93TCEP8mE0="
+  "version": "0.9.2",
+  "fingerprint": "ZzpxyJDEQINK46ih+3avZ+2zMHZYSW2isT7oFfqTOHw="
 }