@btc-embedded/cdk-extensions 0.5.2 → 0.5.4

package/.jsii

@@ -6487,6 +6487,170 @@
       ],
       "symbolId": "src/platform/PrivateDnsNamespace:PrivateDnsNamespaceProps"
     },
+    "@btc-embedded/cdk-extensions.SecureRestApi": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "constructs.Construct",
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.SecureRestApi",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/constructs/SecureRestApi.ts",
+          "line": 37
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.SecureRestApiProps"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/constructs/SecureRestApi.ts",
+        "line": 32
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/constructs/SecureRestApi.ts",
+            "line": 80
+          },
+          "name": "withSecureRestApiProps",
+          "parameters": [
+            {
+              "name": "props",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_apigateway.RestApiProps"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "aws-cdk-lib.aws_apigateway.RestApiProps"
+            }
+          }
+        }
+      ],
+      "name": "SecureRestApi",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/constructs/SecureRestApi.ts",
+            "line": 34
+          },
+          "name": "defaultAuthorizer",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_apigateway.CognitoUserPoolsAuthorizer"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/constructs/SecureRestApi.ts",
+            "line": 33
+          },
+          "name": "restApiDomainName",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_apigateway.DomainName"
+          }
+        }
+      ],
+      "symbolId": "src/constructs/SecureRestApi:SecureRestApi"
+    },
+    "@btc-embedded/cdk-extensions.SecureRestApiProps": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.SecureRestApiProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/constructs/SecureRestApi.ts",
+        "line": 15
+      },
+      "name": "SecureRestApiProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Subdomain that is used for REST API props."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/SecureRestApi.ts",
+            "line": 23
+          },
+          "name": "apiSubDomain",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The name of the Base platform Stack."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/SecureRestApi.ts",
+            "line": 19
+          },
+          "name": "basePlatformStackName",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- fqdn output of base platform stack is used to import the hosted zone",
+            "stability": "experimental",
+            "summary": "hosted zone for the subdomain An optional parameter."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/constructs/SecureRestApi.ts",
+            "line": 29
+          },
+          "name": "hostedZone",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_route53.IHostedZone"
+          }
+        }
+      ],
+      "symbolId": "src/constructs/SecureRestApi:SecureRestApiProps"
+    },
     "@btc-embedded/cdk-extensions.SharedVolumeExtension": {
       "assembly": "@btc-embedded/cdk-extensions",
       "base": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -6816,22 +6980,32 @@
         },
         "locationInModule": {
           "filename": "src/platform/Vpc.ts",
-          "line": 16
+          "line": 27
         },
         "parameters": [
           {
+            "docs": {
+              "summary": "The parent construct this is part of."
+            },
             "name": "scope",
             "type": {
               "fqn": "constructs.Construct"
             }
           },
           {
+            "docs": {
+              "summary": "Id of this construct for Cloudformation."
+            },
             "name": "id",
             "type": {
               "primitive": "string"
             }
           },
           {
+            "docs": {
+              "remarks": "Defaults to an empty object creating a\ndedicated VPC, with max 2 AZS and NO Key for Exec",
+              "summary": "Properties allowing to set a predefined VPCName, IPAdressBlog, maxNumber of AZs and decision wether to create a KMSKey for usage with the Exec extension."
+            },
             "name": "props",
             "type": {
               "fqn": "@btc-embedded/cdk-extensions.VpcProps"
@@ -6842,7 +7016,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/platform/Vpc.ts",
-        "line": 12
+        "line": 14
       },
       "name": "Vpc",
       "properties": [
@@ -6852,11 +7026,11 @@
           },
           "locationInModule": {
             "filename": "src/platform/Vpc.ts",
-            "line": 14
+            "line": 16
           },
           "name": "cluster",
           "type": {
-            "fqn": "aws-cdk-lib.aws_ecs.ICluster"
+            "fqn": "aws-cdk-lib.aws_ecs.Cluster"
           }
         },
         {
@@ -6865,7 +7039,7 @@
           },
           "locationInModule": {
             "filename": "src/platform/Vpc.ts",
-            "line": 13
+            "line": 15
           },
           "name": "vpcInstance",
           "type": {
@@ -6885,7 +7059,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/platform/Vpc.ts",
-        "line": 6
+        "line": 7
       },
       "name": "VpcProps",
       "properties": [
@@ -6897,7 +7071,23 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/Vpc.ts",
-            "line": 7
+            "line": 11
+          },
+          "name": "createKmsExecCommandKey",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/Vpc.ts",
+            "line": 8
           },
           "name": "definedVpcName",
           "optional": true,
@@ -6913,7 +7103,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/Vpc.ts",
-            "line": 9
+            "line": 10
           },
           "name": "maxAzs",
           "optional": true,
@@ -6929,7 +7119,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/platform/Vpc.ts",
-            "line": 8
+            "line": 9
           },
           "name": "vpcCidr",
           "optional": true,
@@ -6941,6 +7131,6 @@
       "symbolId": "src/platform/Vpc:VpcProps"
     }
   },
-  "version": "0.5.2",
-  "fingerprint": "KqlcqEXmvsXZb4Iu39aiOgwEREaKNnb4C6gJIDTFzCo="
+  "version": "0.5.4",
+  "fingerprint": "eZb67MAU9qfdjB9lZtSei4Rxo3LtQB9njnE/StJcU1g="
 }

package/API.md

@@ -565,6 +565,140 @@ public readonly namespace: IPrivateDnsNamespace;
 ---
 
 
+### SecureRestApi <a name="SecureRestApi" id="@btc-embedded/cdk-extensions.SecureRestApi"></a>
+
+#### Initializers <a name="Initializers" id="@btc-embedded/cdk-extensions.SecureRestApi.Initializer"></a>
+
+```typescript
+import { SecureRestApi } from '@btc-embedded/cdk-extensions'
+
+new SecureRestApi(scope: Construct, id: string, props: SecureRestApiProps)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.SecureRestApi.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.SecureRestApi.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.SecureRestApi.Initializer.parameter.props">props</a></code> | <code><a href="#@btc-embedded/cdk-extensions.SecureRestApiProps">SecureRestApiProps</a></code> | *No description.* |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="@btc-embedded/cdk-extensions.SecureRestApi.Initializer.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.SecureRestApi.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+##### `props`<sup>Required</sup> <a name="props" id="@btc-embedded/cdk-extensions.SecureRestApi.Initializer.parameter.props"></a>
+
+- *Type:* <a href="#@btc-embedded/cdk-extensions.SecureRestApiProps">SecureRestApiProps</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.SecureRestApi.toString">toString</a></code> | Returns a string representation of this construct. |
+| <code><a href="#@btc-embedded/cdk-extensions.SecureRestApi.withSecureRestApiProps">withSecureRestApiProps</a></code> | *No description.* |
+
+---
+
+##### `toString` <a name="toString" id="@btc-embedded/cdk-extensions.SecureRestApi.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+##### `withSecureRestApiProps` <a name="withSecureRestApiProps" id="@btc-embedded/cdk-extensions.SecureRestApi.withSecureRestApiProps"></a>
+
+```typescript
+public withSecureRestApiProps(props: RestApiProps): RestApiProps
+```
+
+###### `props`<sup>Required</sup> <a name="props" id="@btc-embedded/cdk-extensions.SecureRestApi.withSecureRestApiProps.parameter.props"></a>
+
+- *Type:* aws-cdk-lib.aws_apigateway.RestApiProps
+
+---
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.SecureRestApi.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+
+---
+
+##### ~~`isConstruct`~~ <a name="isConstruct" id="@btc-embedded/cdk-extensions.SecureRestApi.isConstruct"></a>
+
+```typescript
+import { SecureRestApi } from '@btc-embedded/cdk-extensions'
+
+SecureRestApi.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+###### `x`<sup>Required</sup> <a name="x" id="@btc-embedded/cdk-extensions.SecureRestApi.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.SecureRestApi.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+| <code><a href="#@btc-embedded/cdk-extensions.SecureRestApi.property.defaultAuthorizer">defaultAuthorizer</a></code> | <code>aws-cdk-lib.aws_apigateway.CognitoUserPoolsAuthorizer</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.SecureRestApi.property.restApiDomainName">restApiDomainName</a></code> | <code>aws-cdk-lib.aws_apigateway.DomainName</code> | *No description.* |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="@btc-embedded/cdk-extensions.SecureRestApi.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
+##### `defaultAuthorizer`<sup>Required</sup> <a name="defaultAuthorizer" id="@btc-embedded/cdk-extensions.SecureRestApi.property.defaultAuthorizer"></a>
+
+```typescript
+public readonly defaultAuthorizer: CognitoUserPoolsAuthorizer;
+```
+
+- *Type:* aws-cdk-lib.aws_apigateway.CognitoUserPoolsAuthorizer
+
+---
+
+##### `restApiDomainName`<sup>Required</sup> <a name="restApiDomainName" id="@btc-embedded/cdk-extensions.SecureRestApi.property.restApiDomainName"></a>
+
+```typescript
+public readonly restApiDomainName: DomainName;
+```
+
+- *Type:* aws-cdk-lib.aws_apigateway.DomainName
+
+---
+
+
 ### Vpc <a name="Vpc" id="@btc-embedded/cdk-extensions.Vpc"></a>
 
 #### Initializers <a name="Initializers" id="@btc-embedded/cdk-extensions.Vpc.Initializer"></a>
@@ -577,9 +711,9 @@ new Vpc(scope: Construct, id: string, props: VpcProps)
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
-| <code><a href="#@btc-embedded/cdk-extensions.Vpc.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
-| <code><a href="#@btc-embedded/cdk-extensions.Vpc.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
-| <code><a href="#@btc-embedded/cdk-extensions.Vpc.Initializer.parameter.props">props</a></code> | <code><a href="#@btc-embedded/cdk-extensions.VpcProps">VpcProps</a></code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.Vpc.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | The parent construct this is part of. |
+| <code><a href="#@btc-embedded/cdk-extensions.Vpc.Initializer.parameter.id">id</a></code> | <code>string</code> | Id of this construct for Cloudformation. |
+| <code><a href="#@btc-embedded/cdk-extensions.Vpc.Initializer.parameter.props">props</a></code> | <code><a href="#@btc-embedded/cdk-extensions.VpcProps">VpcProps</a></code> | Properties allowing to set a predefined VPCName, IPAdressBlog, maxNumber of AZs and decision wether to create a KMSKey for usage with the Exec extension. |
 
 ---
 
@@ -587,18 +721,27 @@ new Vpc(scope: Construct, id: string, props: VpcProps)
 
 - *Type:* constructs.Construct
 
+The parent construct this is part of.
+
 ---
 
 ##### `id`<sup>Required</sup> <a name="id" id="@btc-embedded/cdk-extensions.Vpc.Initializer.parameter.id"></a>
 
 - *Type:* string
 
+Id of this construct for Cloudformation.
+
 ---
 
 ##### `props`<sup>Required</sup> <a name="props" id="@btc-embedded/cdk-extensions.Vpc.Initializer.parameter.props"></a>
 
 - *Type:* <a href="#@btc-embedded/cdk-extensions.VpcProps">VpcProps</a>
 
+Properties allowing to set a predefined VPCName, IPAdressBlog, maxNumber of AZs and decision wether to create a KMSKey for usage with the Exec extension.
+
+Defaults to an empty object creating a
+dedicated VPC, with max 2 AZS and NO Key for Exec
+
 ---
 
 #### Methods <a name="Methods" id="Methods"></a>
@@ -648,7 +791,7 @@ Any object.
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#@btc-embedded/cdk-extensions.Vpc.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
-| <code><a href="#@btc-embedded/cdk-extensions.Vpc.property.cluster">cluster</a></code> | <code>aws-cdk-lib.aws_ecs.ICluster</code> | *No description.* |
+| <code><a href="#@btc-embedded/cdk-extensions.Vpc.property.cluster">cluster</a></code> | <code>aws-cdk-lib.aws_ecs.Cluster</code> | *No description.* |
 | <code><a href="#@btc-embedded/cdk-extensions.Vpc.property.vpcInstance">vpcInstance</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | *No description.* |
 
 ---
@@ -668,10 +811,10 @@ The tree node.
 ##### `cluster`<sup>Required</sup> <a name="cluster" id="@btc-embedded/cdk-extensions.Vpc.property.cluster"></a>
 
 ```typescript
-public readonly cluster: ICluster;
+public readonly cluster: Cluster;
 ```
 
-- *Type:* aws-cdk-lib.aws_ecs.ICluster
+- *Type:* aws-cdk-lib.aws_ecs.Cluster
 
 ---
 
@@ -2199,6 +2342,63 @@ public readonly namespaceName: string;
 
 ---
 
+### SecureRestApiProps <a name="SecureRestApiProps" id="@btc-embedded/cdk-extensions.SecureRestApiProps"></a>
+
+#### Initializer <a name="Initializer" id="@btc-embedded/cdk-extensions.SecureRestApiProps.Initializer"></a>
+
+```typescript
+import { SecureRestApiProps } from '@btc-embedded/cdk-extensions'
+
+const secureRestApiProps: SecureRestApiProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.SecureRestApiProps.property.apiSubDomain">apiSubDomain</a></code> | <code>string</code> | Subdomain that is used for REST API props. |
+| <code><a href="#@btc-embedded/cdk-extensions.SecureRestApiProps.property.basePlatformStackName">basePlatformStackName</a></code> | <code>string</code> | The name of the Base platform Stack. |
+| <code><a href="#@btc-embedded/cdk-extensions.SecureRestApiProps.property.hostedZone">hostedZone</a></code> | <code>aws-cdk-lib.aws_route53.IHostedZone</code> | hosted zone for the subdomain An optional parameter. |
+
+---
+
+##### `apiSubDomain`<sup>Required</sup> <a name="apiSubDomain" id="@btc-embedded/cdk-extensions.SecureRestApiProps.property.apiSubDomain"></a>
+
+```typescript
+public readonly apiSubDomain: string;
+```
+
+- *Type:* string
+
+Subdomain that is used for REST API props.
+
+---
+
+##### `basePlatformStackName`<sup>Required</sup> <a name="basePlatformStackName" id="@btc-embedded/cdk-extensions.SecureRestApiProps.property.basePlatformStackName"></a>
+
+```typescript
+public readonly basePlatformStackName: string;
+```
+
+- *Type:* string
+
+The name of the Base platform Stack.
+
+---
+
+##### `hostedZone`<sup>Optional</sup> <a name="hostedZone" id="@btc-embedded/cdk-extensions.SecureRestApiProps.property.hostedZone"></a>
+
+```typescript
+public readonly hostedZone: IHostedZone;
+```
+
+- *Type:* aws-cdk-lib.aws_route53.IHostedZone
+- *Default:* fqdn output of base platform stack is used to import the hosted zone
+
+hosted zone for the subdomain An optional parameter.
+
+---
+
 ### SharedVolumeExtensionProps <a name="SharedVolumeExtensionProps" id="@btc-embedded/cdk-extensions.SharedVolumeExtensionProps"></a>
 
 Properties for defining an ephermal shared volume.
@@ -2325,12 +2525,23 @@ const vpcProps: VpcProps = { ... }
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
+| <code><a href="#@btc-embedded/cdk-extensions.VpcProps.property.createKmsExecCommandKey">createKmsExecCommandKey</a></code> | <code>boolean</code> | *No description.* |
 | <code><a href="#@btc-embedded/cdk-extensions.VpcProps.property.definedVpcName">definedVpcName</a></code> | <code>string</code> | *No description.* |
 | <code><a href="#@btc-embedded/cdk-extensions.VpcProps.property.maxAzs">maxAzs</a></code> | <code>number</code> | *No description.* |
 | <code><a href="#@btc-embedded/cdk-extensions.VpcProps.property.vpcCidr">vpcCidr</a></code> | <code>aws-cdk-lib.aws_ec2.IIpAddresses</code> | *No description.* |
 
 ---
 
+##### `createKmsExecCommandKey`<sup>Optional</sup> <a name="createKmsExecCommandKey" id="@btc-embedded/cdk-extensions.VpcProps.property.createKmsExecCommandKey"></a>
+
+```typescript
+public readonly createKmsExecCommandKey: boolean;
+```
+
+- *Type:* boolean
+
+---
+
 ##### `definedVpcName`<sup>Optional</sup> <a name="definedVpcName" id="@btc-embedded/cdk-extensions.VpcProps.property.definedVpcName"></a>
 
 ```typescript

package/CHANGELOG.md

@@ -1,4 +1,23 @@
 
+## [0.5.3](https://github.com/btc-embedded/cdk-extensions/compare/v0.5.2...v0.5.3) (2025-02-11)
+
+
+### Features
+
+* add SecureRestApi Construt ([e212545](https://github.com/btc-embedded/cdk-extensions/commit/e2125457345456c107352e19f4db5d024d1d2393))
+
+
+### Bug Fixes
+
+* add subdomain to the RestApi ([9b7077b](https://github.com/btc-embedded/cdk-extensions/commit/9b7077b36fff53b2982449dec28279cce47d3740))
+
+## [0.5.2](https://github.com/btc-embedded/cdk-extensions/compare/v0.5.1...v0.5.2) (2025-01-28)
+
+
+### Features
+
+* make parameter key configurable for cloudmap ([7b4e6a4](https://github.com/btc-embedded/cdk-extensions/commit/7b4e6a44a84c2033a3190e08adb80dde0f5cb4fb))
+
 ## [0.5.1](https://github.com/btc-embedded/cdk-extensions/compare/v0.5.0...v0.5.1) (2025-01-24)
 
 

package/lib/constructs/SecureRestApi.d.ts

@@ -0,0 +1,26 @@
+import { CognitoUserPoolsAuthorizer, DomainName, RestApiProps } from "aws-cdk-lib/aws-apigateway";
+import { IHostedZone } from "aws-cdk-lib/aws-route53";
+import { Construct } from "constructs/lib/construct";
+export interface SecureRestApiProps {
+    /**
+     * The name of the Base platform Stack
+     */
+    readonly basePlatformStackName: string;
+    /**
+     * Subdomain that is used for REST API props
+     */
+    readonly apiSubDomain: string;
+    /**
+     * hosted zone for the subdomain
+     * An optional parameter
+     * @default - fqdn output of base platform stack is used to import the hosted zone
+     */
+    readonly hostedZone?: IHostedZone;
+}
+export declare class SecureRestApi extends Construct {
+    restApiDomainName: DomainName;
+    defaultAuthorizer: CognitoUserPoolsAuthorizer;
+    private certificate;
+    constructor(scope: Construct, id: string, props: SecureRestApiProps);
+    withSecureRestApiProps(props: RestApiProps): RestApiProps;
+}