Introduction
This package generates CDK classes, using templates, from the go ssm report.
Reporting
It is possible to generate a report as object and JSON using the golang ssm report. This may be used in a DevOps pipeline to e.g. use CDK to create Parameter Store & Secrets Manager entities to be provisioned using cloud formation. Hence it is possible to have
default values by passing the struct as value instead of nil
pointer with a specific interface
type.
For example, the following
type Sample struct { ConnectionString string `asm:"connectstring, strkey=password, gurka=biffen, nasse=hunden"` Secret string `asm:"mysecret"` Parameter string `pms:"parameter, description=A sample value, pattern=.*, my=hobby, by=test"`} set := Sample{ ConnectString: "{\"user\":\"nisse\"}", Secret: "{\"private\": \"nobody knows\", \"lockkey\":\"eeej1¤¤&1!\"}", Parameter: "a parameter"} s := NewSsmSerializer("dev", "test-service")objs, json, err := s.ReportWithOpts(&set, NoFilter, true)if err != nil { panic(err)}
Renders a JSON report on the following format:
However since it returns a Report
object containing Parameters
you may do your own JSON or otherwise generation from the Report
object. It is also possible to use filter to filter out fields in same manner as Marshal
and Unmarshal
works.
From this JSON it is possible to transform it to e.g. CDK @aws-cdk/aws-ssm
object such as
stack 'Parameter' allowedPattern: '.*' description: 'The value Foo' parameterName: 'FooParameter' stringValue: 'Foo' tier: ssmParameterTierADVANCED;
CDK Generator
This is an implementation of a CDK generator, that is template driven to fit your CDK generation needs.For example given the report JSON file above and use ssm-cdk-generator will output the following using default templates.
; ; ;
Use the node app/index.js --help to get help on which parameters you may use.
Options: --help Show help [boolean] --version Show version number [boolean] --outfile, -o An optional outfile to write the resulting CDK Construct --stdout Output the result onto stdout. This may be combined with --outfile --infile, -i The ssm report file to read from filesystem instead of default stdin --tsconfig Optional tsconfig.json file to use when generating the source code --clsname, -c Optional a class name
Templates are very simple and the default resides under the _ssm-cdk-generator/templates for reviewing. For example a template to generate a single Parameter Store Parameter could look like this.
new pms.CfnParameterthis, 'Parameter{index}', ;