Skip to main content

CreateBlueprintInstancePayload

changeSetIdstringrequired

The ID of the change set to use to deploy the blueprint instance. When creating a new blueprint instance (deploying), a change set is used instead of the deployment process re-computing the changes that need to be applied.

The source blueprint document is still required in addition to a change set to finish of resolving substitutions that can only be resolved at deploy time and for deployment orchestration. The source blueprint document is not used to compute changes at the deployment stage.

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

The file source scheme to determine where the blueprint document is located.

This can be one of the following:

  • file: The blueprint document is located on the local file system of the Deploy Engine server.
  • s3: The blueprint document is located in an S3 bucket.
  • gcs: The blueprint document is located in a GCS bucket.
  • azureblob: The blueprint document is located in an Azure Blob Storage container.
  • https: The blueprint document is located via a public HTTPS URL.

For remote source authentication, the Deploy Engine server will need to be configured with the appropriate credentials to access the remote source. Authentication is not supported for https sources.

Possible values: [file, s3, gcs, azureblob, https]

Default value: file
Example: file
directorystringrequired

The directory where the blueprint document is located. For file sources, this must be an absolute path to the directory on the local file system of the Deploy Engine server. An example for a file source would be /path/to/blueprint-directory. For s3, gcs and azureblob sources, this must be the path to the virtual directory where the first path segment is the bucket/container name and the rest of the path is the path to the virtual directory. An example for a remote object storage source would be bucket-name/path/to/blueprint-directory. For https sources, this must be the path to the blueprint document, a host must be supplied in the blueprintLocationMetadata field. An example for a https source would be /path/to/blueprint-directory with a blueprintLocationMetadata.host field set to example.com.

Example: /path/to/blueprint-directory
blueprintFilestring

The name of the blueprint file to be used during deployment. The source file is needed in addition to a change set ID as it is required as a part of the deployment process for resolving substitutions that can only be resolved at deploy time and is required for deployment orchestration.

Default value: project.blueprint.yml
Example: project.blueprint.yml
blueprintLocationMetadata object

Additional metadata about the location of the blueprint document. For example, this can be used to specify the region of the bucket or container where the blueprint document is located in a cloud object storage service. This only supports scalar values.

property name* object

The value of the metadata property.

oneOf
string

The string value for a metadata property.

Example: us-east-1
rollbackbooleanrequired

If true, the creation of the blueprint instance will be treated as a rollback operation for a previously destroyed 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
CreateBlueprintInstancePayload
{
  "changeSetId": "a471bbb8-1267-4e65-873b-fa86bca71fcf",
  "fileSourceScheme": "file",
  "directory": "/path/to/blueprint-directory",
  "blueprintFile": "project.blueprint.yml",
  "blueprintLocationMetadata": {
    "region": "us-east-1"
  },
  "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"
    }
  }
}