Skip to main content

Config

Configuration used for carrying out actions for blueprints. This consists of environment configuration (context-wide), provider and transformer plugin specific configuration along with blueprint variables.

providers object
property name* object

Configuration for a provider plugin. This is used to configure a specific provider plugin when carrying out specific actions for a blueprint.

property name* ScalarValue

A scalar value type, can be a string, number or boolean.

oneOf
string

The string value.

Example: my-string-value
transformers object
property name* object

Configuration for a transformer plugin. This is used to configure a specific transformer plugin when carrying out specific actions for a blueprint.

property name* ScalarValue

A scalar value type, can be a string, number or boolean.

oneOf
string

The string value.

Example: my-string-value
contextVariables object

Context variables that provide information that can be used across components of the blueprint validation, change staging and deployment processes.

property name* ScalarValue

A scalar value type, can be a string, number or boolean.

oneOf
string

The string value.

Example: my-string-value
blueprintVariables object

Blueprint variables that are expected to match the variables defined in the source blueprint document an action is being carried out for. When evaluating a blueprint document, variables will be derived from the variables defined in this object.

property name* ScalarValue

A scalar value type, can be a string, number or boolean.

oneOf
string

The string value.

Example: my-string-value
Config
{
  "providers": {
    "aws": {
      "accessKeyId": "my-access-key-id",
      "secretAccessKey": "secret-access-key"
    }
  },
  "transformers": {
    "celerity": {
      "deployTarget": "aws-serverless"
    }
  },
  "contextVariables": {
    "myConfigKey": "my-config-value"
  },
  "blueprintVariables": {
    "region": "us-east-1"
  }
}