Skip to main content

DestroyBlueprintInstancePayload

changeSetIdstringrequired

The ID of the change set to use to destroy the blueprint instance. When destroy a blueprint instance, a change set is used instead of the destroy process re-computing the changes that need to be applied.

Example: a471bbb8-1267-4e65-873b-fa86bca71fcf
rollbackbooleanrequired

If true, destroying the blueprint instance will be treated as a rollback for the initial deployment of the blueprint instance. This will usually be set to true when rolling back a recent first time deployment that needs to be rolled back due to a failure in a parent blueprint instance.

Default value: false
Example: false
config object

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
DestroyBlueprintInstancePayload
{
  "changeSetId": "a471bbb8-1267-4e65-873b-fa86bca71fcf",
  "rollback": false,
  "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"
    }
  }
}