Safebox Config

Documentation: https://github.com/monebag/safebox

Type object
File match *safebox*.yaml *safebox*.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/safebox-config/latest.json
Source https://www.schemastore.org/safebox-schema-v1.0.0.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Configuration for safebox to deploy parameters to various parameter stores

Properties

service string required

Name of the service. parameters will be prefixed by the value provided

provider string required

Deploy parameters to the given provider. Eg. ssm, secrets-manager

Values: "ssm" "secrets-manager"
region enum | string

Region to deploy the parameters to. Eg. us-east-1

prefix string

Prefix to apply to all parameters. Does not apply for shared

Default: "/<stage>/<service>/"
generate object[]

Generate different files based on the parameter name and values

cloudformation-stacks string[]

Cloudformation stack names. Any output values from the stacks can be interpolated. Eg. DB_NAME: "{{.myDbName}}" myDbName is the output of one of the cloudformation stacks

config object

Parameters to deploy as non secret. You can also specify stage specific key value pairs. Same key in the defaults will be ignored and stage specific value will be used.

2 nested properties
defaults object

parameter name and value. Output is ///

shared object

Params that are to be shared between multiple services. The parameter name won't be prefixed by service name. Output is //shared/

secret object

Parameters to deploy as secret. You cannot specify stage specific key value pairs. Value is the description. You will need to run safebox deploy in prompt mode to provide the actual value.

2 nested properties
defaults object

parameter name and value. Output is ///

shared object

Params that are to be shared between multiple services. The parameter name won't be prefixed by service name. Output is //shared/