Skip to content

Latest commit

 

History

History
190 lines (110 loc) · 5.79 KB

API.md

File metadata and controls

190 lines (110 loc) · 5.79 KB

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

new SecureParameterStore(stack, 'MySecureParameterStore', {
  name: 'ParameterName',
  value: 'Parameter Value',
});

How it works

This construt creates a Lambda backed Custom Resource, 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

For Contributors

Build

  • npx projen build

Deploy

  • yarn dev:deploy

Destroy

  • npx cdk destroy --app='./lib/integ.default.js'

API Reference

Constructs

SecureParameterStore

Initializers 

import { SecureParameterStore } from 'cdk-secure-parameter-store'

new SecureParameterStore(scope: Construct, id: string, props: ISecureParameterStoreProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props ISecureParameterStoreProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { SecureParameterStore } from 'cdk-secure-parameter-store'

SecureParameterStore.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

Protocols

ISecureParameterStoreProps

Properties

Name Type Description
value string No description.
name string No description.
resourceNamesPrefix string No description.
valueRequired 
public readonly value: string;
  • Type: string
nameOptional 
public readonly name: string;
  • Type: string
resourceNamesPrefixOptional 
public readonly resourceNamesPrefix: string;
  • Type: string