@btc-embedded/cdk-extensions 0.14.13 → 0.14.14

package/.jsii

@@ -7769,8 +7769,8 @@
       "fqn": "@btc-embedded/cdk-extensions.EfsAccessMode",
       "kind": "enum",
       "locationInModule": {
-        "filename": "src/extensions/EfsMountExtension.ts",
-        "line": 13
+        "filename": "src/platform/EfsFileSystem.ts",
+        "line": 45
       },
       "members": [
         {
@@ -7796,7 +7796,346 @@
         }
       ],
       "name": "EfsAccessMode",
-      "symbolId": "src/extensions/EfsMountExtension:EfsAccessMode"
+      "symbolId": "src/platform/EfsFileSystem:EfsAccessMode"
+    },
+    "@btc-embedded/cdk-extensions.EfsFileSystem": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "base": "constructs.Construct",
+      "docs": {
+        "stability": "experimental",
+        "summary": "An EFS filesystem implementation that wraps the filesystem and the security group and allows to import an EFS from a different stack."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.EfsFileSystem",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/platform/EfsFileSystem.ts",
+          "line": 210
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.EfsFileSystemProps"
+            }
+          }
+        ]
+      },
+      "interfaces": [
+        "@btc-embedded/cdk-extensions.IEfsFileSystem"
+      ],
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/platform/EfsFileSystem.ts",
+        "line": 157
+      },
+      "methods": [
+        {
+          "docs": {
+            "returns": "An instance of the {@link IEfsFileSystem }.",
+            "stability": "experimental",
+            "summary": "Import an existing filesystem from the base platform stack."
+          },
+          "locationInModule": {
+            "filename": "src/platform/EfsFileSystem.ts",
+            "line": 165
+          },
+          "name": "fromBasePlatform",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "The scope of the element."
+              },
+              "name": "scope",
+              "type": {
+                "fqn": "constructs.Construct"
+              }
+            },
+            {
+              "docs": {
+                "summary": "The id of the imported component."
+              },
+              "name": "id",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "docs": {
+                "summary": "Lookup parameters to find the filesystem."
+              },
+              "name": "basePlatformLookup",
+              "type": {
+                "fqn": "@btc-embedded/cdk-extensions.EfsFileSystemLookupOptions"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "@btc-embedded/cdk-extensions.IEfsFileSystem"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/platform/EfsFileSystem.ts",
+            "line": 105
+          },
+          "name": "allowConnection",
+          "overrides": "@btc-embedded/cdk-extensions.IEfsFileSystem",
+          "parameters": [
+            {
+              "name": "grantee",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_ec2.IConnectable"
+              }
+            }
+          ]
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/platform/EfsFileSystem.ts",
+            "line": 101
+          },
+          "name": "fileSystem",
+          "overrides": "@btc-embedded/cdk-extensions.IEfsFileSystem",
+          "returns": {
+            "type": {
+              "fqn": "aws-cdk-lib.aws_efs.IFileSystem"
+            }
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/platform/EfsFileSystem.ts",
+            "line": 97
+          },
+          "name": "fileSystemId",
+          "overrides": "@btc-embedded/cdk-extensions.IEfsFileSystem",
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/platform/EfsFileSystem.ts",
+            "line": 67
+          },
+          "name": "grantAccess",
+          "overrides": "@btc-embedded/cdk-extensions.IEfsFileSystem",
+          "parameters": [
+            {
+              "name": "grantee",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_iam.IRole"
+              }
+            },
+            {
+              "name": "accessMode",
+              "type": {
+                "fqn": "@btc-embedded/cdk-extensions.EfsAccessMode"
+              }
+            }
+          ]
+        }
+      ],
+      "name": "EfsFileSystem",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/platform/EfsFileSystem.ts",
+            "line": 64
+          },
+          "name": "filesystem",
+          "protected": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_efs.IFileSystem"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/platform/EfsFileSystem.ts",
+            "line": 65
+          },
+          "name": "securityGroup",
+          "protected": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup"
+          }
+        }
+      ],
+      "symbolId": "src/platform/EfsFileSystem:EfsFileSystem"
+    },
+    "@btc-embedded/cdk-extensions.EfsFileSystemLookupOptions": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Lookup options for importing a filesystem from the base stack."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.EfsFileSystemLookupOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/platform/EfsFileSystem.ts",
+        "line": 113
+      },
+      "name": "EfsFileSystemLookupOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The name of the base platform."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/EfsFileSystem.ts",
+            "line": 117
+          },
+          "name": "basePlatformName",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The name of the filesystem to be imported."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/EfsFileSystem.ts",
+            "line": 122
+          },
+          "name": "filesystemName",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/platform/EfsFileSystem:EfsFileSystemLookupOptions"
+    },
+    "@btc-embedded/cdk-extensions.EfsFileSystemProps": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@btc-embedded/cdk-extensions.EfsFileSystemProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/platform/EfsFileSystem.ts",
+        "line": 22
+      },
+      "name": "EfsFileSystemProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Has to be unique in the stack.\nIs also used for importing the filesystem from another stack.",
+            "stability": "experimental",
+            "summary": "The name to be used for the filesystem."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/EfsFileSystem.ts",
+            "line": 31
+          },
+          "name": "name",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "The VPC to be used."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/EfsFileSystem.ts",
+            "line": 26
+          },
+          "name": "vpc",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.IVpc"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Default: `false`.",
+            "stability": "experimental",
+            "summary": "Enable automatic backups."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/EfsFileSystem.ts",
+            "line": 35
+          },
+          "name": "automaticBackups",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Default: {@link RemovalPolicy.DESTROY}.",
+            "stability": "experimental",
+            "summary": "Removal policy."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/platform/EfsFileSystem.ts",
+            "line": 39
+          },
+          "name": "removalPolicy",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.RemovalPolicy"
+          }
+        }
+      ],
+      "symbolId": "src/platform/EfsFileSystem:EfsFileSystemProps"
     },
     "@btc-embedded/cdk-extensions.EfsMountExtension": {
       "assembly": "@btc-embedded/cdk-extensions",
@@ -7813,7 +8152,7 @@
         },
         "locationInModule": {
           "filename": "src/extensions/EfsMountExtension.ts",
-          "line": 58
+          "line": 39
         },
         "parameters": [
           {
@@ -7827,7 +8166,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/extensions/EfsMountExtension.ts",
-        "line": 52
+        "line": 33
       },
       "methods": [
         {
@@ -7838,7 +8177,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/EfsMountExtension.ts",
-            "line": 98
+            "line": 78
           },
           "name": "useService",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -7867,7 +8206,7 @@
           },
           "locationInModule": {
             "filename": "src/extensions/EfsMountExtension.ts",
-            "line": 67
+            "line": 48
           },
           "name": "useTaskDefinition",
           "overrides": "@aws-cdk-containers/ecs-service-extensions.ServiceExtension",
@@ -7890,7 +8229,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/EfsMountExtension.ts",
-            "line": 55
+            "line": 36
           },
           "name": "accessMode",
           "type": {
@@ -7904,11 +8243,11 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/EfsMountExtension.ts",
-            "line": 53
+            "line": 34
           },
           "name": "filesystem",
           "type": {
-            "fqn": "aws-cdk-lib.aws_efs.IFileSystem"
+            "fqn": "@btc-embedded/cdk-extensions.IEfsFileSystem"
           }
         },
         {
@@ -7918,7 +8257,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/EfsMountExtension.ts",
-            "line": 54
+            "line": 35
           },
           "name": "path",
           "type": {
@@ -7932,7 +8271,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/EfsMountExtension.ts",
-            "line": 56
+            "line": 37
           },
           "name": "volumeName",
           "type": {
@@ -7953,7 +8292,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/extensions/EfsMountExtension.ts",
-        "line": 31
+        "line": 12
       },
       "name": "EfsMountExtensionProperties",
       "properties": [
@@ -7966,7 +8305,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/EfsMountExtension.ts",
-            "line": 40
+            "line": 21
           },
           "name": "accessMode",
           "type": {
@@ -7982,11 +8321,11 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/EfsMountExtension.ts",
-            "line": 45
+            "line": 26
           },
           "name": "filesystem",
           "type": {
-            "fqn": "aws-cdk-lib.aws_efs.IFileSystem"
+            "fqn": "@btc-embedded/cdk-extensions.IEfsFileSystem"
           }
         },
         {
@@ -7998,7 +8337,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/extensions/EfsMountExtension.ts",
-            "line": 35
+            "line": 16
           },
           "name": "path",
           "type": {
@@ -9080,6 +9419,112 @@
       ],
       "symbolId": "src/platform/DocumentDB:IDocumentDB"
     },
+    "@btc-embedded/cdk-extensions.IEfsFileSystem": {
+      "assembly": "@btc-embedded/cdk-extensions",
+      "docs": {
+        "stability": "experimental",
+        "summary": "Interface for the {@link EfsFileSystem}."
+      },
+      "fqn": "@btc-embedded/cdk-extensions.IEfsFileSystem",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/platform/EfsFileSystem.ts",
+        "line": 128
+      },
+      "methods": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Allow connection to the filesystem."
+          },
+          "locationInModule": {
+            "filename": "src/platform/EfsFileSystem.ts",
+            "line": 140
+          },
+          "name": "allowConnection",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "The component to allow connections for."
+              },
+              "name": "grantee",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_ec2.IConnectable"
+              }
+            }
+          ]
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Get the underlying EFS filesystem."
+          },
+          "locationInModule": {
+            "filename": "src/platform/EfsFileSystem.ts",
+            "line": 150
+          },
+          "name": "fileSystem",
+          "returns": {
+            "type": {
+              "fqn": "aws-cdk-lib.aws_efs.IFileSystem"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Get the ID of the underlying EFS filesystem."
+          },
+          "locationInModule": {
+            "filename": "src/platform/EfsFileSystem.ts",
+            "line": 145
+          },
+          "name": "fileSystemId",
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Grant access to a role for the filesystem."
+          },
+          "locationInModule": {
+            "filename": "src/platform/EfsFileSystem.ts",
+            "line": 134
+          },
+          "name": "grantAccess",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "The role to grant access for."
+              },
+              "name": "grantee",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_iam.IRole"
+              }
+            },
+            {
+              "docs": {
+                "summary": "The access mode for the grantee."
+              },
+              "name": "accessMode",
+              "type": {
+                "fqn": "@btc-embedded/cdk-extensions.EfsAccessMode"
+              }
+            }
+          ]
+        }
+      ],
+      "name": "IEfsFileSystem",
+      "symbolId": "src/platform/EfsFileSystem:IEfsFileSystem"
+    },
     "@btc-embedded/cdk-extensions.IPrivateDnsNamespace": {
       "assembly": "@btc-embedded/cdk-extensions",
       "docs": {
@@ -11805,6 +12250,6 @@
       "symbolId": "src/platform/Vpc:VpcProps"
     }
   },
-  "version": "0.14.13",
-  "fingerprint": "cl6L1GAACqmSQ1xeKtJzyKWwaEuVZyl5dmlzmRvpVq4="
+  "version": "0.14.14",
+  "fingerprint": "1MR8zY20ujKE3pX3QNeeO5LW+wMV2kdBamjRPuh612w="
 }