From 54a44ca5a185fc4d1f15f062871b996a8821a3f7 Mon Sep 17 00:00:00 2001 From: github-actions Date: Tue, 27 Aug 2024 00:33:10 +0000 Subject: [PATCH] chore: self mutation Signed-off-by: github-actions --- API.md | 38 -------------------------------------- 1 file changed, 38 deletions(-) diff --git a/API.md b/API.md index c7f4e7b..5b47e39 100644 --- a/API.md +++ b/API.md @@ -1,41 +1,3 @@ -# Secure Parameter Store - -## Why - -AWS CDK not having a way to create secure parameter store, and it recommends secret manager, which is costly. -This construct provides a way to create secure parameter store using CDK Custom Resource - -## Usage - -Similar to how other CDK constructs are used - -```typescript -new SecureParameterStore(stack, 'MySecureParameterStore', { - name: 'ParameterName', - value: 'Parameter Value', -}); -``` - -## How it works - -This construt creates a [Lambda backed Custom Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-custom-resources-lambda.html), the lambda is using AWS SDK to create and delete parameter store, whenever Custom Resource is created and destroyed - -For more info refer aws [docs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-custom-resources.html) - -## For Contributors - -### Build - -- `npx projen build` - -### Deploy - -- `yarn dev:deploy` - -### Destroy - -- `npx cdk destroy --app='./lib/integ.default.js'` - # API Reference ## Constructs