{"_id":"@stellarlibs/nx-cdk","_rev":"36-c3fc474e3b24425506b44cb48b7e2ebc","name":"@stellarlibs/nx-cdk","dist-tags":{"latest":"1.0.91"},"versions":{"1.0.70":{"name":"@stellarlibs/nx-cdk","version":"1.0.70","dependencies":{"@nx/devkit":"18.0.4","tslib":"^2.3.0","@nx/vite":"18.0.4","@nx/jest":"18.0.4"},"type":"commonjs","main":"./src/index.js","typings":"./src/index.d.ts","generators":"./generators.json","executors":"./executors.json","_id":"@stellarlibs/nx-cdk@1.0.70","gitHead":"b926d4ddda54c2433e6d8760650d956270be4a65","description":"<br>","_nodeVersion":"18.19.0","_npmVersion":"10.2.3","dist":{"integrity":"sha512-gp6wrfcewLTdJQo/TroTd+HPGOoSZCUmLk2FFPqlj7fRlCmq55sHOHWm3FvT7xvICW1tsKKBAK1NXdhjt6wgzQ==","shasum":"05148cca5c8eaf72f6c208eae1c6bf512fd1a336","tarball":"https://registry.npmjs.org/@stellarlibs/nx-cdk/-/nx-cdk-1.0.70.tgz","fileCount":108,"unpackedSize":81241,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHY9NtENwmUSq6xoo3+FWk4Xa79JEgNRN1v440B7Cdf4AiEA1E2M7UlctPqiH/QIl4Gxrnzmw4hrwRJ3gFdqz4aqte0="}]},"_npmUser":{"name":"stellarapps","email":"ej92@protonmail.com"},"directories":{},"maintainers":[{"name":"stellarapps","email":"ej92@protonmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nx-cdk_1.0.70_1708332990925_0.05727001407600718"},"_hasShrinkwrap":false},"1.0.75":{"name":"@stellarlibs/nx-cdk","version":"1.0.75","dependencies":{"@nx/devkit":"18.0.4","tslib":"^2.3.0","@nx/vite":"18.0.4","@nx/jest":"18.0.4"},"type":"commonjs","main":"./src/index.js","typings":"./src/index.d.ts","generators":"./generators.json","executors":"./executors.json","_id":"@stellarlibs/nx-cdk@1.0.75","gitHead":"5d839dd3afb1c6929c2ad22ebee7e7c7075222ac","description":"<br>","_nodeVersion":"18.19.0","_npmVersion":"10.2.3","dist":{"integrity":"sha512-qLNVYzjEEx8lqLxI5w9EkWQ6U49e/WsUwHRQN47xvLGH+CmZo7IPPPJ/GQYZIUP7sXFnwywWQN7OmFHYGwEDTg==","shasum":"61dcc18d35adb7273d8ec1295b975c8ec0a5e773","tarball":"https://registry.npmjs.org/@stellarlibs/nx-cdk/-/nx-cdk-1.0.75.tgz","fileCount":112,"unpackedSize":82995,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDUzlEUbHol8/bE3EVISxbOwUlDi9f/mqqQ17u+ivMi9gIgFwuEiQk+fmjPtwJBXtXqJErl/S1IXE4NFglENRYr4VA="}]},"_npmUser":{"name":"stellarapps","email":"ej92@protonmail.com"},"directories":{},"maintainers":[{"name":"stellarapps","email":"ej92@protonmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nx-cdk_1.0.75_1708334599445_0.8146628787278318"},"_hasShrinkwrap":false},"1.0.8":{"name":"@stellarlibs/nx-cdk","version":"1.0.8","dependencies":{"@nx/devkit":"18.0.4","tslib":"^2.3.0","@nx/vite":"18.0.4","@nx/jest":"18.0.4"},"type":"commonjs","main":"./src/index.js","typings":"./src/index.d.ts","generators":"./generators.json","executors":"./executors.json","_id":"@stellarlibs/nx-cdk@1.0.8","gitHead":"fadbe1abcebec7e66a6e9ce2546258c4183e78c7","description":"<br>","_nodeVersion":"18.19.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-q7XF7wfhwaUb265U3JJUrA/J0y7u64v24IStZLcbCSBRgG+TQhGxykTA4KPj0edLchhkO2MkbNJXcKJxa4olqA==","shasum":"e530969af9cc83915722a086cf00459e0ddd6ef0","tarball":"https://registry.npmjs.org/@stellarlibs/nx-cdk/-/nx-cdk-1.0.8.tgz","fileCount":118,"unpackedSize":85948,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCID0UnwmKDi5c+JaBziPMJ22d+NDS+YFQiOrl1fUklE+aAiEAsuTLnOR7Oit6pfY19otr/iclywJfF/DMgzr/gvhzNW4="}]},"_npmUser":{"name":"stellarapps","email":"ej92@protonmail.com"},"directories":{},"maintainers":[{"name":"stellarapps","email":"ej92@protonmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nx-cdk_1.0.8_1708609354087_0.04750865610898347"},"_hasShrinkwrap":false},"1.0.9":{"name":"@stellarlibs/nx-cdk","version":"1.0.9","dependencies":{"@nx/devkit":"18.0.4","tslib":"^2.3.0","@nx/vite":"18.0.4","@nx/jest":"18.0.4"},"type":"commonjs","main":"./src/index.js","typings":"./src/index.d.ts","generators":"./generators.json","executors":"./executors.json","_id":"@stellarlibs/nx-cdk@1.0.9","gitHead":"6055dab87c30795943e9917a5c0426ae9f15b7b4","description":"<br>","_nodeVersion":"18.20.1","_npmVersion":"10.5.0","dist":{"integrity":"sha512-BQ3luqjX3klKS/G5EjMgy9Akup0+Dwp1iv9Gm2NlYboehiWBBgkhlbtOLzMgMuKMpt+SZnxlAmMJ6hkno9/3sg==","shasum":"07d88ab240063c9d2369b9e1bb2d45d5edcd46d7","tarball":"https://registry.npmjs.org/@stellarlibs/nx-cdk/-/nx-cdk-1.0.9.tgz","fileCount":109,"unpackedSize":94235,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDAazG77q4G2wUrSxFawbMc04nMqHQjKZVcVsl6g0s5vQIhAJbUdaGHwK4sr51yJ8pUFNBrTL85yjweCl6+i2++IwtO"}]},"_npmUser":{"name":"stellarapps","email":"ej92@protonmail.com"},"directories":{},"maintainers":[{"name":"stellarapps","email":"ej92@protonmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nx-cdk_1.0.9_1713280978719_0.2542082316540466"},"_hasShrinkwrap":false},"1.0.91":{"name":"@stellarlibs/nx-cdk","version":"1.0.91","dependencies":{"@nx/devkit":"18.0.4","tslib":"^2.3.0","@nx/vite":"18.0.4","@nx/jest":"18.0.4"},"type":"commonjs","main":"./src/index.js","typings":"./src/index.d.ts","generators":"./generators.json","executors":"./executors.json","_id":"@stellarlibs/nx-cdk@1.0.91","gitHead":"a33297ab934ac4d3d66cc83d9e2b4567a04e4afb","description":"<br>","_nodeVersion":"18.20.2","_npmVersion":"10.5.0","dist":{"integrity":"sha512-bRsFuZSDdqLfbMMRzjU4cCuxI5zNBV25yerrbNWwLYE96PdiiJPSHynnTH+y/87Gc6WOJrs86pC8DHAMq+b5Yw==","shasum":"87802d5722c80374b3aa9a053c40d28c0587156c","tarball":"https://registry.npmjs.org/@stellarlibs/nx-cdk/-/nx-cdk-1.0.91.tgz","fileCount":109,"unpackedSize":94612,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIG+HDIMy1j+6WCng31apyNIGKorfgQrd3RJ90EujjkpPAiEAqQvJY3dXgLMmdUDZAJNP8MLZqdxYBwSmAWLxS3FDWOU="}]},"_npmUser":{"name":"stellarapps","email":"ej92@protonmail.com"},"directories":{},"maintainers":[{"name":"stellarapps","email":"ej92@protonmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nx-cdk_1.0.91_1713417465602_0.07989883744028736"},"_hasShrinkwrap":false}},"time":{"created":"2024-01-31T19:19:38.144Z","0.0.9":"2024-01-31T19:19:38.398Z","modified":"2024-04-18T05:17:46.022Z","1.0.0":"2024-02-01T07:13:34.992Z","1.0.1":"2024-02-06T06:36:50.722Z","1.0.2":"2024-02-06T08:24:39.917Z","1.0.3":"2024-02-06T08:50:32.591Z","1.0.5":"2024-02-07T11:12:48.426Z","1.0.6":"2024-02-14T11:05:50.626Z","1.0.65":"2024-02-14T11:34:10.573Z","1.0.66":"2024-02-14T11:42:03.035Z","1.0.67":"2024-02-14T11:56:41.830Z","1.0.68":"2024-02-14T12:10:37.208Z","0.0.0-e2e":"2024-02-18T00:28:15.676Z","6.0.0":"2024-02-18T21:51:10.995Z","3.5.3":"2024-02-18T21:56:06.139Z","4.1.0":"2024-02-19T08:47:20.598Z","1.0.70":"2024-02-19T08:56:31.071Z","1.0.75":"2024-02-19T09:23:19.608Z","1.0.8":"2024-02-22T13:42:34.284Z","1.0.9":"2024-04-16T15:22:58.872Z","1.0.91":"2024-04-18T05:17:45.794Z"},"maintainers":[{"name":"stellarapps","email":"ej92@protonmail.com"}],"description":"<br>","readme":"<br>\n\n# Nx Aws Cdk Documentation\n\nAWS Cloud Development Kit (CDK) applications within Nx workspaces.\n\n<br>\n\n## Table of Contents\n\n1. [Generate Application](#generate-application)\n2. [Generate Library](#generate-library)\n3. [Remove Application](#remove-application)\n4. [Environment Bootstrap](#bootstrap)\n5. [Synthesize Application](#synth)\n6. [Deploy Application/Stack](#deploy)\n7. [Destroy Application/Stack](#destroy)\n\n---\n\n<br>\n\n## Installation\n\nThe [`@stellarlibs/nx-cdk`](https://www.npmjs.com/package/@stellarlibs/nx-cdk) package can be installed via npm or yarn. It provides tools for managing AWS CDK applications. To install, use the following command:\n\n```bash\nnpm i @stellarlibs/nx-cdk\n```\n\n</br>\n\n## Starter\n\nbasic commands\n\n```sh\nnx g @stellarlibs/nx-cdk:app <AppName>\n```\n\n```sh\nnx bootstrap <AppName>\n```\n\n```sh\nnx deploy <AppName>\n```\n\n<br>\n<br>\n\n## 1. Generate Application<a name=\"generate-application\"></a>\n\nTo generate a new application, use the following command. This command sets up a new AWS CDK application with optional configurations for testing and linting.\n\n```sh\nnx g @stellarlibs/nx-cdk:app <APP_NAME>\n\n    [--tag <String>]\n    [--directory <String>]\n    [--testRunner <jest | none>]\n```\n\n#### Options:\n\n-  `--tag` (optional): Tags to categorize your applications. You can pass multiple --tag arguments.\n-  `--testRunner` (optional): Specifies the testing library to use. Jest | None.\n-  `--directory` (optional): Specifies the directory where the application will be created.\n\n#### Example:\n\n```bash\nnx g @stellarlibs/nx-cdk:app myapp --tag experimental --tag infrastructure --directory apps\n```\n\n<br>\n<br>\n\n## 2. Generate Library<a name=\"generate-library\"></a>\n\nTo generate a new library, use the following command. This command sets up a new AWS CDK library with optional configurations for testing and linting.\n\n```sh\nnx g @stellarlibs/nx-cdk:lib <APP_NAME>\n\n    [--tag <String>]\n    [--directory <String>]\n    [--testRunner <jest | none>]\n```\n\n#### Options:\n\n-  `--tag` (optional): Tags to categorize your applications. You can pass multiple --tag arguments.\n-  `--testRunner` (optional): Specifies the testing library to use. Jest | None.\n-  `--directory` (optional): Specifies the directory where the application will be created.\n\n#### Example:\n\n```bash\nnx g @stellarlibs/nx-cdk:lib myapp --tag experimental --tag infrastructure --directory apps\n```\n\n</br>\n</br>\n\n## 3. Remove Application<a name=\"remove-application\"></a>\n\nTo remove an existing application, use the following command:\n\n```bash\nnx g @stellarlibs/nx-cdk:remove <APP_NAME>\n```\n\n<br>\n<br>\n\n## 4. Bootstrap<a name=\"bootstrap\"></a>\n\nBefore deploying the application, it's necessary to bootstrap the environment. This step prepares the AWS resources required for deployment.\n\n| **_Check aws cdk documentation for more options_**\n\n```bash\nnx bootstrap <APP_NAME>\n    [--all <Boolean>]\n    [--qualifier <Bootstrap_Qualifier>]\n    [--bucketName <Bucket_Name>]\n    [--executionPolicy <Execution_Policy_ARN>]\n    [--terminationProtection]\n    [--kmsKeyId <Kms_Key_Id>]\n    [--trust <Trust_Options>]\n    ...\n```\n\n#### Options:\n\n-  `--profile` (optional): Specifies the AWS profile for bootstrapping.\n-  `--qualifier` (optional): Specifies the bootstrap qualifier.\n-  `--bucketName` (optional): Specifies the bootstrap bucket name.\n-  `--executionPolicy` (optional): Specifies the execution policy ARN.\n-  `--terminationProtection` (optional): Protects against termination.\n-  `--kmsKeyId` (optional): Specifies the KMS key ID.\n-  `--trust` (optional): Specifies trust options.\n\n<br>\n<br>\n\n## 5. Synth<a name=\"synth\"></a>\n\nThe `nx synth <APP_NAME>` command is used to synthesize the application, which means it compiles your source code into a format that can be deployed to AWS.\n\n```bash\nnx synth <APP_NAME>\n    [--output <OUTPUT_DIRECTORY>]\n```\n\n#### Options:\n\n-  `--output` (optional): Specifies the directory for the synthesized output.\n\n<br>\n<br>\n\n## 6. Deploy<a name=\"deploy\"></a>\n\nTo deploy the application/stack, execute:\n\n```bash\nnx deploy <Stack_Name>\n    [--stack <Stack_Name>]\n```\n\n#### Options:\n\n-  `--stack` (optional) <Stack_Name>: Specifies the stack name to deploy. You can pass multiple --stack arguments.\n\n#### Example:\n\n```bash\nnx deploy --stack StackOne --stack StackTwo\n```\n\n<br>\n<br>\n\n## 7. Destroy<a name=\"destroy\"></a>\n\nTo destroy the application/stack, execute:\n\n```bash\nnx destroy <Stack_Name>\n    [--stack <Stack_Name>]\n```\n\n#### Options:\n\n-  `--stack` (optional): Specifies the stack name to destroy. You can pass multiple --stack arguments.\n\n#### Example:\n\n```bash\nnx destroy --stack StackOne --stack StackTwo\n```\n\n<br>\n<br>\n","readmeFilename":"README.md"}